{"openapi":"3.0.1","info":{"description":"Welcome to the Horizon Server API Reference documentation. This API reference provides comprehensive information about status of all Horizon Server components and resources. <br> \nChoose Latest spec from dropdown to view API reference on latest version available.","license":{"name":"Copyright © 2026 Omnissa LLC All rights reserved."},"title":"Horizon Server API","version":"2603"},"servers":[{"url":"/rest"}],"security":[{"Bearer":[]}],"tags":[{"description":"APIs for Authentication and Authorization","name":"Auth"},{"description":"APIs for configuration","name":"Config"},{"description":"APIs for entitlement of resources","name":"Entitlements"},{"description":"APIs for resources that are external to Horizon environment. These APIs make live calls to external systems","name":"External"},{"description":"APIs for federation resources. CPA must be initialized for the pod for invoking these APIs","name":"Federation"},{"description":"APIs for Help Desk services","name":"Help Desk"},{"description":"APIs for inventory resources","name":"Inventory"},{"description":"APIs for monitoring services","name":"Monitor"}],"paths":{"/config/v1/admin-users-or-groups/permissions":{"get":{"description":"Optional Privileges - \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege to view other admin users or groups permissions.|","operationId":"getAdminUsersOrGroupsPermissions","parameters":[{"description":"ID of the admin user or group","example":"S-1-5-21-1111111111-2222222222-3333333333-500","in":"query","name":"ad_user_or_group_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AdminUserOrGroupPermissionsInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets permission information for logged in or other admin user or group.","tags":["Config"]}},"/config/v1/admin-users-or-groups/preferences":{"get":{"operationId":"getPreferences","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AdminUserOrGroupPreferencesInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets Horizon Console preferences for the logged in administrator.","tags":["Config"]},"put":{"operationId":"updatePreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUserOrGroupPreferencesUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the Horizon Console preferences for the logged in administrator.","tags":["Config"]}},"/config/v1/app-volumes-manager":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listAppVolumesManagers","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppVolumesManagerInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the configured app volumes managers.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"addAppVolumesManager","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppVolumesManagerCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Add the app volumes manager","tags":["Config"]}},"/config/v1/app-volumes-manager/action/unassign-farms":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on any access group, to perform this operation. |","operationId":"unassignFarms","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of farm Ids to be unassigned with App Volumes manager","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Unassign Farms to App Volumes Manager","tags":["Config"]}},"/config/v1/app-volumes-manager/action/validate-certificate":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"validateAVMCertificate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CertificateData"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Validates App Volumes manager certificate.","tags":["Config"]}},"/config/v1/app-volumes-manager/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteAppVolumesManager","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"deletes the given app volumes manager","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getAppVolumesManager","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AppVolumesManagerInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about an app volumes manager.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateAppVolumesManager","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppVolumesManagerUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the given app volumes manager.","tags":["Config"]}},"/config/v1/app-volumes-manager/{id}/action/assign-farms":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on any access group, to perform this operation. |","operationId":"assignFarms","parameters":[{"description":"App volumes manager ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of farm Ids to be assigned with App Volumes manager","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Assign Farms to App Volumes Manager","tags":["Config"]}},"/config/v1/app-volumes-manager/{id}/action/override-certificate":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"overrideCertificate","parameters":[{"description":"App volumes manager ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppVolumeCertificateOverrideDataUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Override the given app volumes manager certificate.","tags":["Config"]}},"/config/v1/app-volumes-manager/{id}/action/push-certificates":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"pushCertificates","parameters":[{"description":"App volumes manager ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Push cluster certificates to App Volumes Manager","tags":["Config"]}},"/config/v1/ceip":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getCEIPInfo","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CEIPInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get the CEIP Information.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateCEIPInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CEIPUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Update the CEIP Information.","tags":["Config"]}},"/config/v1/compute-profiles":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listComputeProfiles","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ComputeProfileInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the configured compute profiles.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createComputeProfile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputeProfileCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Compute Profile.","tags":["Config"]}},"/config/v1/compute-profiles/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteComputeProfile","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Compute Profile.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getComputeProfile","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ComputeProfileInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a Compute Profile.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateComputeProfile","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputeProfileUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Compute Profile.","tags":["Config"]}},"/config/v1/connection-servers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"listConnectionServers","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionServerInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the connection servers.","tags":["Config"]}},"/config/v1/connection-servers/action/backup":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"backUp","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of connection server ids where immediate back up should be done.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Initiates immediate back up of Connection Servers","tags":["Config"]}},"/config/v1/connection-servers/action/certificates":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MANAGE_CERTIFICATES | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteCertificate","parameters":[{"description":"Indicates whether to permanently delete the certificate.\n If passed as \"true\", then certificates will be permanently deleted.\n If passed as \"false\", then certificates will be temporarily deleted and can be recovered.","in":"query","name":"delete_permanently","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Certificate Identification Spec.","items":{"$ref":"#/components/schemas/CertificateIdentificationSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes both Machine and Cluster SSL certificates of connection server.","tags":["Config"]}},"/config/v1/connection-servers/action/disable":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"disableConnectionServers","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of connection server ids to be disabled.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Disables the given list of connection server ids.","tags":["Config"]}},"/config/v1/connection-servers/action/enable":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"enableConnectionServers","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of connection server ids to be enabled.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Enables the given list of connection server ids.","tags":["Config"]}},"/config/v1/connection-servers/action/export-certificate":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MANAGE_CERTIFICATES | Caller should have permission to this privilege, to perform this operation. |","operationId":"exportCertificate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportCertificateSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExportedCertificate"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Exports the in-use certificate of connection server","tags":["Config"]}},"/config/v1/connection-servers/action/generate-csr":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MANAGE_CERTIFICATES | Caller should have permission to this privilege, to perform this operation. |","operationId":"generateCSR","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsrSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CsrGenerateResponseInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Generate Certificate Signing Request(CSR).","tags":["Config"]}},"/config/v1/connection-servers/action/import-certificate":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MANAGE_CERTIFICATES | Caller should have permission to this privilege, to perform this operation. |","operationId":"importCertificate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Imports both Machine and Cluster SSL certificate to connection server's certificate store.","tags":["Config"]}},"/config/v1/connection-servers/action/recover-certificates":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MANAGE_CERTIFICATES | Caller should have permission to this privilege, to perform this operation. |","operationId":"recoverCertificates","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Certificate Identification Spec.","items":{"$ref":"#/components/schemas/CertificateIdentificationSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Recover the deleted certificates.","tags":["Config"]}},"/config/v1/connection-servers/certificates":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listCertificateInfos","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CertificateInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the certificate details.","tags":["Config"]}},"/config/v1/connection-servers/security-configuration":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getSecurityConfigurationInfo","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SecurityConfigInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the security configuration of connection server and secure gateway","tags":["Config"]}},"/config/v1/connection-servers/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"getConnectionServer","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ConnectionServerInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a connection server.","tags":["Config"]},"put":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateConnectionServer","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionServerUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the settings of the given Connection Server.","tags":["Config"]}},"/config/v1/customization-specifications":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listCustomizationSpecifications","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationSpecificationInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Customization Specifications.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createCustomizationSpecification","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomizationSpecificationCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Customization Specification.","tags":["Config"]}},"/config/v1/customization-specifications/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteCustomizationSpecification","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Customization Specification.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getCustomizationSpecification","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CustomizationSpecificationInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a Customization Specification.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateCustomizationSpecification","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomizationSpecificationUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Customization Specification.","tags":["Config"]}},"/config/v1/environment-properties":{"get":{"operationId":"getEnvironment","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvironmentInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the environment settings.","tags":["Config"]}},"/config/v1/event-database":{"get":{"description":"Optional privileges -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view entire configuration details, else limited details would be returned.|","operationId":"getEventDatabase","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EventDatabaseInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns information about event database configuration.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateEventDatabaseV1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventDatabaseUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates event database configuration.","tags":["Config"]}},"/config/v1/event-database/action/clear":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"clearEventDatabase","responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes event database configuration.","tags":["Config"]}},"/config/v1/external-deployments":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listExternalDeployments","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalDeploymentInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the configured external deployments.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"addExternalDeployment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDeploymentCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Add the external deployment","tags":["Config"]}},"/config/v1/external-deployments/action/refresh-keys":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MANAGE_EXTERNAL_KEYS | Caller should have permission to this privilege, to perform this operation. |","operationId":"refreshExternalDeploymentKeys","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JWTAuthenticatorRefreshKeysSpec"}}},"required":true},"responses":{"204":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PublicKeyInfo"}}},"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Refreshes public keys for external deployment feature.","tags":["Config"]}},"/config/v1/external-deployments/action/validate-certificate":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"validateExternalDeploymentCertificate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CertificateData"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Validates External Deployment connection server certificate.","tags":["Config"]}},"/config/v1/external-deployments/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteExternalDeployment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given external deployment","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getExternalDeployment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExternalDeploymentInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about an external deployment.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateExternalDeployment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDeploymentUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the given external deployment.","tags":["Config"]}},"/config/v1/federation-access-groups":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FOLDER_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listFederationAccessGroups","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FederationAccessGroupInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all federation access groups.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FOLDER_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createFederationAccessGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FederationAccessGroupCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates federation access group.","tags":["Config"]}},"/config/v1/federation-access-groups/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FOLDER_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteFederationAccessGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a federation access group.","tags":["Config"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FOLDER_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getFederationAccessGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FederationAccessGroupInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a federation access group.","tags":["Config"]}},"/config/v1/gateway-access-users-or-groups":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteGatewayAccessUserOrGroup","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"ID's of the gateway access user or group","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a specified gateway access user or group in the environment.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listGatewayAccessUserOrGroup","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GatewayAccessUserOrGroupInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists gateway access users or group in the environment.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createGatewayAccessUserOrGroup","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Gateway Access User or Group Data","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a specified gateway access user or group in the environment.","tags":["Config"]}},"/config/v1/gateways":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listGateways","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GatewayInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the registered gateways.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"registerGateway","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Register gateway.","tags":["Config"]}},"/config/v1/gateways/certificates":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listGatewayCertificatesInfo","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GatewayCertificateInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the information of the gateway certificates.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"addGatewayCertificate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayCertificateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Add the gateway certificate.","tags":["Config"]}},"/config/v1/gateways/certificates/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteGatewayCertificate","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"},"Not Found":{"description":"Not Found"}},"security":[{"Bearer":[]}],"summary":"Deletes the gateway certificate.","tags":["Config"]}},"/config/v1/gateways/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"unregisterGateway","parameters":[{"description":"Id of gateway server to be unregistered","example":"fd69e42f-9812-4bf2-b000-84e92882616d","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Unregister gateway.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getGateway","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GatewayInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a registered gateway.","tags":["Config"]}},"/config/v1/global-policies":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getGlobalPolicies","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PoliciesSettings"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns the global policies in the environment.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateGlobalPolicies","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoliciesSettingsUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the global policies in the environment.","tags":["Config"]}},"/config/v1/gssapi-authenticators":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listGSSAPIAuthenticators","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GSSAPIAuthenticatorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the configured GSSAPI Authenticators.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createGSSAPIAuthenticator","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GSSAPIAuthenticatorCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a GSSAPI authenticator.","tags":["Config"]}},"/config/v1/gssapi-authenticators/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteGSSAPIAuthenticator","parameters":[{"description":"Indicates to delete GSSAPIAuthenticator forcibly If passed as \"true\", then GSSAPIAuthenticator is deleted forcibly, even if it is being used by any of the connection server If passed as  \"false\" then if GSSAPIAuthenticator is used by any of the connection server error message will be rendered","in":"query","name":"forced","required":false,"schema":{"type":"boolean","default":false}},{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a GSSAPI Authenticator.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getGSSAPIAuthenticator","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GSSAPIAuthenticatorInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a GSSAPI Authenticator.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateGSSAPIAuthenticator","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GSSAPIAuthenticatorUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a GSSAPI Authenticator.","tags":["Config"]}},"/config/v1/ic-domain-accounts":{"get":{"description":"This API supports <b>Pagination</b>.<br/>\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege on any access group, to perform this operation. |","operationId":"listICDomainAccounts","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InstantCloneDomainAccountInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists instant clone domain accounts of the environment.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createICDomainAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantCloneDomainAccountCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates instant clone domain account.","tags":["Config"]}},"/config/v1/ic-domain-accounts/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteICDomainAccount","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes instant clone domain account.","tags":["Config"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege on any access group, to perform this operation. |","operationId":"getICDomainAccount","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/InstantCloneDomainAccountInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets instant clone domain account.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateICDomainAccount","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantCloneDomainAccountUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates instant clone domain account.","tags":["Config"]}},"/config/v1/ic-domain-accounts/{id}/ad_sites":{"get":{"description":"| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getADSitesInfo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADSiteInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get all the available AD sites for the instant clone domain account.","tags":["Config"]}},"/config/v1/im-assets":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listIMAssets","parameters":[{"description":"Image management version ID","in":"query","name":"im_version_id","required":false,"schema":{"type":"string"}},{"description":"Image management tag ID.","in":"query","name":"im_tag_id","required":false,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImageManagementAssetInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists image management assets.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createIMAsset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageManagementAssetCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates image management asset.","tags":["Config"]}},"/config/v1/im-assets/action/bulk-create":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createIMAssets","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of Image management asset object to be created in bulk.","items":{"$ref":"#/components/schemas/ImageManagementAssetCreateSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates one or more image management assets. Each of the index of result in the response, correspond to the index of the original asset.","tags":["Config"]}},"/config/v1/im-assets/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteIMAsset","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes image management asset.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getIMAsset","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ImageManagementAssetInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets image management asset.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateIMAsset","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageManagementAssetUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates image management asset.","tags":["Config"]}},"/config/v1/im-streams":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listIMStreams","parameters":[{"description":"Virtual Center ID.","in":"query","name":"vcenter_id","required":false,"schema":{"type":"string"}},{"description":"Clone Type.","in":"query","name":"clone_type","required":false,"schema":{"type":"string","enum":["INSTANT_CLONE","FULL_CLONE"]}},{"description":"Image Type.","in":"query","name":"image_type","required":false,"schema":{"type":"string","enum":["RDSH_APPS","RDSH_DESKTOP","VDI_DESKTOP"]}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImageManagementStreamInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists image management streams.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createIMStream","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageManagementStreamCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates image management stream.","tags":["Config"]}},"/config/v1/im-streams/action/bulk-create":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createIMStreams","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of Image management stream object to be created in bulk.","items":{"$ref":"#/components/schemas/ImageManagementStreamCreateSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates one or more image management streams. Each of the index of result in the response, correspond to the index of the original stream.","tags":["Config"]}},"/config/v1/im-streams/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteIMStream","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes image management stream.","tags":["Config"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getIMStream","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ImageManagementStreamInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets image management stream.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateIMStream","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageManagementStreamUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates image management stream.","tags":["Config"]}},"/config/v1/im-tags":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listIMTags","parameters":[{"description":"Image management stream ID","in":"query","name":"im_stream_id","required":true,"schema":{"type":"string"}},{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":false,"schema":{"type":"string"}},{"description":"Clone Type.","in":"query","name":"clone_type","required":false,"schema":{"type":"string","enum":["INSTANT_CLONE","FULL_CLONE"]}},{"description":"Image Type.","in":"query","name":"image_type","required":false,"schema":{"type":"string","enum":["RDSH_APPS","RDSH_DESKTOP","VDI_DESKTOP"]}},{"description":"Fetches assets with status Available.","in":"query","name":"fetch_available_assets_only","required":false,"schema":{"type":"boolean","default":false}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImageManagementTagInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists image management tags.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createIMTag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageManagementTagCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates image management tag.","tags":["Config"]}},"/config/v1/im-tags/action/bulk-create":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createIMTags","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of Image management tag object to be created in bulk.","items":{"$ref":"#/components/schemas/ImageManagementTagCreateSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates one or more image management tags. Each of the index of result in the response, correspond to the index of the original tag.","tags":["Config"]}},"/config/v1/im-tags/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteIMTag","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes image management tag.","tags":["Config"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getIMTag","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ImageManagementTagInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets image management tag.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateIMTag","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageManagementTagUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates image management tag.","tags":["Config"]}},"/config/v1/im-versions":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listIMVersions","parameters":[{"description":"Image management stream ID","in":"query","name":"im_stream_id","required":true,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImageManagementVersionInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists image management versions.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createIMVersion","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageManagementVersionCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates image management version.","tags":["Config"]}},"/config/v1/im-versions/action/bulk-create":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createIMVersions","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of Image management version object to be created in bulk.","items":{"$ref":"#/components/schemas/ImageManagementVersionCreateSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates one or more image management versions. Each of the index of result in the response, correspond to the index of the original version.","tags":["Config"]}},"/config/v1/im-versions/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteIMVersion","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes image management version.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getIMVersion","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ImageManagementVersionInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets image management version.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateIMVersion","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageManagementVersionUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates image management version.","tags":["Config"]}},"/config/v1/jwt-authenticators":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"listJWTAuthenticators","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JWTAuthenticatorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the configured JWT authenticators.","tags":["Config"]},"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_ON_BOARDING_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createJWTAuthenticator","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JWTAuthenticatorCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a JWT authenticator.","tags":["Config"]}},"/config/v1/jwt-authenticators/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_ON_BOARDING_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteJWTAuthenticator","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given JWT authenticator.","tags":["Config"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"getJWTAuthenticator","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/JWTAuthenticatorInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about the given JWT authenticator.","tags":["Config"]},"put":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateJWTAuthenticator","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JWTAuthenticatorUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the given JWT authenticator.","tags":["Config"]}},"/config/v1/jwt-authenticators/{id}/action/associate-connection-servers":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_ON_BOARDING_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"associateJWTAuthenticatorWithConnectionServers","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Set of connection server IDs and State to associate.","items":{"$ref":"#/components/schemas/JWTAuthenticatorAssociationSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Associates JWT authenticator with multiple connection servers.","tags":["Config"]}},"/config/v1/jwt-authenticators/{id}/action/dissociate-connection-servers":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_ON_BOARDING_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"dissociateJWTAuthenticatorWithConnectionServers","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of connection server IDs to dissociate.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Dissociate JWT authenticator with multiple connection servers.","tags":["Config"]}},"/config/v1/licenses":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read all the fields of a license. Else, certain fields will be unset.","operationId":"listLicenses","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LicenseInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all licenses.","tags":["Config"]}},"/config/v1/licenses/action/reset-highest-usage-metrics":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"resetHighestUsageMetrics","responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"The highest historical number of concurrent connections will be reset to the current number.","tags":["Config"]}},"/config/v1/licenses/action/reset-named-user-metrics":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"resetNamedUserMetrics","responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"The highest historical number of named users will be reset to zero.","tags":["Config"]}},"/config/v1/licenses/action/set-mode":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"setLicenseMode","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseModeSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Set the License Mode","tags":["Config"]}},"/config/v1/licenses/action/validate":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"validateLicenseKey","requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"The specification to validate the license key."}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/LicenseValidateInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Validates the License Key","tags":["Config"]}},"/config/v1/local-access-groups":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | This privilege is required to read all local access groups.\n| FOLDER_VIEW | This privilege is required to read specific local access groups to which the caller has permission.","operationId":"listLocalAccessGroups","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LocalAccessGroupInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all local access groups.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FOLDER_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createLocalAccessGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalAccessGroupCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates local access group.","tags":["Config"]}},"/config/v1/local-access-groups/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FOLDER_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteLocalAccessGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a local access group.","tags":["Config"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | This privilege is required to read all local access groups.\n| FOLDER_VIEW | This privilege is required to read specific local access groups to which the caller has permission.","operationId":"getLocalAccessGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/LocalAccessGroupInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a local access group.","tags":["Config"]}},"/config/v1/log-collector/action/collect":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| LOG_COLLECTION | Caller should have permission to this privilege, to perform this operation. |","operationId":"collect","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Specification for collecting the logs","items":{"$ref":"#/components/schemas/LogCollectorCollectSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Sends the log collection request for the set of targets","tags":["Config"]}},"/config/v1/log-collector/log-levels":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| LOG_COLLECTION | Caller should have permission to this privilege, to perform this operation. |","operationId":"getLogLevels","parameters":[{"description":"The ID of the log collector component type for which logs are collected.","in":"query","name":"component_id","required":true,"schema":{"type":"string"}},{"description":"The type of the log collector component.","in":"query","name":"component_type","required":true,"schema":{"type":"string","enum":["CONNECTION_SERVER","AGENT","AGENT_RDS"]}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/LogCollectorLogLevelInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Fetches feature wise log level information for a component. ","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| LOG_COLLECTION | Caller should have permission to this privilege, to perform this operation. |","operationId":"setLogLevels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogCollectorLogLevelSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates feature specific log level for a component.","tags":["Config"]}},"/config/v1/log-collector/tasks":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| ADMINISTRATOR | This privilege is required to list all log collector task information.\n| LOG_COLLECTION | This privilege is required to list log collector task information of current logged in user.","operationId":"listLogCollectorTasks","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LogCollectorTaskInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists Log Collector task information","tags":["Config"]}},"/config/v1/log-collector/tasks/action/clean":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| LOG_COLLECTION | Caller should have permission to this privilege, to perform this operation. |","operationId":"clean","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of task Ids to be cleaned","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"A finish acknowledgement to notify the connection server for cleanup of collect complete log bundles or to terminate the collect operation if is in progress of collecting logs bundle. ","tags":["Config"]}},"/config/v1/log-collector/tasks/action/generate-download-urls":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| LOG_COLLECTION | Caller should have permission to this privilege, to perform this operation. |","operationId":"generateDownloadURLs","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Specification for fetching the download URL for log collector tasks","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LogCollectorDownloadURLInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves Download URL for each of specified log collector task.","tags":["Config"]}},"/config/v1/log-collector/tasks/action/purge":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| ADMINISTRATOR | Caller should have permission to this privilege, to perform this operation. |\n| LOG_COLLECTION | Caller should have permission to this privilege, to perform this operation. |","operationId":"purge","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of task Ids to be purged","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Purges the log collection bundle for the provided list of targets. ","tags":["Config"]}},"/config/v1/message-clients":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listMessageClients","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MessageClientInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the message clients in the environment.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CVP_REGISTER | Caller should have permission to this privilege, to perform this operation. |","operationId":"createMessageClient","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageClientCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Message Client.","tags":["Config"]}},"/config/v1/message-clients/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CVP_REGISTER | Caller should have permission to this privilege, to perform this operation. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteMessageClient","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a message client.","tags":["Config"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CVP_REGISTER | Caller should have permission to this privilege, to perform this operation. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getMessageClient","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MessageClientInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a message client.","tags":["Config"]},"put":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CVP_REGISTER | Caller should have permission to this privilege, to perform this operation. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateMessageClient","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageClientUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates message client.","tags":["Config"]}},"/config/v1/permissions":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deletePermissions","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of Permission ids to be deleted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes permissions in bulk.","tags":["Config"]},"get":{"description":"Note: If this API is invoked for specific permission ids then the maximum ids supported per call is 100.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listPermissions","parameters":[{"description":"Permission IDs","in":"query","name":"ids","required":false,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PermissionInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all permissions.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createPermissions","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of Permission objects to be created.","items":{"$ref":"#/components/schemas/PermissionCreateSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates permissions in bulk.","tags":["Config"]}},"/config/v1/permissions/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getPermission","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PermissionInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a permission.","tags":["Config"]}},"/config/v1/pre-logon-settings":{"get":{"operationId":"getPreLogonSettings","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PreLogonSettingsInfo"}}},"description":"OK"},"429":{"description":"Too many requests"}},"summary":"Gets the pre logon settings.","tags":["Config"]}},"/config/v1/privileges":{"get":{"description":"Note: This will also list the sub-privileges that are part of the privilege wherever applicable. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_ROLE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listSelectablePrivileges","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrivilegeInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all selectable privileges.","tags":["Config"]}},"/config/v1/radius-authenticators":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listRADIUSAuthenticators","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RADIUSAuthenticatorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the configured RADIUS Authenticators.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createRADIUSAuthenticator","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RADIUSAuthenticatorCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a RADIUS Authenticator.","tags":["Config"]}},"/config/v1/radius-authenticators/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteRADIUSAuthenticator","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given RADIUS Authenticator.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getRADIUSAuthenticator","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RADIUSAuthenticatorInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a RADIUS Authenticator.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateRADIUSAuthenticator","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RADIUSAuthenticatorUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the given RADIUS Authenticator.","tags":["Config"]}},"/config/v1/rcx/clients":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"registerRCXClient","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RCXClientRegisterSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Registers the RCX client","tags":["Config"]}},"/config/v1/rcx/clients/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"unregisterRCXClient","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Unregisters the given RCX Client","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateRCXClient","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RCXClientUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the given RCX client.","tags":["Config"]}},"/config/v1/rcx/servers":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listRCXServers","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RCXServerInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists RCX servers of the cluster.","tags":["Config"]}},"/config/v1/roles":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_ROLE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege, to read the permission IDs for Role. | ","operationId":"listRoles","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RoleInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all roles.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_ROLE_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a role.","tags":["Config"]}},"/config/v1/roles/{id}":{"delete":{"description":"Note: All the associated permissions will also be deleted. Only custom roles can be deleted.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_ROLE_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege, to read the permission IDs for Role. | ","operationId":"deleteRole","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a role.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_ROLE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege, to read the permission IDs for Role. | ","operationId":"getRole","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RoleInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a role.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_ROLE_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateRole","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a role.","tags":["Config"]}},"/config/v1/saml-authenticators":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listSAMLAuthenticators","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SAMLAuthenticatorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the configured SAML authenticators.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createSAMLAuthenticator","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a SAML authenticator.","tags":["Config"]}},"/config/v1/saml-authenticators/action/validate-certificate":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"validateSAMLCertificate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorServerSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CertificateData"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Validates SAML Authenticator certificate.","tags":["Config"]}},"/config/v1/saml-authenticators/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteSAMLAuthenticator","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a SAML Authenticator.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getSAMLAuthenticator","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a SAML authenticator.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateSAMLAuthenticator","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a SAML Authenticator.","tags":["Config"]}},"/config/v1/saml-authenticators/{id}/action/associate-connection-servers":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"associateSAMLAuthenticatorWithConnectionServers","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Association specification with connection server IDs and SAML support state.","items":{"$ref":"#/components/schemas/SAMLAuthenticatorAssociationSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Associates SAML authenticator with multiple connection servers with specified state.","tags":["Config"]}},"/config/v1/saml-authenticators/{id}/action/dissociate-connection-servers":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"dissociateSAMLAuthenticatorWithConnectionServers","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of connection server IDs to dissociate.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Dissociate SAML authenticator with multiple connection servers.","tags":["Config"]}},"/config/v1/secondary-credentials":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | This privilege is required to read all secondary credentials.","operationId":"listSecondaryCredentials","parameters":[{"description":"The user sid of the owner of the secondary credential.","in":"query","name":"owner_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SecondaryCredentialInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"List the configured Secondary Credentials for given user.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createSecondaryCredential","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecondaryCredentialCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates secondary credential.","tags":["Config"]}},"/config/v1/secondary-credentials/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteSecondaryCredential","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a secondary credential.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | This privilege is required to read all secondary credentials.","operationId":"getSecondaryCredentials","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SecondaryCredentialInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get the configured secondary credentials for given id.","tags":["Config"]}},"/config/v1/secondary-credentials/{id}/action/update-password":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updatepassword","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecondaryCredentialUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Update password.","tags":["Config"]}},"/config/v1/settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSettings","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SettingsInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the configuration settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the configuration settings.","tags":["Config"]}},"/config/v1/settings/agent-restriction-settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getAgentRestrictionSettings","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentRestrictionSettingsInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the agent restriction settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateAgentRestrictionSettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRestrictionSettingsUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the agent restriction settings.","tags":["Config"]}},"/config/v1/settings/client-settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getClientSettings","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ClientSettingsInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the client settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateClientSettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSettingsUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the client settings.","tags":["Config"]}},"/config/v1/settings/feature":{"get":{"operationId":"getFeatureSettings","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FeatureSettings"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the feature settings.","tags":["Config"]},"put":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.\n| CLOUD_ON_BOARDING_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateFeatureSettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the feature settings.","tags":["Config"]}},"/config/v1/settings/general":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getGeneralSettings","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GeneralSettings"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the general settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateGeneralSettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the general settings.","tags":["Config"]}},"/config/v1/settings/security":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSecuritySettings","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SecuritySettings"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the security settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSecuritySettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the security settings.","tags":["Config"]}},"/config/v1/syslog":{"get":{"description":"Optional privileges -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getSyslog","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SyslogInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets Syslog information","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateSyslog","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyslogUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates Syslog configuration.","tags":["Config"]}},"/config/v1/true-sso":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listTrueSSOConnectors","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TrueSSOConnectorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the TrueSSO Connectors.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createTrueSSOConnector","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrueSSOConnectorCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a TrueSSO Connector.","tags":["Config"]}},"/config/v1/true-sso-enrollment-servers":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listEnrollmentServers","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TrueSSOEnrollmentServerInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the paired TrueSSO Enrollment Servers.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"addEnrollmentServer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrueSSOEnrollmentServerCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Add a TrueSSO Enrollment Server.","tags":["Config"]}},"/config/v1/true-sso-enrollment-servers/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"removeEnrollmentServer","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Removes a paired TrueSSO Enrollment Server.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getEnrollmentServer","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/TrueSSOEnrollmentServerInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a paired TrueSSO Enrollment Server.","tags":["Config"]}},"/config/v1/true-sso/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteTrueSSOConnector","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a TrueSSO Connector.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getTrueSSOConnector","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/TrueSSOConnectorInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"404"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a requested TrueSSO Connector.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateTrueSSOConnector","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrueSSOConnectorUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a TrueSSO Connector.","tags":["Config"]}},"/config/v1/uem-servers":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listUEMServers","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UEMServerInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the configured UEM servers.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"addUEMServer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UEMServerCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Add the UEM Server","tags":["Config"]}},"/config/v1/uem-servers/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteUEMServer","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"deletes the given UEM Server.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getUEMServer","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UEMServerInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about UEM Server.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateUEMServer","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UEMServerUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the given UEM Server.","tags":["Config"]}},"/config/v1/unauthenticated-access-users":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read local unauthenticated access user(s). |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on any federated access group, to read global unauthenticated access user(s). |","operationId":"listUnauthenticatedAccessUsers","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnauthenticatedAccessUserInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists unauthenticated access users in the environment.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to manage unauthenticated access user(s). |\n| FEDERATED_LDAP_MANAGE | If CPA is enabled, caller should have permission to this privilege to manage unauthenticated access user(s). |","operationId":"createUnauthenticatedAccessUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedAccessUserCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a specified unauthenticated access user in the environment.","tags":["Config"]}},"/config/v1/unauthenticated-access-users/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to manage unauthenticated access user(s). |\n| FEDERATED_LDAP_MANAGE | If CPA is enabled, caller should have permission to this privilege to manage unauthenticated access user(s). |","operationId":"deleteUnauthenticatedAccessUser","parameters":[{"description":"ID of the unauthenticated access user","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a specified unauthenticated access user in the environment.","tags":["Config"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read local unauthenticated access user(s). |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on any federated access group, to read global unauthenticated access user(s). |","operationId":"getUnauthenticatedAccessUser","parameters":[{"description":"ID of the unauthenticated access user","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UnauthenticatedAccessUserInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a specified unauthenticated access user in the environment.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to manage unauthenticated access user(s). |\n| FEDERATED_LDAP_MANAGE | If CPA is enabled, caller should have permission to this privilege to manage unauthenticated access user(s). |","operationId":"updateUnauthenticatedAccessUser","parameters":[{"description":"ID of the unauthenticated access user","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedAccessUserUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a specified unauthenticated access user in the environment.","tags":["Config"]}},"/config/v1/url-redirection":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listURLSettingInfo","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/URLRedirectionInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the URL Setting Information.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createURLSetting","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/URLRedirectionCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a URL Redirection setting","tags":["Config"]}},"/config/v1/url-redirection/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteURLSetting","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Delete the URL Setting Information.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getURLSettingInfo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/URLRedirectionInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get the URL Setting Information.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateURLSetting","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/URLRedirectionUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"updates the URL Setting Information.","tags":["Config"]}},"/config/v1/users-or-groups-global-summary":{"get":{"description":"Note: CPA needs to be initialized for the pod for invoking this API.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listUsersOrGroupsGlobalSummary","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupGlobalSummaryInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists global summary info of users or groups.","tags":["Config"]}},"/config/v1/users-or-groups-global-summary/{id}":{"get":{"description":"Note: CPA needs to be initialized for the pod for invoking this API.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getUsersOrGroupsGlobalSummary","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserOrGroupGlobalSummaryInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets global summary info related to AD User or Group.","tags":["Config"]}},"/config/v1/users-or-groups-local-summary":{"get":{"description":"Optional Privileges - \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| POOL_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|","operationId":"listUsersOrGroupsLocalSummary","parameters":[{"description":"Whether or not the list should contain info only for user or group with atleast one entitlement.","example":true,"in":"query","name":"entitled_only","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupLocalSummaryInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists local summary info of users or groups.","tags":["Config"]}},"/config/v1/virtual-center/action/get-storage-details":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getStorageDetails","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageDetailsSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/StorageDetailsInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets Storage Details Information.","tags":["Config"]}},"/config/v1/virtual-centers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVCInfo","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCenterInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists Virtual Centers configured in the environment.","tags":["Config"]}},"/config/v1/virtual-centers/action/validate-certificate":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"validateVirtualCenterCertificate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CertificateData"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Validates Virtual Center certificate.","tags":["Config"]}},"/config/v1/virtual-centers/{id}/action/mark-datastores-for-archival":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FORENSICS | Caller should have permission to this privilege, to perform this operation. |","operationId":"markDatastoresForArchival","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Host or Cluster ID","in":"query","name":"host_or_cluster_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of datastore ids where archived vms will be saved","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Sets archival datastore paths for the vCenter.","tags":["Config"]}},"/config/v10/settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSettingsV10","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SettingsInfoV10"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the configuration settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSettingsV10","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdateSpecV10"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the configuration settings.","tags":["Config"]}},"/config/v11/settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSettingsV11","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SettingsInfoV11"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the configuration settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSettingsV11","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdateSpecV11"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the configuration settings.","tags":["Config"]}},"/config/v2/admin-users-or-groups/preferences":{"get":{"operationId":"getPreferencesV2","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AdminUserOrGroupPreferencesInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets Horizon Console preferences for the logged in administrator.","tags":["Config"]},"put":{"operationId":"updatePreferencesV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUserOrGroupPreferencesUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the Horizon Console preferences for the logged in administrator.","tags":["Config"]}},"/config/v2/app-volumes-manager":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listAppVolumesManagersV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppVolumesManagerInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the configured app volumes managers.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"addAppVolumesManagerV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppVolumesManagerCreateSpecV2"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Add the app volumes manager.","tags":["Config"]}},"/config/v2/app-volumes-manager/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteAppVolumesManagerV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given app volumes manager.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getAppVolumesManagerV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AppVolumesManagerInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about an app volumes manager.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateAppVolumesManagerV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppVolumesManagerUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the given app volumes manager.","tags":["Config"]}},"/config/v2/connection-servers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"listConnectionServersV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionServerInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the connection servers.","tags":["Config"]}},"/config/v2/connection-servers/certificates":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listCertificateInfosV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CertificateInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the certificate details.","tags":["Config"]}},"/config/v2/connection-servers/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"getConnectionServerV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ConnectionServerInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a connection server.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateConnectionServerV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionServerUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the settings of the given Connection Server.","tags":["Config"]}},"/config/v2/environment-properties":{"get":{"operationId":"getEnvironmentV2","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvironmentInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the environment settings.","tags":["Config"]}},"/config/v2/event-database":{"get":{"description":"Optional privileges -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view entire configuration details, else limited details would be returned.|","operationId":"getEventDatabaseV2","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EventDatabaseInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns information about event database configuration.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateEventDatabaseV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventDatabaseUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates event database configuration.","tags":["Config"]}},"/config/v2/event-database/action/clear":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"clearEventDatabaseV2","responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes event database configuration.","tags":["Config"]}},"/config/v2/event-database/action/validate-service-account":{"post":{"description":"Validates service account credentials for both gMSA and non-gMSA accounts. This allows the admin to check credentials before applying them, reducing the risk of lockout.\n\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"validateServiceAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceAccountValidateSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceAccountValidationInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Validates service account credentials.","tags":["Config"]}},"/config/v2/federation-access-groups":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | This privilege is required to read all federation access groups. permission_ids would be unset if this privilege is absent.\n| FOLDER_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listFederationAccessGroupsV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FederationAccessGroupInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all federation access groups.","tags":["Config"]}},"/config/v2/federation-access-groups/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | This privilege is required to read all federation access groups. permission_ids would be unset if this privilege is absent.\n| FOLDER_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getFederationAccessGroupV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FederationAccessGroupInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a federation access group.","tags":["Config"]}},"/config/v2/ic-domain-accounts":{"get":{"description":"This API supports <b>Pagination</b>.<br/>\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege on any access group, to perform this operation. |","operationId":"listICDomainAccountsV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InstantCloneDomainAccountInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists instant clone domain accounts of the environment.","tags":["Config"]}},"/config/v2/ic-domain-accounts/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege on any access group, to perform this operation. |","operationId":"getICDomainAccountV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/InstantCloneDomainAccountInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets instant clone domain account.","tags":["Config"]}},"/config/v2/jwt-authenticators":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"listJWTAuthenticatorsV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JWTAuthenticatorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the configured JWT authenticators.","tags":["Config"]},"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_ON_BOARDING_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createJWTAuthenticatorV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JWTAuthenticatorCreateSpecV2"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a JWT authenticator.","tags":["Config"]}},"/config/v2/jwt-authenticators/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_ON_BOARDING_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteJWTAuthenticatorV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given JWT authenticator.","tags":["Config"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"getJWTAuthenticatorV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/JWTAuthenticatorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about the given JWT authenticator.","tags":["Config"]},"put":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateJWTAuthenticatorV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JWTAuthenticatorUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the given JWT authenticator.","tags":["Config"]}},"/config/v2/licenses":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read all the fields of a license. Else, certain fields will be unset.","operationId":"listLicensesV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LicenseInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all licenses.","tags":["Config"]},"post":{"deprecated":true,"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"setLicenseKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseKeySpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Set the License Key","tags":["Config"]}},"/config/v2/local-access-groups":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | This privilege is required to read all local access groups. permission_ids would be unset if this privilege is absent\n| FOLDER_VIEW | This privilege is required to read specific local access groups to which the caller has permission.","operationId":"listLocalAccessGroupsV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LocalAccessGroupInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all local access groups.","tags":["Config"]}},"/config/v2/local-access-groups/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | This privilege is required to read all local access groups. permission_ids would be unset if this privilege is absent\n| FOLDER_VIEW | This privilege is required to read specific local access groups to which the caller has permission.","operationId":"getLocalAccessGroupV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/LocalAccessGroupInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/LocalAccessGroupInfoV2"}}},"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a local access group.","tags":["Config"]}},"/config/v2/permissions":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deletePermissionsV2","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of Permission ids to be deleted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes permissions in bulk.","tags":["Config"]},"get":{"description":"Note: If this API is invoked for specific permission ids then the maximum ids supported per call is 100.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listPermissionsV2","parameters":[{"description":"Permission IDs","in":"query","name":"ids","required":false,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PermissionInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all permissions.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createPermissionsV2","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of Permission objects to be created.","items":{"$ref":"#/components/schemas/PermissionCreateSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates permissions in bulk.","tags":["Config"]}},"/config/v2/permissions/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getPermissionV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PermissionInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a permission.","tags":["Config"]}},"/config/v2/saml-authenticators":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listSAMLAuthenticatorsV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SAMLAuthenticatorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the configured SAML authenticators.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createSAMLAuthenticatorV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorCreateSpecV2"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a SAML authenticator.","tags":["Config"]}},"/config/v2/saml-authenticators/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteSAMLAuthenticatorV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a SAML Authenticator.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getSAMLAuthenticatorV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a SAML authenticator.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateSAMLAuthenticatorV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a SAML Authenticator.","tags":["Config"]}},"/config/v2/settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSettingsV2","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SettingsInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the configuration settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSettingsV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the configuration settings.","tags":["Config"]}},"/config/v2/settings/client-settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getClientSettingsV2","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ClientSettingsInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the client settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateClientSettingsV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSettingsUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the client settings.","tags":["Config"]}},"/config/v2/settings/feature":{"get":{"operationId":"getFeatureSettingsV2","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FeatureSettingsV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the feature settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateFeatureSettingsV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the feature settings.","tags":["Config"]}},"/config/v2/settings/general":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getGeneralSettingsV2","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GeneralSettingsV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the general settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateGeneralSettingsV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the general settings.","tags":["Config"]}},"/config/v2/settings/security":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSecuritySettingsV2","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SecuritySettingsV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the security settings.","tags":["Config"]}},"/config/v2/users-or-groups-local-summary":{"get":{"description":"Optional Privileges - \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| POOL_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| UDD_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|","operationId":"listUsersOrGroupsLocalSummaryV2","parameters":[{"description":"Whether or not the list should contain info only for user or group with atleast one entitlement.","example":true,"in":"query","name":"entitled_only","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupLocalSummaryInfoV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists local summary info of users or groups.","tags":["Config"]}},"/config/v2/users-or-groups-local-summary/{id}":{"get":{"description":"Optional Privileges - \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| POOL_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| UDD_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|","operationId":"getUsersOrGroupLocalSummaryV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserOrGroupLocalSummaryInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets local summary info related to AD User or Group.","tags":["Config"]}},"/config/v2/virtual-centers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVCInfoV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCenterInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists Virtual Centers configured in the environment.","tags":["Config"]}},"/config/v3/connection-servers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"listConnectionServersV3","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionServerInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the connection servers.","tags":["Config"]}},"/config/v3/connection-servers/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CLOUD_OPS_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"getConnectionServerV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ConnectionServerInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a connection server.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateConnectionServerV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionServerUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the settings of the given Connection Server.","tags":["Config"]}},"/config/v3/environment-properties":{"get":{"operationId":"getEnvironmentV3","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvironmentInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the environment settings.","tags":["Config"]}},"/config/v3/licenses":{"get":{"deprecated":true,"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read all the fields of a license. Else, certain fields will be unset.","operationId":"listLicensesV3","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LicenseInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all licenses.","tags":["Config"]},"post":{"deprecated":true,"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"setLicenseKeyV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseKeySpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Set the License Key","tags":["Config"]}},"/config/v3/permissions":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deletePermissionsV3","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of Permission ids to be deleted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes permissions in bulk.","tags":["Config"]},"get":{"description":"Note: If this API is invoked for specific permission ids then the maximum ids supported per call is 100.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listPermissionsV3","parameters":[{"description":"Permission IDs","in":"query","name":"ids","required":false,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PermissionInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all permissions.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createPermissionsV3","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of Permission objects to be created.","items":{"$ref":"#/components/schemas/PermissionCreateSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates permissions in bulk.","tags":["Config"]}},"/config/v3/permissions/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getPermissionV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PermissionInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a permission.","tags":["Config"]}},"/config/v3/saml-authenticators":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listSAMLAuthenticatorsV3","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SAMLAuthenticatorInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the configured SAML authenticators.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createSAMLAuthenticatorV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorCreateSpecV3"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a SAML authenticator.","tags":["Config"]}},"/config/v3/saml-authenticators/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteSAMLAuthenticatorV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a SAML Authenticator.","tags":["Config"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getSAMLAuthenticatorV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a SAML authenticator.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateSAMLAuthenticatorV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a SAML Authenticator.","tags":["Config"]}},"/config/v3/settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSettingsV3","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SettingsInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the configuration settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSettingsV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the configuration settings.","tags":["Config"]}},"/config/v3/settings/feature":{"get":{"operationId":"getFeatureSettingsV3","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FeatureSettingsV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the feature settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateFeatureSettingsV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the feature settings.","tags":["Config"]}},"/config/v3/settings/general":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getGeneralSettingsV3","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GeneralSettingsV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the general settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateGeneralSettingsV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the general settings.","tags":["Config"]}},"/config/v3/settings/security":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSecuritySettingsV3","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SecuritySettingsV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the security settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSecuritySettingsV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the security settings.","tags":["Config"]}},"/config/v3/users-or-groups-local-summary":{"get":{"description":"Optional Privileges - \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| POOL_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| UDD_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|","operationId":"listUsersOrGroupsLocalSummaryV3","parameters":[{"description":"Whether or not the list should contain info only for user or group with atleast one entitlement.","example":true,"in":"query","name":"entitled_only","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupLocalSummaryInfoV3"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists local summary info of users or groups.","tags":["Config"]}},"/config/v3/users-or-groups-local-summary/{id}":{"get":{"description":"Optional Privileges - \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| POOL_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| UDD_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|","operationId":"getUsersOrGroupLocalSummaryV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserOrGroupLocalSummaryInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets local summary info related to AD User or Group.","tags":["Config"]}},"/config/v3/virtual-centers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVCInfoV3","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCenterInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists Virtual Centers configured in the environment.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createVirtualCenter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCenterCreateSpecV3"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a virtual center","tags":["Config"]}},"/config/v3/virtual-centers/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"removeVirtualCenter","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Removes a Virtual Center from the server","tags":["Config"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getVirtualCenter","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/VirtualCenterInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets Virtual Center Information.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateVirtualCenter","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCenterUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates virtual center.","tags":["Config"]}},"/config/v4/licenses":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read all the fields of a license. Else, certain fields will be unset.","operationId":"listLicensesV4","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LicenseInfoV4"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all licenses.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"setLicenseKeyV4","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseKeySpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Set the License Key","tags":["Config"]}},"/config/v4/settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSettingsV4","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SettingsInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the configuration settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSettingsV4","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the configuration settings.","tags":["Config"]}},"/config/v4/settings/feature":{"get":{"operationId":"getFeatureSettingsV4","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FeatureSettingsV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the feature settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateFeatureSettingsV4","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the feature settings.","tags":["Config"]}},"/config/v4/settings/general":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getGeneralSettingsV4","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GeneralSettingsV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the general settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateGeneralSettingsV4","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the general settings.","tags":["Config"]}},"/config/v4/settings/security":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSecuritySettingsV4","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SecuritySettingsV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the security settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSecuritySettingsV4","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the security settings.","tags":["Config"]}},"/config/v4/users-or-groups-local-summary":{"get":{"description":"Optional Privileges - \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| POOL_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| UDD_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|","operationId":"listUsersOrGroupsLocalSummaryV4","parameters":[{"description":"Whether or not the list should contain info only for user or group with atleast one entitlement.","example":true,"in":"query","name":"entitled_only","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupLocalSummaryInfoV4"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists local summary info of users or groups.","tags":["Config"]}},"/config/v4/users-or-groups-local-summary/{id}":{"get":{"description":"Optional Privileges - \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| POOL_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| UDD_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|","operationId":"getUsersOrGroupLocalSummaryV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserOrGroupLocalSummaryInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets local summary info related to AD User or Group.","tags":["Config"]}},"/config/v4/virtual-centers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVCInfoV4","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCenterInfoV4"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists Virtual Centers configured in the environment.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createVirtualCenterV4","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCenterCreateSpecV4"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a virtual center","tags":["Config"]}},"/config/v4/virtual-centers/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getVirtualCenterV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/VirtualCenterInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets Virtual Center Information.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateVirtualCenterV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCenterUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates virtual center.","tags":["Config"]}},"/config/v5/settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSettingsV5","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SettingsInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the configuration settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSettingsV5","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdateSpecV5"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the configuration settings.","tags":["Config"]}},"/config/v5/settings/feature":{"get":{"operationId":"getFeatureSettingsV5","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FeatureSettingsV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the feature settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateFeatureSettingsV5","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpecV5"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the feature settings.","tags":["Config"]}},"/config/v5/settings/general":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getGeneralSettingsV5","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GeneralSettingsV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the general settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateGeneralSettingsV5","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV5"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the general settings.","tags":["Config"]}},"/config/v5/settings/security":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSecuritySettingsV5","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SecuritySettingsV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the security settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSecuritySettingsV5","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the security settings.","tags":["Config"]}},"/config/v5/users-or-groups-local-summary":{"get":{"description":"Optional Privileges - \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| POOL_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| UDD_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|","operationId":"listUsersOrGroupsLocalSummaryV5","parameters":[{"description":"Whether or not the list should contain info only for user or group with atleast one entitlement.","example":true,"in":"query","name":"entitled_only","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserOrGroupLocalSummaryInfoV5"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists local summary info of users or groups.","tags":["Config"]}},"/config/v5/users-or-groups-local-summary/{id}":{"get":{"description":"Optional Privileges - \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| POOL_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| UDD_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view entire details, else limited details would be returned.|","operationId":"getUsersOrGroupLocalSummaryV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserOrGroupLocalSummaryInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets local summary info related to AD User or Group.","tags":["Config"]}},"/config/v5/virtual-centers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVCInfoV5","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCenterInfoV5"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists Virtual Centers configured in the environment.","tags":["Config"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createVirtualCenterV5","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCenterCreateSpecV4"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a virtual center","tags":["Config"]}},"/config/v5/virtual-centers/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"removeVirtualCenterV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Removes a Virtual Center from the server","tags":["Config"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getVirtualCenterV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/VirtualCenterInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets Virtual Center Information.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateVirtualCenterV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCenterUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates virtual center.","tags":["Config"]}},"/config/v6/settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSettingsV6","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SettingsInfoV6"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the configuration settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSettingsV6","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdateSpecV6"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the configuration settings.","tags":["Config"]}},"/config/v6/settings/general":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getGeneralSettingsV6","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GeneralSettingsV6"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the general settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateGeneralSettingsV6","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV6"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the general settings.","tags":["Config"]}},"/config/v6/settings/security":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSecuritySettingsV6","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SecuritySettingsV6"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the security settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSecuritySettingsV6","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpecV5"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the security settings.","tags":["Config"]}},"/config/v6/virtual-centers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVCInfoV6","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCenterInfoV6"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists Virtual Centers configured in the environment.","tags":["Config"]}},"/config/v7/settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSettingsV7","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SettingsInfoV7"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the configuration settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSettingsV7","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdateSpecV7"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the configuration settings.","tags":["Config"]}},"/config/v7/settings/general":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getGeneralSettingsV7","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GeneralSettingsV7"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the general settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateGeneralSettingsV7","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV7"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the general settings.","tags":["Config"]}},"/config/v8/settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSettingsV8","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SettingsInfoV8"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the configuration settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSettingsV8","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdateSpecV8"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the configuration settings.","tags":["Config"]}},"/config/v9/settings":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings.","operationId":"getSettingsV9","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SettingsInfoV9"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the configuration settings.","tags":["Config"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to update settings.","operationId":"updateSettingsV9","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsUpdateSpecV9"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the configuration settings.","tags":["Config"]}},"/entitlements/v1/application-pools":{"delete":{"description":"The input spec must not contain duplicate Ids.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_ENTITLE | Caller should have permission to this privilege, on the associated access group of application pool.","operationId":"bulkDeleteApplicationPoolEntitlements","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Specifications for bulk application entitlements to be deleted.","items":{"$ref":"#/components/schemas/EntitlementSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkEntitlementResponseInfo"}}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Delete the bulk entitlements for a set of application pools","tags":["Entitlements"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those application entitlements, for which the caller has permission to this privilege, on the associated access group of application pool.","operationId":"listApplicationPoolEntitlements","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the entitlements for Application Pools in the environment.","tags":["Entitlements"]},"post":{"description":"The input spec must not contain duplicate Ids.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_ENTITLE | Caller should have permission to this privilege, on the associated access group of application pool.","operationId":"bulkCreateApplicationPoolEntitlements","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Specifications for bulk application entitlements to be created.","items":{"$ref":"#/components/schemas/EntitlementSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkEntitlementResponseInfo"}}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Create the bulk entitlements for a set of application pools","tags":["Entitlements"]}},"/entitlements/v1/application-pools/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of application pool.","operationId":"getApplicationPoolEntitlements","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntitlementInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns the IDs of users or groups entitled to a given application pool.","tags":["Entitlements"]}},"/entitlements/v1/cloud-entitlements":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteCloudEntitlements","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of AD user or group SIDs which needs to be deleted from cloud entitlements.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes cloud entitlements.","tags":["Entitlements"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listCloudEntitlements","responses":{"200":{"content":{"*/*":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists cloud entitlements.","tags":["Entitlements"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"addCloudEntitlements","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of AD user or group SIDs which needs to be added to cloud entitlements.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Adds cloud entitlements.","tags":["Entitlements"]}},"/entitlements/v1/desktop-pools":{"delete":{"description":"The input spec must not contain duplicate Ids.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_ENTITLE | Caller should have permission to this privilege, on the associated access group of desktop pool.","operationId":"bulkDeleteDesktopPoolEntitlements","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Specifications for bulk desktop entitlements to be deleted.","items":{"$ref":"#/components/schemas/EntitlementSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkEntitlementResponseInfo"}}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Delete the bulk entitlements for a set of desktop pools","tags":["Entitlements"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop entitlements, for which the caller has permission to this privilege, on the associated access group of desktop pool.","operationId":"listDesktopPoolEntitlements","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the entitlements for Desktop Pools in the environment.","tags":["Entitlements"]},"post":{"description":"The input spec must not contain duplicate Ids.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_ENTITLE | Caller should have permission to this privilege, on the associated access group of desktop pool.","operationId":"bulkCreateDesktopPoolEntitlements","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Specifications for bulk desktop entitlements to be created.","items":{"$ref":"#/components/schemas/EntitlementSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkEntitlementResponseInfo"}}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Create the bulk entitlements for a set of desktop pools","tags":["Entitlements"]},"put":{"description":"The input spec must not contain duplicate Ids.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_ENTITLE | Caller should have permission to this privilege, on the associated access group of desktop pool.","operationId":"bulkUpdateDesktopPoolEntitlements","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Specifications for bulk desktop entitlements to be updated.","items":{"$ref":"#/components/schemas/EntitlementSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkEntitlementResponseInfo"}}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the bulk entitlements for a set of desktop pools","tags":["Entitlements"]}},"/entitlements/v1/desktop-pools/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of desktop pool.","operationId":"getDesktopPoolEntitlements","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntitlementInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns the IDs of users or groups entitled to a given desktop pool.","tags":["Entitlements"]}},"/entitlements/v1/global-application-entitlements":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br/>The input spec must not contain duplicate Ids.All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated access group of global application entitlement.","operationId":"bulkDeleteGAEEntitlements","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Specifications for bulk GAE Entitlements to be Deleted.","items":{"$ref":"#/components/schemas/EntitlementSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkEntitlementResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Delete the bulk entitlements for a set of Global Application Entitlements","tags":["Entitlements"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br/>Note that this API depends on internal cache. There may be a delay in new entities being reflected in the response.<br/>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Returns results only for those entitlements of global application entitlements, for which the caller has permission to this privilege, on the associated access group of global application entitlement.","operationId":"listGAEEntitlements","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the user or group entitlements for Global Application Entitlements in the environment.","tags":["Entitlements"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br/>The input spec must not contain duplicate Ids.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated access group of global application entitlement.","operationId":"bulkCreateGAEEntitlements","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Specifications for bulk GAE Entitlements to be created.","items":{"$ref":"#/components/schemas/EntitlementSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkEntitlementResponseInfo"}}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Create the bulk entitlements for a set of Global Application Entitlements","tags":["Entitlements"]}},"/entitlements/v1/global-application-entitlements/{id}":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br>Note that this API depends on internal cache. There may be a delay in new entities being reflected in the response.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated access group of global application entitlement.","operationId":"getGAEEntitlement","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntitlementInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the user or group entitlements for a Global Application Entitlement.","tags":["Entitlements"]}},"/entitlements/v1/global-desktop-entitlements":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br/>The input spec must not contain duplicate Ids.All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated access group of global desktop entitlement.","operationId":"bulkDeleteGDEEntitlements","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Specifications for bulk GDE Entitlements to be Deleted.","items":{"$ref":"#/components/schemas/EntitlementSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkEntitlementResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Delete the bulk entitlements for a set of Global Desktop Entitlements","tags":["Entitlements"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br/>Note that this API depends on internal cache. There may be a delay in new entities being reflected in the response.<br/>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Returns results only for those entitlements of global desktop entitlements, for which the caller has permission to this privilege, on the associated access group of global desktop entitlement.","operationId":"listGDEEntitlements","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the user or group entitlements for Global Desktop Entitlements in the environment.","tags":["Entitlements"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br/>The input spec must not contain duplicate Ids.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated access group of global desktop entitlement.","operationId":"bulkCreateGDEEntitlements","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Specifications for bulk GDE Entitlements to be created.","items":{"$ref":"#/components/schemas/EntitlementSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkEntitlementResponseInfo"}}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Create the bulk entitlements for a set of Global Desktop Entitlements","tags":["Entitlements"]}},"/entitlements/v1/global-desktop-entitlements/{id}":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br>Note that this API depends on internal cache. There may be a delay in new entities being reflected in the response.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated access group of global desktop entitlement.","operationId":"getGDEEntitlement","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntitlementInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the user or group entitlements for a Global Desktop Entitlement.","tags":["Entitlements"]}},"/external/v1/ad-computers":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com","operationId":"listAdComputers","parameters":[{"description":"Whether to exclude AD computers which have already been registered as managed/unmanaged machines.","in":"query","name":"exclude_registered_machines","required":false,"schema":{"type":"boolean","default":false}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADComputerInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists AD computer information.","tags":["External"]}},"/external/v1/ad-domains":{"get":{"operationId":"listADDomains","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADDomainInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists information related to AD Domains of the environment.","tags":["External"]}},"/external/v1/ad-domains/action/bind":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"bind","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ADDomainSpec"}}},"required":true},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ADDomainBindInfo"}}},"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Bind untrusted domain to the connection server.","tags":["External"]}},"/external/v1/ad-domains/action/update-auxiliary-accounts":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateAuxiliaryAccounts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ADDomainAuxiliaryAccountUpdateSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Update auxiliary accounts of the untrusted domain","tags":["External"]}},"/external/v1/ad-domains/{id}/action/add-auxiliary-accounts":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"addAuxiliaryAccounts","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ADDomainAuxiliaryAccountCreateSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Add auxiliary accounts to the untrusted domain","tags":["External"]}},"/external/v1/ad-domains/{id}/action/delete-auxiliary-accounts":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteAuxiliaryAccounts","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ADDomainAuxiliaryAccountDeleteSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Specification to delete auxiliary accounts from the untrusted domain","tags":["External"]}},"/external/v1/ad-domains/{id}/action/unbind":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"unbind","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Unbind untrusted domain from the connection server.","tags":["External"]}},"/external/v1/ad-domains/{id}/action/update":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"update","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ADDomainUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates untrusted domain.","tags":["External"]}},"/external/v1/ad-domains/{id}/ad-containers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\nGLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\nPOOL_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listADContainers","parameters":[{"description":"AD domain SID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"AD container name in Base64URL encoded format","in":"query","name":"container_name","required":false,"schema":{"type":"string"}},{"description":"rdn of AD container in Base64URL encoded format","in":"query","name":"rdn","required":false,"schema":{"type":"string"}},{"description":"true to search subtree. Subtree search is only supported for rdn.","in":"query","name":"sub_tree_search","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADContainerInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"List active directory containers for a specific domain.","tags":["External"]}},"/external/v1/ad-domains/{id}/ad-containers/default":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\nGLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\nPOOL_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getDefaultADContainer","parameters":[{"description":"AD Domain SID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ADContainerInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get default AD container for specified domain.","tags":["External"]}},"/external/v1/ad-domains/{id}/ad-containers/{rdn}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\nGLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\nPOOL_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getADContainer","parameters":[{"description":"AD Domain SID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"rdn of AD container in Base64URL encoded format.","in":"path","name":"rdn","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ADContainerInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the AD container for specified domain.","tags":["External"]}},"/external/v1/ad-users-or-groups":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com","operationId":"listADUserOrGroupSummary","parameters":[{"description":"Presence of this query param indicates to filter only groups or only users. \n If passed as \"true\", then only groups are returned.\n If passed as \"false\", then only users are returned.\n If not passed passed at all, then both types are returned.","in":"query","name":"group_only","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADUserOrGroupSummary"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists AD users or groups information.","tags":["External"]}},"/external/v1/ad-users-or-groups/action/change-user-password":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to change the password of AD User.\n","operationId":"changeUserPassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ADUserChangePasswordSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ADUserInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Changes the password of AD User","tags":["External"]}},"/external/v1/ad-users-or-groups/action/hold":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FORENSICS | Caller should have permission to this privilege, to perform this operation. |","operationId":"bulkHoldUserOrGroup","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of AD user SIDs to put on hold.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Put users on hold.","tags":["External"]}},"/external/v1/ad-users-or-groups/action/release-hold":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FORENSICS | Caller should have permission to this privilege, to perform this operation. |","operationId":"bulkReleaseHoldUserOrGroup","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of AD user SIDs to release from hold.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Release users from hold.","tags":["External"]}},"/external/v1/ad-users-or-groups/action/validate-user-encrypted-credentials":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to validate the encrypted credentials of AD User.\n","operationId":"validateADUserEncryptedCredentials","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ADUserEncryptedCredentialSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ADUserInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Validates the encrypted credentials of AD User","tags":["External"]}},"/external/v1/ad-users-or-groups/held-users-or-groups":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FORENSICS | Caller should have permission to this privilege, to perform this operation. |","operationId":"listHeldUsersOrGroups","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HeldUserOrGroupInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"List information related to Held Users.","tags":["External"]}},"/external/v1/ad-users-or-groups/{id}":{"get":{"operationId":"getADUserOrGroupInfo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ADUserOrGroupInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get information related to AD User or Group","tags":["External"]}},"/external/v1/audit-events":{"get":{"description":"This API supports <b>Pagination</b>.<br/>","operationId":"listAuditEvents","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuditEventSummary"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the audit events.","tags":["External"]}},"/external/v1/audit-events/agent-upgrade-history":{"get":{"operationId":"getAgentUpgradeHistory","parameters":[{"description":"Indicates the time from which upgrade history is to be fetched.\nIf both from_time and to_time are unset, all history till date will be fetched.","example":1652079610000,"in":"query","name":"from_time","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"Indicates the time up to which upgrade history is to be fetched.\nIf both from_time and to_time are unset, all history till date will be fetched.","example":1652079610000,"in":"query","name":"to_time","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentUpgradeHistoryInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the agent upgrade history.","tags":["External"]}},"/external/v1/audit-events/extended-attributes":{"get":{"operationId":"auditEventsExtendedAttributes","parameters":[{"description":"Audit Event IDs","in":"query","name":"ids","required":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuditEventAttributeInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get extended attributes of audit events","tags":["External"]}},"/external/v1/base-snapshots":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listBaseSnapshots","parameters":[{"description":"Virtual Center ID","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"VM ID","example":"vm-1","in":"query","name":"base_vm_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseSnapshotInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the VM snapshots from the vCenter for a given VM.","tags":["External"]}},"/external/v1/base-vms":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listBaseVMs","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Datacenter ID","in":"query","name":"datacenter_id","required":false,"schema":{"type":"string"}},{"description":"Whether to filter out incompatible VMs","in":"query","name":"filter_incompatible_vms","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseVMInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the VMs from a vCenter or a datacenter in that vCenter which may be suitable as snapshots for instant clone desktop pool or farm creation.","tags":["External"]}},"/external/v1/capacity-providers":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listCapacityProviders","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CapacityProviderInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists capacity providers added in the environment.","tags":["External"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"addCapacityProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapacityProviderCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Adds a capacity provider","tags":["External"]}},"/external/v1/capacity-providers/aws-core/regions":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listRegions","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AWSRegionInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the regions from AWS core","tags":["External"]}},"/external/v1/capacity-providers/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"removeCapacityProvider","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Removes a capacity provider","tags":["External"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getCapacityProvider","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CapacityProviderInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets capacity provider Information.","tags":["External"]}},"/external/v1/capacity-providers/{id}/aws-images":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listImages","parameters":[{"description":"Capacity provider Id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AWSImageInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the images from AWS core for the specific capacity provider id","tags":["External"]}},"/external/v1/capacity-providers/{id}/bundles":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listBundles","parameters":[{"description":"Capacity provider Id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AWSBundleInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the bundles from AWS core for the specific capacity provider id","tags":["External"]}},"/external/v1/capacity-providers/{id}/directories":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listDirectories","parameters":[{"description":"Capacity Provider Id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AWSDirectoryInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the directories from AWS core for the specific capacity provider id","tags":["External"]}},"/external/v1/capacity-providers/{id}/images":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listCapacityProviderImages","parameters":[{"description":"Capacity Provider Id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImageInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves images available with the capacity provider.","tags":["External"]}},"/external/v1/capacity-providers/{id}/networks":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listNetworks","parameters":[{"description":"Capacity Provider Id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NetworkInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the networks of the specific capacity provider id.","tags":["External"]}},"/external/v1/capacity-providers/{id}/resource-containers":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listResourceContainers","parameters":[{"description":"Capacity Provider Id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResourceContainerInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the Resource Containers of the specific capacity provider id.","tags":["External"]}},"/external/v1/customization-specifications":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listCustomizationSpecs","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomizationSpecInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the customization specifications from the vCenter.","tags":["External"]}},"/external/v1/datacenters":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listDatacenters","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatacenterInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the datacenters of a vCenter.","tags":["External"]}},"/external/v1/datastore-clusters":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listDatastoreClusters","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Host or Cluster ID","in":"query","name":"host_or_cluster_id","required":true,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatastoreClusterInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the datastore clusters from the vCenter for the given host or cluster.","tags":["External"]}},"/external/v1/datastore-paths":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listDatastorePaths","parameters":[{"description":"Virtual Center ID","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Datastore ID","example":"datastore-29","in":"query","name":"datastore_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatastorePathInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the folder paths within a Datastore from vCenter.","tags":["External"]}},"/external/v1/datastores":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listdatastores","parameters":[{"description":"Virtual Center ID","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Host or Cluster ID","example":"domain-c85","in":"query","name":"host_or_cluster_id","required":true,"schema":{"type":"string"}},{"description":"Resource type.","in":"query","name":"resource_type","required":false,"schema":{"type":"string","enum":["FARM","DESKTOP_POOL"]}},{"description":"Resource ID, can be desktop pool or farm id.","example":"67bc8787-fa2e-4593-b441-616674b8fa97","in":"query","name":"resource_id","required":false,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatastoreInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the datastores from the vCenter for the given host or cluster.","tags":["External"]}},"/external/v1/datastores/action/compute-requirements":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated desktop or farm.","operationId":"computeSpaceRequirements","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatastoreSpaceRequirementSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatastoreSpaceRequirementInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Computes the datastore space requirements for inventory resources.","tags":["External"]}},"/external/v1/datastores/action/compute-vsan-cost":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"computeVsanCost","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Automated pool type","in":"query","name":"pool_type","required":true,"schema":{"type":"string","enum":["INSTANT_CLONE","FULL_CLONE"]}},{"description":"If set to true it would indicate that user assignment type is dedicated or else it is floating","in":"query","name":"is_dedicated","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/VsanDatastoreCostInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Computes the vsan cost for given pool type.","tags":["External"]}},"/external/v1/domains":{"get":{"operationId":"listDomains","responses":{"200":{"content":{"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}},"description":"OK"},"429":{"description":"Too many requests"}},"summary":"Returns a map of domain NETBIOS name and dns name for domains which are configured on connection server.","tags":["External"]}},"/external/v1/hosts-or-clusters":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listHostsOrClusters","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Datacenter ID","in":"query","name":"datacenter_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HostOrClusterInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the hosts or clusters of the datacenter.","tags":["External"]}},"/external/v1/network-interface-cards":{"get":{"description":"If the base VM and snapshot are specified, then the NICs  present on the given snapshot are listed.<br/> If the template is specified then the NICs present on the given template are listed.<br/> If only base VM is specified then the NICs present on the given base VM are listed.<br/>At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listNetworkInterfaceCards","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Base VM ID","in":"query","name":"base_vm_id","required":false,"schema":{"type":"string"}},{"description":"Base Snapshot ID","in":"query","name":"base_snapshot_id","required":false,"schema":{"type":"string"}},{"description":"VM Template ID","in":"query","name":"vm_template_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NetworkInterfaceCardInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns a list of network interface cards (NICs) suitable for configuration on a desktop pool/farm.","tags":["External"]}},"/external/v1/network-labels":{"get":{"description":"API retrieves by filtering on the network type (if specified) that may be suitable for configuration with a desktop pool/farm's network interface card.<br/>At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listNetworkLabels","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Host or Cluster ID","in":"query","name":"host_or_cluster_id","required":true,"schema":{"type":"string"}},{"description":"Network Type","in":"query","name":"network_type","required":false,"schema":{"type":"string","enum":["NETWORK","OPAQUE_NETWORK","DISTRUBUTED_VIRTUAL_PORT_GROUP"]}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NetworkLabelInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves all network labels on the given host or cluster","tags":["External"]}},"/external/v1/resource-pools":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listResourcePools","parameters":[{"description":"Virtual Center ID","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Host or Cluster ID","example":"domain-c85","in":"query","name":"host_or_cluster_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResourcePoolInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the resource pools from the vCenter for the given host or cluster.","tags":["External"]}},"/external/v1/virtual-disks":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVirtualDisks","parameters":[{"description":"Virtual Center ID","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Datastore ID","example":"domain-c85","in":"query","name":"datastore_id","required":false,"schema":{"type":"string"}},{"description":"Populates all virtual disks irrespective of their compatability. Default value is false.","example":true,"in":"query","name":"populate_all_disks","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualDiskInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists Virtual disks from vCenter for a given datastore. If datastore_id is not specified, it lists the Virtual Disks for all datastores. If populate_all_disks is set to true, all virtual disks will be populated.","tags":["External"]}},"/external/v1/virtual-machines":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVirtualMachines","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualMachineInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the VMs from a vCenter.","tags":["External"]}},"/external/v1/vm-folders":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVMFolders","parameters":[{"description":"Virtual Center ID","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Datacenter ID","example":"datacenter-1","in":"query","name":"datacenter_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VMFolderInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the VM folders from the vCenter for the given datacenter.","tags":["External"]}},"/external/v1/vm-templates":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVMTemplates","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Datacenter ID","in":"query","name":"datacenter_id","required":false,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VMTemplateInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the VM templates from a vCenter or a datacenter for the given vCenter which may be suitable for full clone desktop pool creation.","tags":["External"]}},"/external/v2/ad-domains":{"get":{"operationId":"listADDomainsV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADDomainInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists information related to AD Domains of the environment.","tags":["External"]}},"/external/v2/ad-users-or-groups/action/hold":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FORENSICS | Caller should have permission to this privilege, to perform this operation. |","operationId":"bulkHoldUserOrGroupV2","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of AD user SIDs to put on hold.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HeldUserOrGroupResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Put users on hold.","tags":["External"]}},"/external/v2/ad-users-or-groups/action/release-hold":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FORENSICS | Caller should have permission to this privilege, to perform this operation. |","operationId":"bulkReleaseHoldUserOrGroupV2","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of AD user SIDs to release from hold.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HeldUserOrGroupResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Release users from hold.","tags":["External"]}},"/external/v2/ad-users-or-groups/{id}":{"get":{"operationId":"getADUserOrGroupInfoV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ADUserOrGroupInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get information related to AD User or Group","tags":["External"]}},"/external/v2/audit-events":{"get":{"description":"This API supports <b>Pagination</b>.<br/>","operationId":"listAuditEventsV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuditEventSummaryV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the audit events.","tags":["External"]}},"/external/v2/audit-events/agent-upgrade-history":{"get":{"operationId":"getAgentUpgradeHistoryV2","parameters":[{"description":"Indicates the time from which upgrade history is to be fetched.\nIf both from_time and to_time are unset, all history till date will be fetched.","example":1652079610000,"in":"query","name":"from_time","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"Indicates the time up to which upgrade history is to be fetched.\nIf both from_time and to_time are unset, all history till date will be fetched.","example":1652079610000,"in":"query","name":"to_time","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentUpgradeHistoryInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the agent upgrade history.","tags":["External"]}},"/external/v2/base-snapshots":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listBaseSnapshotsV2","parameters":[{"description":"Virtual Center ID","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"VM ID","example":"vm-1","in":"query","name":"base_vm_id","required":true,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseSnapshotInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the VM snapshots from the vCenter for a given VM.","tags":["External"]}},"/external/v2/base-vms":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listBaseVMsV2","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Datacenter ID","in":"query","name":"datacenter_id","required":false,"schema":{"type":"string"}},{"description":"Whether to filter out incompatible VMs","in":"query","name":"filter_incompatible_vms","required":false,"schema":{"type":"boolean","default":false}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseVMInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the VMs from a vCenter or a datacenter in that vCenter which may be suitable as snapshots for instant clone desktop pool or farm creation.","tags":["External"]}},"/external/v2/base-vms/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getBaseVMsV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Datacenter ID","in":"query","name":"datacenter_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/BaseVMInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the specified VM information","tags":["External"]}},"/external/v2/capacity-providers":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listCapacityProvidersV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CapacityProviderInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists capacity providers added in the environment.","tags":["External"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"addCapacityProviderV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapacityProviderCreateSpecV2"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Adds a capacity provider","tags":["External"]}},"/external/v2/capacity-providers/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getCapacityProviderV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CapacityProviderInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets capacity provider Information.","tags":["External"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateCapacityProviderV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapacityProviderUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a capacity provider","tags":["External"]}},"/external/v2/datastores/action/compute-requirements":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated desktop or farm.","operationId":"computeSpaceRequirementsV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatastoreSpaceRequirementSpecV2"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatastoreSpaceRequirementInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Computes the datastore space requirements for inventory resources.","tags":["External"]}},"/external/v2/network-interface-cards":{"get":{"description":"If the base VM and snapshot are specified, then the NICs  present on the given snapshot are listed.<br/> If the template is specified then the NICs present on the given template are listed.<br/> If only base VM is specified then the NICs present on the given base VM are listed.<br/>At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listNetworkInterfaceCardsV2","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Base VM ID","in":"query","name":"base_vm_id","required":false,"schema":{"type":"string"}},{"description":"Base Snapshot ID","in":"query","name":"base_snapshot_id","required":false,"schema":{"type":"string"}},{"description":"VM Template ID","in":"query","name":"vm_template_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NetworkInterfaceCardInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns a list of network interface cards (NICs) suitable for configuration on a desktop pool/farm.","tags":["External"]}},"/external/v2/vm-templates":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVMTemplatesV2","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Datacenter ID","in":"query","name":"datacenter_id","required":false,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VMTemplateInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the VM templates from a vCenter or a datacenter for the given vCenter which may be suitable for full clone desktop pool creation.","tags":["External"]}},"/external/v3/ad-domains":{"get":{"operationId":"listADDomainsV3","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADDomainInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists information related to AD Domains of the environment.","tags":["External"]}},"/external/v3/audit-events/agent-upgrade-history":{"get":{"operationId":"getAgentUpgradeHistoryV3","parameters":[{"description":"Indicates the time from which upgrade history is to be fetched.\nIf both from_time and to_time are unset, all history till date will be fetched.","example":1652079610000,"in":"query","name":"from_time","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"Indicates the time up to which upgrade history is to be fetched.\nIf both from_time and to_time are unset, all history till date will be fetched.","example":1652079610000,"in":"query","name":"to_time","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentUpgradeHistoryInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the agent upgrade history.","tags":["External"]}},"/external/v3/base-snapshots":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listBaseSnapshotsV3","parameters":[{"description":"Virtual Center ID","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"VM ID","example":"vm-1","in":"query","name":"base_vm_id","required":true,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseSnapshotInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the VM snapshots from the vCenter for a given VM.","tags":["External"]}},"/external/v3/base-vms":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listBaseVMsV3","parameters":[{"description":"Virtual Center ID","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Datacenter ID","in":"query","name":"datacenter_id","required":false,"schema":{"type":"string"}},{"description":"Whether to filter out incompatible VMs","in":"query","name":"filter_incompatible_vms","required":false,"schema":{"type":"boolean","default":false}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseVMInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the VMs from a vCenter or a datacenter in that vCenter which may be suitable as snapshots for instant clone desktop pool or farm creation.","tags":["External"]}},"/external/v3/capacity-providers":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listGenericCapacityProviders","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GenericCapacityProviderInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists capacity providers.","tags":["External"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"addGenericCapacityProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericCapacityProviderCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Adds a capacity provider.","tags":["External"]}},"/external/v3/capacity-providers/action/validate-certificate":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"validateGenericCapacityProviderCertificate","parameters":[{"description":"FQDN of the capacity provider. Applicable for deployment type PRISM.","in":"query","name":"server_name","required":true,"schema":{"type":"string"}},{"description":"Not applicable for deployment type PRISM.","in":"query","name":"port","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"deployment_type","required":true,"schema":{"type":"string","enum":["PRISM"]}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CertificateData"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Validates the certificate for the capacity provider.","tags":["External"]}},"/external/v3/capacity-providers/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteGenericCapacityProvider","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a capacity provider.","tags":["External"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getGenericCapacityProvider","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericCapacityProviderInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a capacity provider.","tags":["External"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateGenericCapacityProvider","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericCapacityProviderUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a capacity provider.","tags":["External"]}},"/external/v4/ad-users-or-groups":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com","operationId":"listADUserOrGroupInfoV4","parameters":[{"in":"query","name":"group_only","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"detailed_info","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADUserOrGroupInfoV4"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists AD users or groups information.","tags":["External"]}},"/external/v4/ad-users-or-groups/{id}":{"get":{"operationId":"getADUserOrGroupInfoV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ADUserOrGroupInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get information related to AD User or Group","tags":["External"]}},"/external/v4/capacity-providers":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listGenericCapacityProvidersV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GenericCapacityProviderV2Info"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists capacity providers.","tags":["External"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"addGenericCapacityProviderV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericCapacityProviderV2CreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Adds a capacity provider.","tags":["External"]}},"/external/v4/capacity-providers/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getGenericCapacityProviderV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericCapacityProviderV2Info"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a capacity provider.","tags":["External"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| CAPACITY_PROVIDER_CONFIG_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateGenericCapacityProviderV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericCapacityProviderV2UpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a capacity provider.","tags":["External"]}},"/federation/v1/cpa":{"get":{"description":"Note: CPA need not be initialized for the pod for invoking this API.\nLocal connection server status will always be populated. Other details require the respective privilege from the below list: -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW| This privilege is required to access the Pod Federation related data. This will be unset if the privilege is not met.\n| GLOBAL_CONFIG_VIEW | This privilege is required to access the Connection Server Status data. This will be unset if the privilege is not met.","operationId":"getPodFederation","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PodFederationInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the pod federation details.","tags":["Federation"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE| This privilege is required to update the pod federation.","operationId":"updatePodFederation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPAUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Pod Federation.","tags":["Federation"]}},"/federation/v1/cpa/action/eject":{"post":{"description":"Note: This operation should only be performed against a remote pod that is down and no longer functional. If the remote pod is still operational, an unjoin operation should be used on that pod instead. Upon successful completion of eject operation, the ejected pod's topology will be removed from the Pod Federation. All GlobalEntitlement data that is relevant to the ejected pod will be modified. Eject operation can not be performed against the current pod. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"ejectPod","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPAEjectSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Removes a pod from Cloud Pod Federation.","tags":["Federation"]}},"/federation/v1/cpa/action/initialize":{"post":{"description":"Note: The pod on which this command is invoked must not already be part of a Pod Federation or have replica Connection Servers in transitional states. After being initialized, a Pod Federation is created and will have one default member site, which will have a single member pod (the local pod). The Pod Federation topology (Site, Pod, and PodEndpoint) will be automatically populated. A Task Id is returned and can be used to track the progress and status of the initialize operation. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"initializeCPA","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CPATaskResponseInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA is initialized for the pod | An active Pod Federation operation is detected"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Initialize Cloud Pod Federation.","tags":["Federation"]}},"/federation/v1/cpa/action/join":{"post":{"description":"Note: At the successful completion of join operation the current pod will become a new member of the Pod Federation. The joining Pod will be assigned to a default Site and that might need to be updated post-join. All Pod Federation topology, including the current pod, will be populated. Join operation can only be performed on a pod that is not already a member of a Pod Federation. The pod on which the operation is performed on must not have replica Connection Servers in transitional states. Join operation can only be sent to a pod that is already a Pod Federation member. A Task Id is returned and can be used to track the progress and status of the join operation. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"joinCPA","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPAJoinSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CPATaskResponseInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA is initialized for the pod | An active Pod Federation operation is detected"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Join Cloud Pod Federation.","tags":["Federation"]}},"/federation/v1/cpa/action/rotate-keypair":{"post":{"description":"Note: CPA needs to be initialized for the pod for invoking this API.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"rotateKeyPair","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPAKeyPairRotationSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Request for an on demand CPA Key Pair rotation.","tags":["Federation"]}},"/federation/v1/cpa/action/uninitialize":{"post":{"description":"Note: The pod on which this command is invoked must be the only remaining member in the Pod Federation. Invoking uninitialize when there is more than one pod in the Pod Federation will fail. The pod on which the operation is performed must not have replica Connection Servers in transitional states. At the completion of uninitialize, the Pod Federation topology information will be removed and it becomes a non-federated pod. A Task Id is returned and can be used to track the progress and status of the uninitialize operation. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"uninitializeCPA","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CPATaskResponseInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod | An active Pod Federation operation is detected"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Uninitialize Cloud Pod Federation.","tags":["Federation"]}},"/federation/v1/cpa/action/unjoin":{"post":{"description":"Note: At the successful completion of the unjoin operation the current pod will become a non-federated pod that is no longer a member of the Pod Federation. All Pod Federation topology data will be removed from the current pod. GlobalEntitlement reference to this pod will be updated with an unjoin. Unjoin operation can only be performed if the current pod is not the only/last member of a Pod Federation; an uninitialize operation should be performed instead. The pod on which the operation is performed on must not have replica Connection Servers in transitional states. A Task Id is returned and can be used to track the progress and status of the unjoin operation. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"unjoinCPA","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CPATaskResponseInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod | An active Pod Federation operation is detected"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Unjoin from Cloud Pod Federation.","tags":["Federation"]}},"/federation/v1/cpa/tasks":{"get":{"description":"Note: CPA need not be initialized for the pod for invoking this API.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listTasks","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaskInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the CPA tasks in the pod federation.","tags":["Federation"]}},"/federation/v1/cpa/tasks/{id}":{"get":{"description":"Note: CPA need not be initialized for the pod for invoking this API.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/TaskInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the information for a given task.","tags":["Federation"]}},"/federation/v1/home-sites":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE| Caller should have permission to this privilege on associated federated access group of GAE/GDE for deleting Home Sites. |","operationId":"deleteHomeSites","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of home site IDs to be deleted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given home sites from the pod federation.","tags":["Federation"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW| Returns only those home sites for which caller has permission to this privilege on associated federated access group of GAE/GDE. |","operationId":"listHomeSites","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HomeSiteInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the home sites in the pod federation.","tags":["Federation"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE| Caller should have permission to this privilege on associated federated access group of GAE/GDE for creating Home Sites. |","operationId":"createHomeSites","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of home site objects to be created.","items":{"$ref":"#/components/schemas/HomeSiteCreateSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates the given home sites in the pod federation.","tags":["Federation"]}},"/federation/v1/home-sites/action/resolve":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW| Resolves and returns only those home sites for which caller has permission to this privilege on associated federated access group of GAE/GDE. |","operationId":"resolveHomeSites","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HomeSiteResolutionSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HomeSiteResolutionInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Resolves home sites for a user in the pod federation.","tags":["Federation"]}},"/federation/v1/home-sites/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW| Returns only those home sites for which caller has permission to this privilege on associated federated access group of GAE/GDE. |","operationId":"getHomeSite","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/HomeSiteInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a given home site in the pod federation.","tags":["Federation"]}},"/federation/v1/pod-assignments":{"get":{"description":"Pod assignments represent data about which pod contains resource assignments for a given user and global entitlement. This assigned pod helps brokering make good decisions when trying to launch a resource for a user, especially in cases where a pod is offline and new resource assignment for an existing user and persistent global entitlement is to be avoided. This data is automatically calculated and created when a new user and global entitlement requests brokering.\nThis API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listPodAssignments","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PodAssignmentInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the pod assignments in the pod federation.","tags":["Federation"]}},"/federation/v1/pod-assignments/{id}":{"get":{"description":"Pod assignments represent data about which pod contains resource assignments for a given user and global entitlement. This assigned pod helps brokering make good decisions when trying to launch a resource for a user, especially in cases where a pod is offline and new resource assignment for an existing user and persistent global entitlement is to be avoided. This data is automatically calculated and created when a new user and global entitlement requests brokering.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getPodAssignment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PodAssignmentInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a given pod assignment from the pod federation.","tags":["Federation"]}},"/federation/v1/pods":{"get":{"description":"Note that this API depends on internal cache. There may be a delay in new fields being reflected in the response.\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege on any federated access group, to perform this operation. Endpoint details will be absent if caller is not on root federated access group. |\nFEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege on any federated access group, to perform this operation. Endpoint details will be absent if caller is not on root federated access group. |\n","operationId":"listPods","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PodInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the pods in the pod federation.","tags":["Federation"]}},"/federation/v1/pods/{id}":{"get":{"description":"Note that this API depends on internal cache. There may be a delay in new fields being reflected in the response.\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege on any federated access group, to perform this operation. Endpoint details will be absent if caller is not on root federated access group. |\nFEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege on any federated access group, to perform this operation. Endpoint details will be absent if caller is not on root federated access group. |\n","operationId":"getPod","parameters":[{"description":"ID of the Pod.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PodInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a given pod from the pod federation.","tags":["Federation"]},"put":{"description":"Only site ID can be updated for cloud managed pods from on-premise interfaces.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"updatePod","parameters":[{"description":"ID of the Pod.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PodUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the given pod in the pod federation.","tags":["Federation"]}},"/federation/v1/pods/{id}/endpoints":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listPodEndpoint","parameters":[{"description":"Pod ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PodEndpointInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the pod endpoints for the given pod.","tags":["Federation"]}},"/federation/v1/pods/{id}/endpoints/{endpointId}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getPodEndpoint","parameters":[{"description":"Pod ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Pod endpoint ID","in":"path","name":"endpointId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PodEndpointInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves pod endpoint details for the given pod endpoint id in the given pod.","tags":["Federation"]}},"/federation/v1/sites":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege on any federated access group, to perform this operation. |","operationId":"listSites","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the sites in the pod federation.","tags":["Federation"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"createSite","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a site.","tags":["Federation"]}},"/federation/v1/sites/{id}":{"delete":{"description":"Note: The home site, in which this site is used, will also be deleted.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteSite","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a site.","tags":["Federation"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege on any federated access group, to perform this operation. |","operationId":"getSite","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SiteInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrives a given site.","tags":["Federation"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateSite","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a site.","tags":["Federation"]}},"/federation/v2/cpa":{"get":{"description":"Note: CPA need not be initialized for the pod for invoking this API.\nLocal connection server status will always be populated. Other details require the respective privilege from the below list: -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW| This privilege is required to access the Pod Federation related data. This will be unset if the privilege is not met.\n| GLOBAL_CONFIG_VIEW | This privilege is required to access the Connection Server Status data. This will be unset if the privilege is not met.","operationId":"getPodFederationV2","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PodFederationInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the pod federation details.","tags":["Federation"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE| This privilege is required to update the pod federation.","operationId":"updatePodFederationV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPAUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Pod Federation.","tags":["Federation"]}},"/federation/v2/home-sites":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE| Caller should have permission to this privilege on associated federated access group of GAE/GDE for deleting Home Sites. |","operationId":"deleteHomeSitesV2","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of home site IDs to be deleted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given home sites from the pod federation.","tags":["Federation"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW| Returns only those home sites for which caller has permission to this privilege on associated federated access group of GAE/GDE. |","operationId":"listHomeSitesV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HomeSiteInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the home sites in the pod federation.","tags":["Federation"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE| Caller should have permission to this privilege on associated federated access group of GAE/GDE for creating Home Sites. |","operationId":"createHomeSitesV2","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of home site objects to be created.","items":{"$ref":"#/components/schemas/HomeSiteCreateSpecV2"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates the given home sites in the pod federation.","tags":["Federation"]}},"/federation/v2/home-sites/action/resolve":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW| Resolves and returns only those home sites for which caller has permission to this privilege on associated federated access group of GAE/GDE. |","operationId":"resolveHomeSitesV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HomeSiteResolutionSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HomeSiteResolutionInfoV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Resolves home sites for a user in the pod federation.","tags":["Federation"]}},"/federation/v2/home-sites/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW| Returns only those home sites for which caller has permission to this privilege on associated federated access group of GAE/GDE. |","operationId":"getHomeSiteV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/HomeSiteInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a given home site in the pod federation.","tags":["Federation"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE| Caller should have permission to this privilege on associated federated access group of GAE/GDE for deleting Home Sites. |","operationId":"updateHomeSiteV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HomeSiteUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the given home sites from the pod federation.","tags":["Federation"]}},"/federation/v2/sites":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege on any federated access group, to perform this operation. |","operationId":"listSitesV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the sites in the pod federation.","tags":["Federation"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"createSiteV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteCreateSpecV2"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a site.","tags":["Federation"]}},"/federation/v2/sites/{id}":{"delete":{"description":"Note: The home site, in which this site is used, will also be deleted.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteSiteV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a site.","tags":["Federation"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege on any federated access group, to perform this operation. |","operationId":"getSiteV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SiteInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrives a given site.","tags":["Federation"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateSiteV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a site.","tags":["Federation"]}},"/federation/v3/sites":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege on any federated access group, to perform this operation. |","operationId":"listSitesV3","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists all the sites in the pod federation.","tags":["Federation"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"createSiteV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteCreateSpecV3"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a site.","tags":["Federation"]}},"/federation/v3/sites/{id}":{"delete":{"description":"Note: The home site, in which this site is used, will also be deleted.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"deleteSiteV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a site.","tags":["Federation"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege on any federated access group, to perform this operation. |","operationId":"getSiteV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SiteInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves a given site.","tags":["Federation"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"updateSiteV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a site.","tags":["Federation"]}},"/helpdesk/v1/client":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getClientInformation","parameters":[{"description":"Internal session id, also applicable for global sessions.","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A=","in":"query","name":"internal_session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ViewClientInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves Client Display Topology Information.","tags":["Help Desk"]}},"/helpdesk/v1/logon-timing/logon-segment":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |\n### Please note:\n1. Timings are taken on different machines where the wall clock times on each computer may not match.\n2. Breakdowns that are not applicable will not be present or have a duration of -1.\n3. The nodes' duration is not necessarily the sum of its breakdown timings. The unaccounted field is the difference between the sum(breakdown.duration) and the nodes duration.\n### Timing tree breakdowns\n\n| **Parent**    | **Breakdown**    | **Description** |\n|-----------|-------------|-------------|\n| root      | broker       | Total time spent on broker processing XML request. |\n| broker    | authentication | Time spent checking that client is still authenticated. This is normally not present because the duration is zero. |\n| broker    | existingSessionSearch | CPA only. Broker handling client request synchronously tries other brokers in pod until request is handled. |\n| broker    | brokerLaunch{-id} | Parent breakdown for various launch/reconnect activities. When CPA is enabled the {-id} is present and multiple brokerLaunch breakdowns can be present. Only one broker will successfully handle the launch/reconnect, the other entries are time taken probing brokers that can not fulfil the request. |\n| broker \\ brokerLaunch{-id} | machineSelection | Search for best matching VM that can fulfil the launch/reconnect. |\n| broker \\ brokerLaunch{-id} \\ machineSelection | machinePowerOn | Total time taken to startup a VM. This includes booting the OS, or resuming a suspended machine, and View agent signally it's ready for a connection. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn | brokerStartVmOp | Time taken to instruct vSphere to perform the power on operation. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn \\ brokerStartVmOp | vcConnect, prepareVmStart, vcExecuteVmStart | vSphere connect, prepare and start power on operation. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn | agentStart | Time for machine start, OS to boot and agent to startup. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn | agentReady | Time between agent startup completion and agent ready to accept connections. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn | brokerStartVmPostOp | Post processing after agent ready and broker continues on. |\n| broker \\ brokerLaunch{-id} | raiseTunnel | Instruct Security Server to prepare a tunnel connection. |\n| broker \\ brokerLaunch{-id} | sessionScript | Run broker session script. |\n| broker \\ brokerLaunch{-id} | machinePrepare | Once a VM is selected the broker contacts the VM agent to prepare it for an incoming connection. |\n| broker \\ brokerLaunch{-id} \\ machinePrepare | agentPrepare | Timing taken on the agent and prepare the VM for incoming connection. |\n| broker \\ brokerLaunch{-id} \\ machinePrepare \\ agentPrepare | userScript | Time taken to run user defined script. |\n| broker \\ brokerLaunch{-id} \\ machinePrepare \\ agentPrepare | protocolStartup | Time taken to startup the protocol; PCoIP, Blast or RDP. |\n| root | agent | Total time spent on agent to process a launch/reconnect. |\n| agent | clientConnectWait | The time between agentPrepare completing and View Client connecting. At this point the client has opened a socket, and authenticated to the Windows machine. |\n| agent | clientLogon | Time taken to create a Windows session. |\n| agent \\ clientLogon | userProfile | Time Windows user profile processing. |\n| agent \\ clientLogon \\ userProfile | profileSync | In the case of roaming profile this is the time Windows takes to download user profile. |\n| agent \\ clientLogon \\ userProfile | hiveLoad | Time Windows takes to load user registry hive. |\n| agent \\ clientLogon | userGpo | Windows Group Policy processing. |\n| agent \\ clientLogon | shellLoad | How long does it take to load the Windows shell (i.e. explorer.exe). |\n| agent | appLaunch | For RDSH this times application launching. This only times how long it takes to start the process, not when the application is initialized and functioning. |\n","operationId":"getLogonSegmentInfo","parameters":[{"description":"ID of the session, also applicable for global sessions","example":"42bfd2d2-1a87-3d07-a24a-0fbbc60e37ee","in":"query","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/LogonSegmentInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the session timing data.","tags":["Help Desk"]}},"/helpdesk/v1/performance/display-protocol":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getDisplayProtocolPerformanceInfo","parameters":[{"description":"ID of the session, also applicable for global sessions.","example":"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b","in":"query","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DisplayProtocolPerformanceInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves performance data of the current session display protocol (PCoIP or BLAST).","tags":["Help Desk"]}},"/helpdesk/v1/performance/historical-data":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listHistoricalPerformanceInfo","parameters":[{"description":"ID of the session, also applicable for global sessions.","example":"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b","in":"query","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HistoricalPerformanceInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves historical performance data for the specific session in latest 15 minutes.","tags":["Help Desk"]}},"/helpdesk/v1/performance/process":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listProcessPerformanceInfo","parameters":[{"description":"ID of the session, also applicable for global sessions.","example":"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b","in":"query","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}},{"description":"Filter process by process session info.","in":"query","name":"process_filter","required":false,"schema":{"type":"string","enum":["CURRENT_USER_SESSION","SYSTEM_AND_CURRENT_USER_SESSION"]}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProcessPerformanceInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the process information.","tags":["Help Desk"]}},"/helpdesk/v1/performance/remote-application":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listRemoteApplicationPerformanceInfo","parameters":[{"description":"ID of the session, also applicable for global sessions.","example":"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b","in":"query","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RemoteApplicationPerformanceInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the remote applications information.","tags":["Help Desk"]}},"/helpdesk/v1/performance/remote-application/action/end-remote-application":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MANAGE_REMOTE_PROCESS | Caller should have permission to this privilege, to perform this operation. |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"endRemoteApplication","parameters":[{"description":"ID of the session, also applicable for global sessions.","example":"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b","in":"query","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the remote application, also applicable for global sessions.","example":"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b","in":"query","name":"remote_application_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Terminate an application running on virtual machine by session Id and the application Id.","tags":["Help Desk"]}},"/helpdesk/v1/performance/remote-application/s4b-pairing-mode":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getRemoteApplicationS4BPairingMode","parameters":[{"description":"session id, also applicable for global sessions.","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A=","in":"query","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RemoteApplicationPairingModeInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the remote applications s4b pairing mode information.","tags":["Help Desk"]}},"/helpdesk/v1/performance/remote-process/action/end-remote-process":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MANAGE_REMOTE_PROCESS | Caller should have permission to this privilege, to perform this operation. |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"endRemoteProcess","parameters":[{"description":"ID of the session, also applicable for global sessions.","example":"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b","in":"query","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteProcessSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Terminate a process running on virtual machine by session Id and the basic process information.","tags":["Help Desk"]}},"/helpdesk/v1/remote-assistant-ticket":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| REMOTE_ASSISTANCE | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"getRemoteAssistantTicketInfo","parameters":[{"description":"ID of the session, also applicable for global sessions.","example":"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b","in":"query","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RemoteAssistantTicketInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get a Microsoft Remote Assistance ticket by session Id.","tags":["Help Desk"]}},"/helpdesk/v1/ws1-assist":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getAgentStatus","parameters":[{"description":"ID of the session.","example":"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b","in":"query","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/Ws1AssistInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves ws1 assist agent status code.","tags":["Help Desk"]},"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |\n| REMOTE_ASSISTANCE | Caller should have permission to this privilege, to perform this operation. |","operationId":"initiateWs1Assist","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ws1AssistSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/Ws1AssistInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Initiates ws1 assist operation.","tags":["Help Desk"]}},"/helpdesk/v2/logon-timing/logon-segment":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |\n### Please note:\n1. Timings are taken on different machines where the wall clock times on each computer may not match.\n2. Breakdowns that are not applicable will not be present or have a duration of -1.\n3. The nodes' duration is not necessarily the sum of its breakdown timings. The unaccounted field is the difference between the sum(breakdown.duration) and the nodes duration.\n### Timing tree breakdowns\n\n| **Parent**    | **Breakdown**    | **Description** |\n|-----------|-------------|-------------|\n| root      | broker       | Total time spent on broker processing XML request. |\n| broker    | authentication | Time spent checking that client is still authenticated. This is normally not present because the duration is zero. |\n| broker    | existingSessionSearch | CPA only. Broker handling client request synchronously tries other brokers in pod until request is handled. |\n| broker    | brokerLaunch{-id} | Parent breakdown for various launch/reconnect activities. When CPA is enabled the {-id} is present and multiple brokerLaunch breakdowns can be present. Only one broker will successfully handle the launch/reconnect, the other entries are time taken probing brokers that can not fulfil the request. |\n| broker \\ brokerLaunch{-id} | machineSelection | Search for best matching VM that can fulfil the launch/reconnect. |\n| broker \\ brokerLaunch{-id} \\ machineSelection | machinePowerOn | Total time taken to startup a VM. This includes booting the OS, or resuming a suspended machine, and View agent signally it's ready for a connection. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn | brokerStartVmOp | Time taken to instruct vSphere to perform the power on operation. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn \\ brokerStartVmOp | vcConnect, prepareVmStart, vcExecuteVmStart | vSphere connect, prepare and start power on operation. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn | agentStart | Time for machine start, OS to boot and agent to startup. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn | agentReady | Time between agent startup completion and agent ready to accept connections. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn | brokerStartVmPostOp | Post processing after agent ready and broker continues on. |\n| broker \\ brokerLaunch{-id} | raiseTunnel | Instruct Security Server to prepare a tunnel connection. |\n| broker \\ brokerLaunch{-id} | sessionScript | Run broker session script. |\n| broker \\ brokerLaunch{-id} | machinePrepare | Once a VM is selected the broker contacts the VM agent to prepare it for an incoming connection. |\n| broker \\ brokerLaunch{-id} \\ machinePrepare | agentPrepare | Timing taken on the agent and prepare the VM for incoming connection. |\n| broker \\ brokerLaunch{-id} \\ machinePrepare \\ agentPrepare | userScript | Time taken to run user defined script. |\n| broker \\ brokerLaunch{-id} \\ machinePrepare \\ agentPrepare | protocolStartup | Time taken to startup the protocol; PCoIP, Blast or RDP. |\n| root | agent | Total time spent on agent to process a launch/reconnect. |\n| agent | clientConnectWait | The time between agentPrepare completing and View Client connecting. At this point the client has opened a socket, and authenticated to the Windows machine. |\n| agent | clientLogon | Time taken to create a Windows session. |\n| agent \\ clientLogon | userProfile | Time Windows user profile processing. |\n| agent \\ clientLogon \\ userProfile | profileSync | In the case of roaming profile this is the time Windows takes to download user profile. |\n| agent \\ clientLogon \\ userProfile | hiveLoad | Time Windows takes to load user registry hive. |\n| agent \\ clientLogon | userGpo | Windows Group Policy processing. |\n| agent \\ clientLogon | shellLoad | How long does it take to load the Windows shell (i.e. explorer.exe). |\n| agent | appLaunch | For RDSH this times application launching. This only times how long it takes to start the process, not when the application is initialized and functioning. |\n","operationId":"getLogonSegmentInfoV2","parameters":[{"description":"Internal session id, also applicable for global sessions.","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A=","in":"query","name":"internal_session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/LogonSegmentInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the session timing data.","tags":["Help Desk"]}},"/helpdesk/v2/performance/display-protocol":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getDisplayProtocolPerformanceInfoV2","parameters":[{"description":"Internal session id, also applicable for global sessions.","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A=","in":"query","name":"internal_session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DisplayProtocolPerformanceInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves performance data of the current session display protocol (PCoIP or BLAST).","tags":["Help Desk"]}},"/helpdesk/v2/performance/historical-data":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listHistoricalPerformanceInfoV2","parameters":[{"description":"Internal session id, also applicable for global sessions.","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A=","in":"query","name":"internal_session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HistoricalPerformanceInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves historical performance data for the specific session in latest 15 minutes.","tags":["Help Desk"]}},"/helpdesk/v2/performance/process":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listProcessPerformanceInfoV2","parameters":[{"description":"Internal session id, also applicable for global sessions.","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A=","in":"query","name":"internal_session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}},{"description":"Filter process by process session info.","in":"query","name":"process_filter","required":false,"schema":{"type":"string","enum":["CURRENT_USER_SESSION","SYSTEM_AND_CURRENT_USER_SESSION"]}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProcessPerformanceInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the process information.","tags":["Help Desk"]}},"/helpdesk/v2/performance/remote-application":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listRemoteApplicationPerformanceInfoV2","parameters":[{"description":"Internal session id, also applicable for global sessions.","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A=","in":"query","name":"internal_session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RemoteApplicationPerformanceInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the remote applications information.","tags":["Help Desk"]}},"/helpdesk/v2/remote-assistant-ticket":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| REMOTE_ASSISTANCE | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_MANAGE | Caller should have permission to this privilege, to perform this operation. |","operationId":"getRemoteAssistantTicketInfoV2","parameters":[{"description":"Internal session id, also applicable for global sessions.","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A=","in":"query","name":"internal_session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RemoteAssistantTicketInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get a Microsoft Remote Assistance ticket by session Id.","tags":["Help Desk"]}},"/helpdesk/v3/logon-timing/logon-segment":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |\n### Please note:\n1. Timings are taken on different machines where the wall clock times on each computer may not match.\n2. Breakdowns that are not applicable will not be present or have a duration of -1.\n3. The nodes' duration is not necessarily the sum of its breakdown timings. The unaccounted field is the difference between the sum(breakdown.duration) and the nodes duration.\n### Timing tree breakdowns\n\n| **Parent**    | **Breakdown**    | **Description** |\n|-----------|-------------|-------------|\n| root      | broker       | Total time spent on broker processing XML request. |\n| broker    | authentication | Time spent checking that client is still authenticated. This is normally not present because the duration is zero. |\n| broker    | existingSessionSearch | CPA only. Broker handling client request synchronously tries other brokers in pod until request is handled. |\n| broker    | brokerLaunch{-id} | Parent breakdown for various launch/reconnect activities. When CPA is enabled the {-id} is present and multiple brokerLaunch breakdowns can be present. Only one broker will successfully handle the launch/reconnect, the other entries are time taken probing brokers that can not fulfil the request. |\n| broker \\ brokerLaunch{-id} | machineSelection | Search for best matching VM that can fulfil the launch/reconnect. |\n| broker \\ brokerLaunch{-id} \\ machineSelection | machinePowerOn | Total time taken to startup a VM. This includes booting the OS, or resuming a suspended machine, and View agent signally it's ready for a connection. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn | brokerStartVmOp | Time taken to instruct vSphere to perform the power on operation. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn \\ brokerStartVmOp | vcConnect, prepareVmStart, vcExecuteVmStart | vSphere connect, prepare and start power on operation. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn | agentStart | Time for machine start, OS to boot and agent to startup. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn | agentReady | Time between agent startup completion and agent ready to accept connections. |\n| broker \\ brokerLaunch{-id} \\ machineSelection \\ machinePowerOn | brokerStartVmPostOp | Post processing after agent ready and broker continues on. |\n| broker \\ brokerLaunch{-id} | raiseTunnel | Instruct Security Server to prepare a tunnel connection. |\n| broker \\ brokerLaunch{-id} | sessionScript | Run broker session script. |\n| broker \\ brokerLaunch{-id} | machinePrepare | Once a VM is selected the broker contacts the VM agent to prepare it for an incoming connection. |\n| broker \\ brokerLaunch{-id} \\ machinePrepare | agentPrepare | Timing taken on the agent and prepare the VM for incoming connection. |\n| broker \\ brokerLaunch{-id} \\ machinePrepare \\ agentPrepare | userScript | Time taken to run user defined script. |\n| broker \\ brokerLaunch{-id} \\ machinePrepare \\ agentPrepare | protocolStartup | Time taken to startup the protocol; PCoIP, Blast or RDP. |\n| root | agent | Total time spent on agent to process a launch/reconnect. |\n| agent | clientConnectWait | The time between agentPrepare completing and View Client connecting. At this point the client has opened a socket, and authenticated to the Windows machine. |\n| agent | clientLogon | Time taken to create a Windows session. |\n| agent \\ clientLogon | userProfile | Time Windows user profile processing. |\n| agent \\ clientLogon \\ userProfile | profileSync | In the case of roaming profile this is the time Windows takes to download user profile. |\n| agent \\ clientLogon \\ userProfile | hiveLoad | Time Windows takes to load user registry hive. |\n| agent \\ clientLogon | userGpo | Windows Group Policy processing. |\n| agent \\ clientLogon | shellLoad | How long does it take to load the Windows shell (i.e. explorer.exe). |\n| agent | appLaunch | For RDSH this times application launching. This only times how long it takes to start the process, not when the application is initialized and functioning. |\n","operationId":"getLogonSegmentInfoV3","parameters":[{"description":"Internal session id, also applicable for global sessions.","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A=","in":"query","name":"internal_session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves the session timing data.","tags":["Help Desk"]}},"/helpdesk/v3/performance/display-protocol":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getDisplayProtocolPerformanceInfoV3","parameters":[{"description":"Internal session id, also applicable for global sessions.","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A=","in":"query","name":"internal_session_id","required":true,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session. Applicable for global sessions only","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DisplayProtocolPerformanceInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves performance data of the current session display protocol (PCoIP or BLAST).","tags":["Help Desk"]}},"/inventory/v1/agent-installer-packages":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listAgentInstallerPackages","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentInstallerPackageInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists agent installer packages.","tags":["Inventory"]}},"/inventory/v1/agent-installer-packages/action/register":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| INVENTORY_ADMINISTRATOR | Caller should have permission to this privilege, to perform this operation. |","operationId":"registerAgentInstallerPackage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentInstallerPackageRegisterSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentInstallerPackageRegisterResponseInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Registers an agent installer package.","tags":["Inventory"]}},"/inventory/v1/agent-installer-packages/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getAgentInstallerPackage","parameters":[{"description":"Id of agent installer package","example":"8fdefa82-17e4-4367-b5b1-8d97e4fd5e56","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentInstallerPackageInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves an agent installer package.","tags":["Inventory"]}},"/inventory/v1/agent-installer-packages/{id}/action/unregister":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| INVENTORY_ADMINISTRATOR | Caller should have permission to this privilege, to perform this operation. |","operationId":"unregisterAgentInstallerPackage","parameters":[{"description":"Id of agent installer package to be unregistered","example":"8fdefa82-17e4-4367-b5b1-8d97e4fd5e56","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Unregisters an agent installer package.","tags":["Inventory"]}},"/inventory/v1/application-icons":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the application pool.<br>Caller should have permission to this privilege, on the associated  access group, to read the application pool IDs field of an application icon. Else, it will be unset.|","operationId":"listApplicationIcons","parameters":[{"description":"Application Pool ID","in":"query","name":"application_pool_id","required":true,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationIconInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the application icons for the given application pool.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission, on any access group, to this privilege to create the Icon. |","operationId":"createApplicationIcon","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationIconCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates an application icon.","tags":["Inventory"]}},"/inventory/v1/application-icons/custom-icons":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the application pool.<br>Caller should have permission to this privilege, on the associated  access group, to read the application pool IDs field of an application icon. Else, it will be unset.|","operationId":"listCustomApplicationIcons","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationIconInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the custom application icons.","tags":["Inventory"]}},"/inventory/v1/application-icons/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission, on any access group, to this privilege to delete the Icon. |","operationId":"deleteApplicationIcon","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes customized application icon.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on any access group, to read the application icon.<br>Caller should have permission to this privilege, on the associated  access group, to read the application pool IDs field of an application icon. Else, it will be unset.|","operationId":"getApplicationIcon","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationIconInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets application icon.","tags":["Inventory"]}},"/inventory/v1/application-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those application pools, for which caller has permission to this privilege, on the associated access group of the application pool. |","operationId":"listApplicationPools","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationPoolInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the application pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of desktop pool or farm, to create the application pool. |","operationId":"createApplicationPool","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates an application pool.","tags":["Inventory"]}},"/inventory/v1/application-pools/action/associate":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group, to associate an Icon with the local application pool. |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federation access group, to associate an Icon with the application pool if it has Global Application Entitlement. |","operationId":"applicationIconBulkAssociate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationIconBulkAssociateSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Associates a custom icon to given list of application pools.","tags":["Inventory"]}},"/inventory/v1/application-pools/action/check-name-availability":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on any access group, to perform this operation. |","operationId":"checkApplicationPoolNameAvailability","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameAvailabilitySpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/NameAvailabilityInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Checks if the given name is available for application pool creation.","tags":["Inventory"]}},"/inventory/v1/application-pools/action/disable":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_ENABLE | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"disableApplicationPools","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of application pool ids to be disabled.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Disables the given list of application pool ids.","tags":["Inventory"]}},"/inventory/v1/application-pools/action/enable":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_ENABLE | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"enableApplicationPools","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of application pool ids to be enabled.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Enables the given list of application pool ids.","tags":["Inventory"]}},"/inventory/v1/application-pools/action/migrate":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to migrate the application pool. |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege,on the associated access group of session's pool or farm. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"migrateApplicationPools","parameters":[{"description":"ID of target farm to which applications needs to be migrated","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","in":"query","name":"target_farm_id","required":true,"schema":{"type":"string"}},{"description":"ID of source farm if all applications of farm needs to be migrated. Note: Either source_farm_id or request body list of application pool ids must be set.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","in":"query","name":"source_farm_id","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of application pool ids to be migrated. Note: Either source_farm_id or request body list of application pool ids must be set.","items":{"type":"string"}}}}},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Migrates the list of application pools to another farm","tags":["Inventory"]}},"/inventory/v1/application-pools/action/remove-association":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group, to remove an Icon from the local application pool. |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federation access group, to remove an Icon from the application pool if it has Global Application Entitlement. |","operationId":"applicationIconBulkRemoveAssociation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationIconRemoveAssociationSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Removes custom icon association from given list of application pools.","tags":["Inventory"]}},"/inventory/v1/application-pools/action/update-allowed-access-path":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"updateAllowedAccessPathAppPools","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAllowedAccessPathSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates allowed access path for the given list of application pool ids.","tags":["Inventory"]}},"/inventory/v1/application-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to delete the application pool. |","operationId":"deleteApplicationPool","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes application pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"getApplicationPool","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationPoolInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets application pool.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"updateApplicationPool","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates application pool.","tags":["Inventory"]}},"/inventory/v1/application-pools/{id}/action/add-custom-icon":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group, to associate an Icon with the local application pool. |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federation access group, to associate an Icon with the application pool if it has Global Application Entitlement. |","operationId":"addCustomIcon","parameters":[{"description":"Application pool ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationIconAssociateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Associates a custom icon to the application pool.","tags":["Inventory"]}},"/inventory/v1/application-pools/{id}/action/remove-custom-icon":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group, to remove an Icon from the local application pool. |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federation access group, to remove an Icon from the application pool if it has Global Application Entitlement. |","operationId":"removeCustomIcon","parameters":[{"description":"Application pool ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created"},"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Removes the associated custom icon from the application pool.","tags":["Inventory"]}},"/inventory/v1/category-folders":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group to read category folder.<br>|\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read category folder.<br>. |","operationId":"listCategoryFolders","responses":{"200":{"content":{"*/*":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the category folders.","tags":["Inventory"]}},"/inventory/v1/cp-desktop-pools":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |","operationId":"listCPDesktopPools","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CPDesktopPoolInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the capacity provider Desktop Pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"createCPDesktopPool","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPDesktopPoolCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a capacity provider desktop pool.","tags":["Inventory"]}},"/inventory/v1/cp-desktop-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"deleteCPDesktopPool","parameters":[{"description":"Whether or not we want to check if sessions associated to the desktop pool exists. Default value is false","example":true,"in":"query","name":"enforce_associated_session_check","required":false,"schema":{"type":"boolean"}},{"description":"ID of the desktop pool to be deleted.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolDeleteSpec"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a capacity provider desktop pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"getCPDesktopPool","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CPDesktopPoolInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the capacity provider Desktop Pool information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.<br> To update the access group for the desktop pool, caller should also have permission to this privilege on the access group to which desktop pool will be associated after update.|","operationId":"updateCPDesktopPool","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPDesktopPoolUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates capacity provider desktop pool.","tags":["Inventory"]}},"/inventory/v1/cp-desktop-pools/{id}/action/cancel-scheduled-push-image":{"post":{"description":"Note: The current operation of the desktop pool must be SCHEDULE_PUSH_IMAGE and cancel action must be called prior to the start time of the schedule push image operation. This operation is  applicable for instant/linked clone desktop pools only.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.","operationId":"cancelCpScheduledPushImage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Request the cancellation of the current scheduled push image operation or cancellation of promoted secondary image on the specified instant/linked clone desktop pool.","tags":["Inventory"]}},"/inventory/v1/cp-desktop-pools/{id}/action/promote-pending-image":{"post":{"description":"Note: This API can be called only if there is a pending image in a ready held state. This image is then applied to all the vms in the pool. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.","operationId":"cpDesktopPoolPromotePendingImage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Promotes pending image to current image in the desktop pool.","tags":["Inventory"]}},"/inventory/v1/cp-desktop-pools/{id}/action/schedule-push-image":{"post":{"description":"Request an update of the image in an automated desktop pool. This marks the old image to be replaced by new image, which is performed asynchronously. Once the new image is successfully updated, all eligible machines in desktop pool would also be marked for update with new image, this operation is also performed asynchronously.<br>To schedule the request, there should not be any operation on the desktop pool currently.<br>If the current operation of the desktop pool is 'SCHEDULE_PUSH_IMAGE' and schedule has not triggered yet, use this API to reschedule an existing scheduled push image operation. In case of reschedule, other than start time all the parameters of the API should be identical to previous call to this API for the desktop pool.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.","operationId":"scheduleCpPushImage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPDesktopPoolPushImageSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Schedule/reschedule a request to update the image in an automated desktop pool.","tags":["Inventory"]}},"/inventory/v1/cp-farms":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listCpFarms","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CPFarmInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Farms in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"createCpFarm","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPFarmCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a farm.","tags":["Inventory"]}},"/inventory/v1/cp-farms/action/disable":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_ENABLE | Caller should have permission to this privilege, on the associated access group of the farms. |","operationId":"disableFarms","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of farm ids to be disabled.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Disables the given list of farm ids.","tags":["Inventory"]}},"/inventory/v1/cp-farms/action/disable-provisioning":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm.","operationId":"disableFarmProvisioning","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of farm ids for which provisioning should be disabled.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Disables provisioning for the given list of farm ids.","tags":["Inventory"]}},"/inventory/v1/cp-farms/action/enable":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_ENABLE | Caller should have permission to this privilege, on the associated access group of the farms. |","operationId":"enableFarms","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of farm ids to be enabled.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Enables the given list of farm ids.","tags":["Inventory"]}},"/inventory/v1/cp-farms/action/enable-provisioning":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm.","operationId":"enableFarmProvisioning","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of farm ids for which provisioning should be enabled.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Enables provisioning for the given list of farm ids.","tags":["Inventory"]}},"/inventory/v1/cp-farms/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"deleteCpFarm","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a farm.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getCpFarm","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CPFarmInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Farm information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm.<br> To update the access group for the farm, caller should also have permission to this privilege on the access group to which farm will be associated after update. |","operationId":"updateCpFarm","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPFarmUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates farm.","tags":["Inventory"]}},"/inventory/v1/cp-farms/{id}/action/apply-image":{"post":{"description":"Pending image can only be applied if it is in READY_HELD state.\n\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"cpFarmApplyImage","parameters":[{"description":"Farm ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Indicates whether the pending image is to be applied. If false, the current image will be applied.","in":"query","name":"pending_image","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"RDS servers on which the image is to be applied.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Applies the pending image or the current image to selected RDS servers in the farm.","tags":["Inventory"]}},"/inventory/v1/cp-farms/{id}/action/cancel-scheduled-maintenance":{"post":{"description":"Note: The current operation of the farm must be RECURRING_SCHEDULED_MAINTENANCE and this will stop further maintenance operation execution. If a pending image was specified as part of recurring or immediate maintenance it will also be cancelled. If the image has already been published then it will not be cancelled and will remain as the current image for this farm.\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"cancelCpFarmScheduledMaintenance","parameters":[{"description":"Farm ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmCancelMaintenanceSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Requests cancellation of the current scheduled maintenance on the specified farm.","tags":["Inventory"]}},"/inventory/v1/cp-farms/{id}/action/promote-pending-image":{"post":{"description":"Note: This API can be called only if there is a pending image in a ready held state. This image is then applied to all the rds servers in the farm. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"cpFarmPromotePendingImage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Promotes pending image to current image in the farm.","tags":["Inventory"]}},"/inventory/v1/cp-farms/{id}/action/schedule-maintenance":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"scheduleCpFarmMaintenance","parameters":[{"description":"Farm ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPFarmMaintenanceSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates maintenance schedule for the specified farm.","tags":["Inventory"]}},"/inventory/v1/desktop-pools":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |","operationId":"listDesktopPools","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Desktop Pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"createDesktopPool","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/action/check-name-availability":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on any access group, to perform this operation. |","operationId":"checkDesktopPoolNameAvailability","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameAvailabilitySpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/NameAvailabilityInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Checks if the given name is available for desktop pool creation.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/action/disable":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_ENABLE | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"disableDesktopPools","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of desktop pool ids to be disabled.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Disables the given list of desktop pool ids.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/action/disable-provisioning":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.","operationId":"disableProvisioningForDesktopPools","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of desktop pool ids for which provisioning is to be disabled.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Disables provisioning for the given list of desktop pool ids.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/action/enable":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_ENABLE | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"enableDesktopPools","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of desktop pool ids to be enabled.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Enables the given list of desktop pool ids.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/action/enable-provisioning":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.","operationId":"enableProvisioningForDesktopPools","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of desktop pool ids for which provisioning is to be enabled.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Enables provisioning for the given list of desktop pool ids.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/action/update-allowed-access-path":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"updateAllowedAccessPathForDesktopPools","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAllowedAccessPathSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Update allowed access path for the given list of desktop pool ids.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/action/validate-specified-names":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"validateSpecifiedNames","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpecifiedNamesValidationSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SpecifiedNamesValidationInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Validates manually specified virtual machines. Ensures machine and user names are valid and aren't duplicated in the given desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/policies/overrides":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\nCaller should have permission to this privilege, on the associated access group of the desktop pool.","operationId":"listUserPoliciesOverrides","parameters":[{"description":"Indicates the desktop pool id. If not provided, fetches overrides for all users on all pools.","in":"query","name":"desktop_pool_id","required":false,"schema":{"type":"string"}},{"description":"Indicates whether to fetch unentitled policies. If set to true, fetches unentitled policies for all users.","in":"query","name":"unentitled_policies","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserPoliciesInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns policy overrides for entitled or unentitled users.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"deleteDesktopPool","parameters":[{"description":"Whether or not we want to check if sessions associated to the desktop pool exists. Default value is false","example":true,"in":"query","name":"enforce_associated_session_check","required":false,"schema":{"type":"boolean"}},{"description":"ID of the desktop pool to be deleted.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolDeleteSpec"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a desktop pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"getDesktopPool","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Desktop Pool information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.<br> To update the access group for the desktop pool, caller should also have permission to this privilege on the access group to which desktop pool will be associated after update.|","operationId":"updateDesktopPool","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/action/add-machines":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"addMachines","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of Machine Ids representing the machines to be added to the desktop pool.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Adds machines to the given manual desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/action/add-machines-by-name":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"addMachinesByName","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of MachineSpecifiedName representing the machines to be added to the desktop pool.","items":{"$ref":"#/components/schemas/MachineSpecifiedName"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Adds the named machines to the given desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/action/apply-image":{"post":{"description":"Pending image can only be applied if it is in READY_HELD state.\n\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"desktopPoolApplyImage","parameters":[{"description":"Desktop pool ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Indicates whether the pending image is to be applied. If false, the current image will be applied.","in":"query","name":"pending_image","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Machines on which the image is to be applied.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Applies the pending image or the current image to selected machines in the desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/action/cancel-scheduled-push-image":{"post":{"description":"Note: The current operation of the desktop pool must be SCHEDULE_PUSH_IMAGE and cancel action must be called prior to the start time of the schedule push image operation. This operation is  applicable for instant clone desktop pools only.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"cancelScheduledPushImage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Request the cancellation of the current scheduled push image operation on the specified instant clone desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/action/promote-pending-image":{"post":{"description":"Note: This API can be called only if there is a pending image in a ready held state. This image is then applied to all the vms in the pool. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"desktopPoolPromotePendingImage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Promotes pending image to current image in the desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/action/remove-machines":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the machine. |","operationId":"removeMachines","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of Machine Ids representing the machines to be removed from the desktop pool.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Removes machines from the given manual desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/action/schedule-push-image":{"post":{"description":"Request an update of the image in an instant clone desktop pool. This marks the old image to be replaced by new image, which is performed asynchronously. Once the new image is successfully updated, all eligible machines in desktop pool would also be marked for update with new image, this operation is also performed asynchronously.<br>To schedule the request, there should not be any operation on the desktop pool currently.<br>If the current operation of the desktop pool is 'SCHEDULE_PUSH_IMAGE' and schedule has not triggered yet, use this API to reschedule an existing scheduled push image operation. In case of reschedule, other than start time all the parameters of the API should be identical to previous call to this API for the desktop pool.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"schedulePushImage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolPushImageSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Schedule/reschedule a request to update the image in an instant clone desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/action/validate-installed-applications":{"post":{"description":"Note: This operation is not applicable for RDS desktop pools.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"validateInstalledApplicationsOnDesktopPool","parameters":[{"description":"Desktop Pool ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of application exe paths for the applications to be validated.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InstalledApplicationValidationInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InstalledApplicationValidationInfo"}}}},"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Validates that each application in the given list is installed on the machines belonging to the specified desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/installed-applications":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"listInstalledApplicationsOnDesktopPool","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InstalledApplicationInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the installed applications on the given desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/policies":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\nCaller should have permission to this privilege, on the associated access group of the desktop pool.","operationId":"listPoliciesOnDesktopPool","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResourcePoliciesInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns the policies on the given desktop pool.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"updatesPoliciesOnDesktopPool","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoliciesSettingsUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the policies on the given desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/policies/overrides":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"DeletePolicyOverridesForUsers","parameters":[{"description":"Desktop pool ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of user SIDs.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes policies overrides for users on the given desktop pool.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"createPolicyOverridesForUsers","parameters":[{"description":"Desktop pool ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of user policies specs.","items":{"$ref":"#/components/schemas/UserPoliciesSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates policies overrides for users on the given desktop pool.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"updatePolicyOverridesForUsers","parameters":[{"description":"Desktop pool ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of user policies update specs.","items":{"$ref":"#/components/schemas/UserPoliciesUpdateSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates policies overrides for users on the given desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/tasks":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"listDesktopPoolTasks","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolTaskInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the tasks on the desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/tasks/{taskId}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"getDesktopPoolTask","parameters":[{"description":"Desktop pool ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Desktop pool task ID","in":"path","name":"taskId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolTaskInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the task information on the desktop pool.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/tasks/{taskId}/action/cancel":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"cancelDesktopPoolTask","parameters":[{"description":"Desktop pool ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Desktop pool task ID","in":"path","name":"taskId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Cancels the instant clone desktop pool push image task.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/tasks/{taskId}/action/pause":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"pauseDesktopPoolTask","parameters":[{"description":"Desktop pool ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Desktop pool task ID","in":"path","name":"taskId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Pause the instant clone desktop pool push image task.","tags":["Inventory"]}},"/inventory/v1/desktop-pools/{id}/tasks/{taskId}/action/resume":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"resumeDesktopPoolTask","parameters":[{"description":"Desktop pool ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Desktop pool task ID","in":"path","name":"taskId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResumeTaskSpec"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Resume the instant clone desktop pool push image task.","tags":["Inventory"]}},"/inventory/v1/farms":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listFarms","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FarmInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Farms in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"createFarm","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a farm.","tags":["Inventory"]}},"/inventory/v1/farms/action/check-name-availability":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on any access group, to perform this operation. |","operationId":"checkFarmNameAvailability","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameAvailabilitySpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/NameAvailabilityInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Checks if the given name is available for farm creation.","tags":["Inventory"]}},"/inventory/v1/farms/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"deleteFarm","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a farm.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getFarm","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FarmInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Farm information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm.<br> To update the access group for the farm, caller should also have permission to this privilege on the access group to which farm will be associated after update. |","operationId":"updateFarm","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates farm.","tags":["Inventory"]}},"/inventory/v1/farms/{id}/action/add-rds-servers":{"post":{"description":"Note: This operation is only applicable for manual farms.\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"addRdsServers","parameters":[{"description":"Farm ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of RDS server IDs representing the RDS servers to be added to the farm.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Add RDS servers to the specified manual farm.","tags":["Inventory"]}},"/inventory/v1/farms/{id}/action/apply-image":{"post":{"description":"Pending image can only be applied if it is in READY_HELD state.\n\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"farmApplyImage","parameters":[{"description":"Farm ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Indicates whether the pending image is to be applied. If false, the current image will be applied.","in":"query","name":"pending_image","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"RDS servers on which the image is to be applied.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Applies the pending image or the current image to selected RDS servers in the farm.","tags":["Inventory"]}},"/inventory/v1/farms/{id}/action/cancel-scheduled-maintenance":{"post":{"description":"Note: This operation is applicable only to Instant clone farms.The current operation of the farm must be RECURRING_SCHEDULED_MAINTENANCE and this will stop further maintenance operation execution. If a pending image was specified as part of recurring or immediate maintenance it will also be cancelled. If the image has already been published then it will not be cancelled and will remain as the current image for this farm.\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"cancelScheduledMaintenance","parameters":[{"description":"Farm ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmCancelMaintenanceSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Requests cancellation of the current scheduled maintenance on the specified Instant Clone farm.","tags":["Inventory"]}},"/inventory/v1/farms/{id}/action/promote-pending-image":{"post":{"description":"Note: This API can be called only if there is a pending image in a ready held state. This image is then applied to all the rds servers in the farm. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"farmPromotePendingImage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Promotes pending image to current image in the farm.","tags":["Inventory"]}},"/inventory/v1/farms/{id}/action/remove-rds-servers":{"post":{"description":"Note: For an automated farm, removing a RDS server deletes it from disk whereas for a manual farm only the association with RDS server is removed. \n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"removeRdsServers","parameters":[{"description":"Farm ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of RDS server IDs representing the RDS servers to be removed from the farm.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Remove RDS servers from the specified farm.","tags":["Inventory"]}},"/inventory/v1/farms/{id}/action/schedule-maintenance":{"post":{"description":"Note: This operation is applicable only to Instant clone farms. This can be used for creating both immediate or recurring maintenance. At most one schedule of both the types can co-exist at same time. Optionally user can request an update of the Image in the specified farm. This marks the old image to be replaced by new image, which is performed asynchronously. Once the new image is successfully updated, all eligible RDS servers in the farm would also be marked for update with new image, this operation is also performed asynchronously. This operation can also be used to replace an existing scheduled maintenance. Immediate maintenance will take priority over any existing scheduled recurring maintenance. Recurring maintenance for this farm will be put on hold until immediate maintenance has completed. \n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"scheduleMaintenance","parameters":[{"description":"Farm ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmMaintenanceSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates maintenance schedule for the specified farm.","tags":["Inventory"]}},"/inventory/v1/farms/{id}/action/validate-installed-applications":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"validateInstalledApplicationsOnFarm","parameters":[{"description":"Farm ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of application exe paths for the applications to be validated.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InstalledApplicationValidationInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Validates that each application in the given list is installed on the RDS Servers belonging to the specified Farm.","tags":["Inventory"]}},"/inventory/v1/farms/{id}/app-volumes-applications":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"listAppVolumesApplicationsOnFarm","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppVolumesApplicationInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the App Volumes applications on the given farm.","tags":["Inventory"]}},"/inventory/v1/farms/{id}/installed-applications":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"listInstalledApplicationsOnFarm","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InstalledApplicationInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the installed applications on the given farm.","tags":["Inventory"]}},"/inventory/v1/global-application-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"listGlobalApplicationEntitlements","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalApplicationEntitlementSummary"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Application Entitlements in the environment.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"createGlobalApplicationEntitlement","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v1/global-application-entitlements/{id}":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"deleteGlobalApplicationEntitlement","parameters":[{"description":"Global Application Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Global Application Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"getGlobalApplicationEntitlement","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Application Entitlement in the environment.","tags":["Inventory"]},"put":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"updateGlobalApplicationEntitlement","parameters":[{"description":"Global Application Entitlement object to be updated","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v1/global-application-entitlements/{id}/compatible-backup-global-application-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"listCompatibleBackupGAEs","parameters":[{"description":"Global Application Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Application Entitlements that can be associated as backup Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v1/global-application-entitlements/{id}/compatible-local-application-pools":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n| POOL_VIEW | Caller should have permission to this privilege with the corresponding access group to read a application pool and Farm/Desktop information.\n","operationId":"listCompatibleLocalApplicationPools","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists Local Application Pools which are compatible with Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v1/global-application-entitlements/{id}/local-application-pools":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n| POOL_VIEW | Caller should have permission to this privilege with the corresponding access group to read a application pool and Farm/Desktop information.\n","operationId":"removeLocalApplicationPoolsFromGAE","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of local application pool ids to be removed.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Removes Local Application Pools from Global Application Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n| POOL_VIEW | Caller should have permission to this privilege with the corresponding access group to read a application pool and Farm/Desktop information.\n","operationId":"listLocalApplicationPools","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists Local Application Pools which are assigned to Global Application Entitlement.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n| POOL_VIEW | Caller should have permission to this privilege with the corresponding access group to read a application pool and Farm/Desktop information.\n","operationId":"addLocalApplicationPoolsToGAE","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of local application pool ids to be added.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Adds Local Application Pools to Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v1/global-desktop-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"listGlobalDesktopEntitlements","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalDesktopEntitlementSummary"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Desktop Entitlements in the environment.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the root federated access group to manage the global desktop entitlement.\n","operationId":"createGlobalDesktopEntitlement","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v1/global-desktop-entitlements/{id}":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"deleteGlobalDesktopEntitlement","parameters":[{"description":"Global Desktop Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Global Desktop Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"getGlobalDesktopEntitlement","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Desktop Entitlement in the environment.","tags":["Inventory"]},"put":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"updateGlobalDesktopEntitlement","parameters":[{"description":"Global Desktop Entitlement object to be updated","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v1/global-desktop-entitlements/{id}/compatible-backup-global-desktop-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"listCompatibleBackupGDEs","parameters":[{"description":"Global Desktop Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Desktop Entitlements that can be associated as backup Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v1/global-desktop-entitlements/{id}/compatible-local-desktop-pools":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n| POOL_VIEW | Caller should have permission to this privilege with the corresponding access group to read a desktop pool information.\n","operationId":"listCompatibleLocalDesktopPools","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists Local Desktop Pools which are compatible with Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v1/global-desktop-entitlements/{id}/local-desktop-pools":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n| POOL_VIEW | Caller should have permission to this privilege with the corresponding access group to read a desktop pool information.\n","operationId":"removeLocalDesktopPoolsFromGDE","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of local desktop pool ids to be removed.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Removes Local Desktop Pools from Global Desktop Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n| POOL_VIEW | Caller should have permission to this privilege with the corresponding access group to read a desktop pool information.\n","operationId":"listLocalDesktopPools","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists Local Desktop Pools which are assigned to Global Desktop Entitlement.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n| POOL_VIEW | Caller should have permission to this privilege with the corresponding access group to read a desktop pool information.\n","operationId":"addLocalDesktopPoolsToGDE","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of local desktop pool ids to be added.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Adds Local Desktop Pools to Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v1/global-sessions":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br><br>Exactly one of user_id, pod_id and brokering_pod_id must be set to non-null value.<br><br>This API supports <b>Pagination</b>.<br/><br>At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"queryGlobalSessions","parameters":[{"description":"SID of the user.","example":"S-1-5-21-1111111111-2222222222-3333333333-500","in":"query","name":"user_id","required":false,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session.","example":"96d708fe-badb-40f8-9b80-9029b0ab2ef2","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}},{"description":"ID of the pod that brokered the session.","example":"806ca35f-bcab-4a42-9006-04ba27cad900","in":"query","name":"brokering_pod_id","required":false,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalSessionInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists global sessions in the environment for the given user, pod or brokering pod.","tags":["Inventory"]}},"/inventory/v1/global-sessions/action/disconnect":{"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br><br>At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGE_VDI_SESSION | Caller should have permission to this privilege, on the associated access group of session's machine, to perform this operation. |\n| FEDERATED_SESSIONS_MANAGE | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement, to perform this operation. |","operationId":"disconnectGlobalSessions","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Sessions which are to be disconnected.","items":{"$ref":"#/components/schemas/GlobalSessionActionSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkGlobalSessionActionResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Disconnects global sessions in the environment.","tags":["Inventory"]}},"/inventory/v1/global-sessions/action/logoff":{"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br><br>At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGE_VDI_SESSION | Caller should have permission to this privilege, on the associated access group of session's machine, to perform this operation. |\n| FEDERATED_SESSIONS_MANAGE | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement, to perform this operation. |","operationId":"logOffGlobalSessions","parameters":[{"description":"Indicates whether sessions should be logged off forcibly. \nIf set to true, sessions would be logged off forcibly even if they are locked. \nIf set to false, sessions would be logged off if they are not locked. \n","example":true,"in":"query","name":"forced","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Sessions which are to be logged off.","items":{"$ref":"#/components/schemas/GlobalSessionActionSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkGlobalSessionActionResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Logs off global sessions in the environment.","tags":["Inventory"]}},"/inventory/v1/global-sessions/action/reset":{"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br><br>At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_REBOOT | Caller should have permission to this privilege, on the associated access group of session's machine, to perform this operation. |\n| FEDERATED_SESSIONS_MANAGE | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement, to perform this operation. |","operationId":"resetGlobalSessions","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Sessions which are to be reset.","items":{"$ref":"#/components/schemas/GlobalSessionActionSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkGlobalSessionActionResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Resets machines of global sessions in the environment.","tags":["Inventory"]}},"/inventory/v1/global-sessions/action/restart":{"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br><br>At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_REBOOT | Caller should have permission to this privilege, on the associated access group of session's machine, to perform this operation. |\n| FEDERATED_SESSIONS_MANAGE | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement, to perform this operation. |","operationId":"restartGlobalSessions","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Sessions which are to be restarted.","items":{"$ref":"#/components/schemas/GlobalSessionActionSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkGlobalSessionActionResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Restarts machines of global sessions in the environment.","tags":["Inventory"]}},"/inventory/v1/global-sessions/action/send-message":{"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br><br>At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGE_VDI_SESSION | Caller should have permission to this privilege, on the associated access group of session's machine, to perform this operation. |\n| FEDERATED_SESSIONS_MANAGE | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement, to perform this operation. |","operationId":"sendMessageToGlobalSessions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSessionSendMessageSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkGlobalSessionActionResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Sends message to global sessions in the environment.","tags":["Inventory"]}},"/inventory/v1/machines":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |","operationId":"deleteMachines","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineDeleteSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the specified machines.","tags":["Inventory"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those unmanaged (physical) machines, that are part of desktop pool, for which the caller needs permission to this privilege.|","operationId":"listMachines","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MachineInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Machines in the environment.","tags":["Inventory"]}},"/inventory/v1/machines/action/archive":{"post":{"description":"Each response entity in the result corresponds to a machine Id in the input. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FORENSICS | Caller should have permission to this privilege to archive machines. | \n| MACHINE_MANAGEMENT | Caller should have permission to this privilege on the associated machines to perform archival. |\n","operationId":"archiveMachines","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of Held Machine Ids which should be archived.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Initiates machine archival process","tags":["Inventory"]}},"/inventory/v1/machines/action/cancel-agent-upgrade":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MAINTENANCE | Caller should have permission to this privilege, to perform this operation. |","operationId":"cancelAgentUpgrades","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of task IDs to cancel the agent upgrade.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"cancel agent upgrades.","tags":["Inventory"]}},"/inventory/v1/machines/action/check-name-availability":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on any access group, to perform this operation. |","operationId":"checkMachinePrefixAvailability","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameAvailabilitySpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/NameAvailabilityInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Checks if the given prefix is available for machine creation.","tags":["Inventory"]}},"/inventory/v1/machines/action/enter-maintenance":{"post":{"description":"When in maintenance mode, users cannot access the machines. Each response entity in the result corresponds to a machine id in the input. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MAINTENANCE | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to perform maintenance operation. |\n| FORENSICS | Caller should have permission to this privilege to enforce operations on held machines. |","operationId":"enterMaintenance","parameters":[{"description":"Only Forensics admin can set this value.\n If passed as \"true\", then this action is applicable for both held and non held vms.\n If passed as \"false\", then this action is applicable for only non held vms.\n If not passed at all, then this action is applicable for only non held vms.","in":"query","name":"enforce","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of Machine Ids representing the machines to be put into maintenance mode.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Puts the machines into maintenance mode.","tags":["Inventory"]}},"/inventory/v1/machines/action/exit-maintenance":{"post":{"description":"Each response entity in the result corresponds to a machine id in the input.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MAINTENANCE | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to perform maintenance operation. |\n","operationId":"exitMaintenance","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of Machine Ids representing the machines to be put out of maintenance mode.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Puts the machines out of maintenance mode.","tags":["Inventory"]}},"/inventory/v1/machines/action/rebuild":{"post":{"description":"Each response entity in the result corresponds to a machine id in the input.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to perform rebuild operation. |\n","operationId":"rebuildMachines","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of Machine Ids representing the machines to be rebuilt.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Rebuilds the specified machines.","tags":["Inventory"]}},"/inventory/v1/machines/action/recover":{"post":{"description":"Each response entity in the result corresponds to a machine id in the input.\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to recover themachine. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to recover the machine. || FORENSICS | Caller should have permission to this privilege to enforce operations on held machines. |","operationId":"recoverMachines","parameters":[{"description":"Only Forensics admin can set this value.\n If passed as \"true\", then this action is applicable for both held and non held vms.\n If passed as \"false\", then this action is applicable for only non held vms.\n If not passed at all, then this action is applicable for only non held vms.","in":"query","name":"enforce","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of Machine Ids representing the machines to be recovered.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Recovers the specified machines.","tags":["Inventory"]}},"/inventory/v1/machines/action/recreate-from-persistent-disk":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| UDD_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of persistent disk and desktop pool to perform recreate operation. |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of desktop pool to perform recreate operation. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of desktop pool to perform recreate operation. |\n","operationId":"recreateFromPersistentDisk","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MachinePersistentDiskRecreateSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Recreates machines from the specified persistent disks.","tags":["Inventory"]}},"/inventory/v1/machines/action/reset":{"post":{"description":"Each response entity in the result corresponds to a machine id in the input.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_REBOOT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to perform reset operation. |\n| FORENSICS | Caller should have permission to this privilege to enforce operations on held machines. |","operationId":"resetMachines","parameters":[{"description":"Only Forensics admin can set this value.\n If passed as \"true\", then this action is applicable for both held and non held vms.\n If passed as \"false\", then this action is applicable for only non held vms.\n If not passed at all, then this action is applicable for only non held vms.","in":"query","name":"enforce","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of Machine Ids representing the machines to be reset.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Resets the specified machines.","tags":["Inventory"]}},"/inventory/v1/machines/action/restart":{"post":{"description":"Each response entity in the result corresponds to a machine id in the input.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_REBOOT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to perform restart operation. |\n| FORENSICS | Caller should have permission to this privilege to enforce operations on held machines. |","operationId":"restartMachines","parameters":[{"description":"Only Forensics admin can set this value.\n If passed as \"true\", then this action is applicable for both held and non held vms.\n If passed as \"false\", then this action is applicable for only non held vms.\n If not passed at all, then this action is applicable for only non held vms.","in":"query","name":"enforce","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"forceOperation":{"type":"boolean","description":"If passed as true, the operation will be forced on machines even with outstanding sessions"},"machineIds":{"uniqueItems":true,"type":"array","description":"List of Machine Ids representing the machines to be restarted.","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Restarts the specified machines.","tags":["Inventory"]}},"/inventory/v1/machines/action/schedule-agent-upgrade":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MAINTENANCE | Caller should have permission to this privilege, to perform this operation. |","operationId":"scheduleAgentForUpgrade","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineAgentUpgradeSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentUpgradeTaskResponseInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Schedule agents for upgrade.","tags":["Inventory"]}},"/inventory/v1/machines/action/set-golden-image":{"post":{"description":"Each response entity in the result corresponds to a machine Id in the input. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FORENSICS | Caller should have permission to this privilege to archive machines. | \n| MACHINE_MANAGEMENT | Caller should have permission to this privilege on the associated machines to perform archival. |\n","operationId":"setGoldenImage","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of Machine Ids which should be set as golden images.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Sets the given unmanaged machines as golden images","tags":["Inventory"]}},"/inventory/v1/machines/action/shutdown":{"post":{"description":"Each response entity in the result corresponds to a machine id in the input.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_SHUTDOWN | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to perform shutdown operation. |\n| FORENSICS | Caller should have permission to this privilege to enforce operations on held machines. |","operationId":"shutdownMachines","parameters":[{"description":"Only Forensics admin can set this value.\n If passed as \"true\", then this action is applicable for both held and non held vms.\n If passed as \"false\", then this action is applicable for only non held vms.\n If not passed at all, then this action is applicable for only non held vms.","in":"query","name":"enforce","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"forceOperation":{"type":"boolean","description":"If passed as true, the operation will be forced on machines even with outstanding sessions"},"machineIds":{"uniqueItems":true,"type":"array","description":"List of Machine Ids representing the machines to be shutdown.","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Shutdown the specified machines.","tags":["Inventory"]}},"/inventory/v1/machines/agent-upgrade-tasks":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listAgentUpgradeTasks","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentUpgradeTaskInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"List agent upgrade tasks information.","tags":["Inventory"]}},"/inventory/v1/machines/agent-upgrade-tasks/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getAgentUpgradeTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentUpgradeTaskInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get agent upgrade task information.","tags":["Inventory"]}},"/inventory/v1/machines/unentitled":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |","operationId":"listUnentitledMachines","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnentitledMachineInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the unentitled machines in the environment.","tags":["Inventory"]}},"/inventory/v1/machines/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |","operationId":"deleteMachine","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineDeleteData"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the machine.","tags":["Inventory"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the unmanaged (physical) machines that are part of desktop pool.|","operationId":"getMachine","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Machine information.","tags":["Inventory"]}},"/inventory/v1/machines/{id}/action/assign-aliases":{"post":{"description":"If the alias is already present it gets updated. Each response entity in the result corresponds to a user SID in the input. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_USER_MANAGEMENT | Caller should have permission to this privilege to assign machines aliases. | \n","operationId":"assignMachineAliases","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of MachineAlias. If a user is assigned to the machine we can set the corresponding aliases.","items":{"$ref":"#/components/schemas/MachineAliasSpec"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Assigns the specified aliases to the assigned users of the machine.","tags":["Inventory"]}},"/inventory/v1/machines/{id}/action/assign-users":{"post":{"description":"Each response entity in the result corresponds to a user SID in the input.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_USER_MANAGEMENT | Caller should have permission to this privilege to assign users to machine. | \n","operationId":"assignUsers","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of User SIDs representing the users to be assigned to the machine.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Assigns the specified users to the machine.","tags":["Inventory"]}},"/inventory/v1/machines/{id}/action/attach-persistent-disk":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| UDD_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of persistent disk and machine to perform attach operation. |\n","operationId":"attachPersistentDisk","parameters":[{"description":"ID of the machine","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachinePersistentDiskAttachSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Attaches the specified persistent disk to a machine.","tags":["Inventory"]}},"/inventory/v1/machines/{id}/action/detach-persistent-disk":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| UDD_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of persistent disk and machine to perform detach operation. |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine to perform detach operation if detaching a primary disk. |\n","operationId":"detachPersistentDisk","parameters":[{"description":"ID of the machine","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachinePersistentDiskDetachSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Detaches the specified persistent disk from a machine.","tags":["Inventory"]}},"/inventory/v1/machines/{id}/action/unassign-aliases":{"post":{"description":"Each response entity in the result corresponds to a user SID in the input. \nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_USER_MANAGEMENT | Caller should have permission to this privilege to unassign machines aliases. | \n","operationId":"unassignMachineAliases","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of User SIDs whose aliases will be un-assigned from the machine.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Un-assigns the aliases for the specified users from the machine.","tags":["Inventory"]}},"/inventory/v1/machines/{id}/action/unassign-users":{"post":{"description":"Deletes the aliases for the users if present. Each response entity in the result corresponds to a user SID in the input.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_USER_MANAGEMENT | Caller should have permission to this privilege to unassign users from machine. | \n","operationId":"unassignUsers","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of User SIDs representing the users to be un-assigned from the machine.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Un-assigns the specified users from the machine.","tags":["Inventory"]}},"/inventory/v1/persistent-disks":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| UDD_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listPersistentDisks","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersistentDiskInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists persistent disks.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| UDD_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"createPersistentDisk","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistentDiskCreateSpec"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a persistent disk.","tags":["Inventory"]}},"/inventory/v1/persistent-disks/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| UDD_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"deletePersistentDisk","parameters":[{"description":"ID of the persistent disk to be deleted.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes persistent disk.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| UDD_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getPersistentDisk","parameters":[{"description":"Id of persistent disk","example":"8fdefa82-17e4-4367-b5b1-8d97e4fd5e56","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersistentDiskInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about a persistent disk.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| UDD_MANAGEMENT | Caller should have permission to this privilege, to perform this operation. |","operationId":"updatePersistentDisk","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistentDiskUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates persistent disk.","tags":["Inventory"]}},"/inventory/v1/persistent-disks/{id}/attachable-machines":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| UDD_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| MACHINE_VIEW | Caller should have permission to this privilege, on any access group, to perform this operation. |","operationId":"listAttachableMachines","parameters":[{"description":"Id of persistent disk","example":"8fdefa82-17e4-4367-b5b1-8d97e4fd5e56","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Whether to filter incompatible machines","in":"query","name":"filter_incompatible_machines","required":false,"schema":{"type":"boolean","default":false}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersistentDiskMachineAttachmentInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists machines which can be attached to persistent disk.","tags":["Inventory"]}},"/inventory/v1/physical-machines":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view the physical machines.\n","operationId":"listPhysicalMachines","parameters":[{"description":"Whether the physical machine is associated with any pool or farm","in":"query","name":"in_use","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhysicalMachineInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Physical Machines in the environment.","tags":["Inventory"]}},"/inventory/v1/physical-machines/action/register":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_MACHINE_REGISTER | Caller should have permission to this privilege to register the physical machines.\n","operationId":"registerPhysicalMachine","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalMachineRegisterSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PhysicalMachineRegisterInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Registers the Physical Machine.","tags":["Inventory"]}},"/inventory/v1/physical-machines/action/set-golden-image":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n | Caller should have permission to this privilege to archive machines. | \n| MACHINE_MANAGEMENT | Caller should have permission to this privilege on the associated machines to perform this operation. |\n","operationId":"setMachineAsGoldenImage","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of Machine Ids which should be set as golden images.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Sets the given unmanaged machines as golden images","tags":["Inventory"]}},"/inventory/v1/physical-machines/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to delete the physical machines.\n","operationId":"deletePhysicalMachine","parameters":[{"description":"Physical machine ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the Physical Machine.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view the physical machines.\n","operationId":"getPhysicalMachine","parameters":[{"description":"Physical machine ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PhysicalMachineInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Physical Machine information.","tags":["Inventory"]}},"/inventory/v1/rds-servers":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those registered RDS Servers, that are part of farm, for which the caller needs permission to this privilege. |","operationId":"listRDSServers","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RDSServerInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the RDS Servers in the environment.","tags":["Inventory"]}},"/inventory/v1/rds-servers/action/cancel-agent-upgrade":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MAINTENANCE | Caller should have permission to this privilege, to perform this operation. |","operationId":"cancelRdsServerAgentUpgrades","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"Set of task IDs to cancel the agent upgrade.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"cancel agent upgrades.","tags":["Inventory"]}},"/inventory/v1/rds-servers/action/check-name-availability":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on any access group, to perform this operation. |","operationId":"checkRDSServerPrefixAvailability","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameAvailabilitySpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/NameAvailabilityInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Checks if the given prefix is available for RDS Server creation.","tags":["Inventory"]}},"/inventory/v1/rds-servers/action/recover":{"post":{"description":"Each response entity in the result corresponds to a RDS Server id in the input.\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n","operationId":"recoverRDSServers","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of RDS Server Ids representing the RDS Servers to be recovered.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Recovers the specified RDS Servers.","tags":["Inventory"]}},"/inventory/v1/rds-servers/action/register":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_MACHINE_REGISTER | Caller should have permission to this privilege to register the RDS Server.\n","operationId":"registerRDSServer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RDSServerRegisterSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerRegisterInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Registers the RDS Server.","tags":["Inventory"]}},"/inventory/v1/rds-servers/action/schedule-agent-upgrade":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MAINTENANCE | Caller should have permission to this privilege, to perform this operation. |","operationId":"scheduleAgentForUpgradeRdsServer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentUpgradeSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentUpgradeTaskResponseInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Schedule agents for upgrade.","tags":["Inventory"]}},"/inventory/v1/rds-servers/agent-upgrade-tasks":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listRdsServerAgentUpgradeTasks","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentUpgradeTaskInfoV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"List agent upgrade tasks information.","tags":["Inventory"]}},"/inventory/v1/rds-servers/agent-upgrade-tasks/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getRdsServerAgentUpgradeTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentUpgradeTaskInfoV2"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get agent upgrade task information.","tags":["Inventory"]}},"/inventory/v1/rds-servers/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"deleteRDSServer","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the RDS Server.","tags":["Inventory"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the registered RDS Server that is part of farm. |","operationId":"getRDSServer","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the RDS Server information.","tags":["Inventory"]},"put":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"updateRDSServer","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RDSServerUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the RDS Server.","tags":["Inventory"]}},"/inventory/v1/sessions":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"listSessionInfo","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessionInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the locally resourced Sessions in the environment","tags":["Inventory"]}},"/inventory/v1/sessions/action/disconnect":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGE_VDI_SESSION | Caller should have permission to this privilege on the associated access group of session's machine to perform this operation. |\n| FEDERATED_SESSIONS_MANAGE | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement to perform the session operation. |","operationId":"disconnectSessions","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of session ids to be disconnected.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Disconnects locally resourced user sessions.","tags":["Inventory"]}},"/inventory/v1/sessions/action/logoff":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGE_VDI_SESSION | Caller should have permission to this privilege on the associated access group of session's machine to perform this operation. |\n| FEDERATED_SESSIONS_MANAGE | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement to perform the session operation. |","operationId":"logOffSessions","parameters":[{"description":"Indicates to Log off session forcibly.\n If passed as \"true\", then sessions are logoff forcibly, even if they are locked.\n If passed as \"false\" or not passed at all, then sessions will be normally logged off, if they are not locked.","in":"query","name":"forced","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of session ids to be logged off.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Logs off locally resourced user sessions, if they are not locked.","tags":["Inventory"]}},"/inventory/v1/sessions/action/reset":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_REBOOT | Caller should have permission to this privilege on the associated access group of session's machine to perform this operation. |\n| FEDERATED_SESSIONS_MANAGE | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement to perform the session operation. |","operationId":"resetSessions","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of session ids to be reset.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Resets machine of locally resourced user sessions. The machine must be managed by Virtual Center and the session cannot be an application or an RDS desktop session.","tags":["Inventory"]}},"/inventory/v1/sessions/action/restart":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_REBOOT | Caller should have permission to this privilege on the associated access group of session's machine to perform this operation. |\n| FEDERATED_SESSIONS_MANAGE | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement to perform the session operation. |","operationId":"restartSessions","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of session ids to be restarted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Restarts machine of locally resourced user sessions. The machine must be managed by Virtual Center and the session cannot be an application or an RDS desktop session.","tags":["Inventory"]}},"/inventory/v1/sessions/action/send-message":{"post":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGE_VDI_SESSION | Caller should have permission to this privilege on the associated access group of session's machine to perform this operation. |\n| FEDERATED_SESSIONS_MANAGE | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement to perform the session operation. |","operationId":"sendMessageToSessions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionSendMessageSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Sends the message to locally resourced user sessions.","tags":["Inventory"]}},"/inventory/v1/sessions/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"getSessionInfo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SessionInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Session information for locally resourced session.","tags":["Inventory"]}},"/inventory/v10/application-pools":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to delete the application pool. |","operationId":"deleteApplicationPoolsV10","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of application pool IDs to be deleted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given application pools.","tags":["Inventory"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those application pools, for which caller has permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"listApplicationPoolsV10","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationPoolInfoV10"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the application pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of desktop pool or farm, to create the application pool. |","operationId":"createApplicationPoolV10","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolCreateSpecV6"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates an application pool.","tags":["Inventory"]}},"/inventory/v10/application-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to delete the application pool. |","operationId":"deleteApplicationPoolV10","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes application pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"getApplicationPoolV10","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationPoolInfoV10"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets application pool.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"updateApplicationPoolV10","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolUpdateSpecV6"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates application pool.","tags":["Inventory"]}},"/inventory/v10/desktop-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"listDesktopPoolsV10","parameters":[{"description":"When true (default), populates AWS-specific fields. Set to false to improve performance when AWS data is not needed.","in":"query","name":"populate_additional_aws_fields","required":false,"schema":{"type":"boolean","default":true}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolInfoV10"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the desktop pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"createDesktopPoolV10","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolCreateSpecV6"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a desktop pool.","tags":["Inventory"]}},"/inventory/v10/desktop-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"deleteDesktopPoolV10","parameters":[{"description":"Whether or not we want to check if sessions associated to the desktop pool exists. Default value is false","example":true,"in":"query","name":"enforce_associated_session_check","required":false,"schema":{"type":"boolean"}},{"description":"ID of the desktop pool to be deleted.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolDeleteSpec"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a desktop pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"getDesktopPoolV10","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolInfoV10"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the desktop pool information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.<br> To update the access group for the desktop pool, caller should also have permission to this privilege on the access group to which desktop pool will be associated after update.|","operationId":"updateDesktopPoolV10","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolUpdateSpecV5"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates desktop pool.","tags":["Inventory"]}},"/inventory/v10/machines":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |","operationId":"deleteMachinesV10","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineDeleteSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the specified machines.","tags":["Inventory"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those unmanaged (physical) machines, that are part of desktop pool, for which the caller needs permission to this privilege.|","operationId":"listMachinesV10","parameters":[{"in":"query","name":"group_id","required":false,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MachineInfoV10"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Machines in the environment.","tags":["Inventory"]}},"/inventory/v10/machines/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |","operationId":"deleteMachineV10","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineDeleteData"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the machine.","tags":["Inventory"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the unmanaged (physical) machines that are part of desktop pool.|","operationId":"getMachineV10","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineInfoV10"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the machine information.","tags":["Inventory"]}},"/inventory/v11/desktop-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"listDesktopPoolsV11","parameters":[{"description":"When true (default), populates AWS-specific fields. Set to false to improve performance when AWS data is not needed.","in":"query","name":"populate_additional_aws_fields","required":false,"schema":{"type":"boolean","default":true}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolInfoV11"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the desktop pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"createDesktopPoolV11","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolCreateSpecV7"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a desktop pool.","tags":["Inventory"]}},"/inventory/v11/desktop-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"deleteDesktopPoolV11","parameters":[{"description":"Whether or not we want to check if sessions associated to the desktop pool exists. Default value is false","example":true,"in":"query","name":"enforce_associated_session_check","required":false,"schema":{"type":"boolean"}},{"description":"ID of the desktop pool to be deleted.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolDeleteSpec"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a desktop pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"getDesktopPoolV11","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolInfoV11"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the desktop pool information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.<br> To update the access group for the desktop pool, caller should also have permission to this privilege on the access group to which desktop pool will be associated after update.|","operationId":"updateDesktopPoolV11","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolUpdateSpecV6"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates desktop pool.","tags":["Inventory"]}},"/inventory/v12/desktop-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"listDesktopPoolsV12","parameters":[{"description":"When true (default), populates AWS-specific fields. Set to false to improve performance when AWS data is not needed.","in":"query","name":"populate_additional_aws_fields","required":false,"schema":{"type":"boolean","default":true}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolInfoV12"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the desktop pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"createDesktopPoolV12","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolCreateSpecV8"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a desktop pool.","tags":["Inventory"]}},"/inventory/v12/desktop-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"deleteDesktopPoolV12","parameters":[{"description":"Whether or not we want to check if sessions associated to the desktop pool exists. Default value is false","example":true,"in":"query","name":"enforce_associated_session_check","required":false,"schema":{"type":"boolean"}},{"description":"ID of the desktop pool to be deleted.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolDeleteSpec"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a desktop pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"getDesktopPoolV12","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolInfoV12"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the desktop pool information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.<br> To update the access group for the desktop pool, caller should also have permission to this privilege on the access group to which desktop pool will be associated after update.|","operationId":"updateDesktopPoolV12","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolUpdateSpecV7"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates desktop pool.","tags":["Inventory"]}},"/inventory/v2/agent-installer-packages":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listAgentInstallerPackagesV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentInstallerPackageInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists agent installer packages.","tags":["Inventory"]}},"/inventory/v2/agent-installer-packages/action/register":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| INVENTORY_ADMINISTRATOR | Caller should have permission to this privilege, to perform this operation. |","operationId":"registerAgentInstallerPackageV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentInstallerPackageRegisterSpecV2"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentInstallerPackageRegisterResponseInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Registers an agent installer package.","tags":["Inventory"]}},"/inventory/v2/agent-installer-packages/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getAgentInstallerPackageV2","parameters":[{"description":"Id of agent installer package","example":"8fdefa82-17e4-4367-b5b1-8d97e4fd5e56","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentInstallerPackageInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves an agent installer package.","tags":["Inventory"]}},"/inventory/v2/application-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those application pools, for which caller has permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"listApplicationPoolsV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationPoolInfoV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the application pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of desktop pool or farm, to create the application pool. |","operationId":"createApplicationPoolV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolCreateSpecV2"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates an application pool.","tags":["Inventory"]}},"/inventory/v2/application-pools/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"getApplicationPoolV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationPoolInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets application pool.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"updateApplicationPoolV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates application pool.","tags":["Inventory"]}},"/inventory/v2/cp-desktop-pools":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |","operationId":"listCPDesktopPoolsV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CPDesktopPoolInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the capacity provider Desktop Pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"createCPDesktopPoolV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPDesktopPoolCreateSpecV2"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a capacity provider desktop pool.","tags":["Inventory"]}},"/inventory/v2/cp-desktop-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"deleteCPDesktopPoolV2","parameters":[{"description":"Whether or not we want to check if sessions associated to the desktop pool exists. Default value is false","example":true,"in":"query","name":"enforce_associated_session_check","required":false,"schema":{"type":"boolean"}},{"description":"ID of the desktop pool to be deleted.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolDeleteSpec"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a capacity provider desktop pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"getCPDesktopPoolV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CPDesktopPoolInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the capacity provider Desktop Pool information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.<br> To update the access group for the desktop pool, caller should also have permission to this privilege on the access group to which desktop pool will be associated after update.|","operationId":"updateCPDesktopPoolV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPDesktopPoolUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates capacity provider desktop pool.","tags":["Inventory"]}},"/inventory/v2/cp-farms":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listCpFarmsV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CPFarmInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Farms in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"createCpFarmV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPFarmCreateSpecV2"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a farm.","tags":["Inventory"]}},"/inventory/v2/cp-farms/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"deleteCpFarmV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a farm.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getCpFarm2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CPFarmInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Farm information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm.<br> To update the access group for the farm, caller should also have permission to this privilege on the access group to which farm will be associated after update. |","operationId":"updateCpFarm2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPFarmUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates farm.","tags":["Inventory"]}},"/inventory/v2/desktop-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |","operationId":"listDesktopPoolsV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolInfoV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the desktop pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"createDesktopPoolV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolCreateSpecV2"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a desktop pool.","tags":["Inventory"]}},"/inventory/v2/desktop-pools/policies/overrides":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\nCaller should have permission to this privilege, on the associated access group of the desktop pool.","operationId":"listUserPoliciesOverridesV2","parameters":[{"description":"Indicates the desktop pool id. If not provided, fetches overrides for all users on all pools.","in":"query","name":"desktop_pool_id","required":false,"schema":{"type":"string"}},{"description":"Indicates whether to fetch unentitled policies. If set to true, fetches unentitled policies for all users.","in":"query","name":"unentitled_policies","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserPoliciesInfoV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns policy overrides for entitled or unentitled users.","tags":["Inventory"]}},"/inventory/v2/desktop-pools/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"getDesktopPoolV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the desktop pool information.","tags":["Inventory"]}},"/inventory/v2/desktop-pools/{id}/action/schedule-push-image":{"post":{"description":"Request an update of the image in an instant clone desktop pool. This marks the old image to be replaced by new image, which is performed asynchronously. Once the new image is successfully updated, all eligible machines in desktop pool would also be marked for update with new image, this operation is also performed asynchronously.<br>To schedule the request, there should not be any operation on the desktop pool currently.<br>If the current operation of the desktop pool is 'SCHEDULE_PUSH_IMAGE' and schedule has not triggered yet, use this API to reschedule an existing scheduled push image operation. In case of reschedule, other than start time all the parameters of the API should be identical to previous call to this API for the desktop pool.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"schedulePushImageV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolPushImageSpecV2"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Schedule/reschedule a request to update the image in an instant clone desktop pool.","tags":["Inventory"]}},"/inventory/v2/farms":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listFarmsV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FarmInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Farms in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"createFarmV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmCreateSpecV2"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a farm.","tags":["Inventory"]}},"/inventory/v2/farms/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getFarmV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FarmInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Farm information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm.<br> To update the access group for the farm, caller should also have permission to this privilege on the access group to which farm will be associated after update. |","operationId":"updateFarmV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates farm.","tags":["Inventory"]}},"/inventory/v2/farms/{id}/action/schedule-maintenance":{"post":{"description":"Note: This operation is applicable only to Instant clone farms. This can be used for creating both immediate or recurring maintenance. At most one schedule of both the types can co-exist at same time. Optionally user can request an update of the Image in the specified farm. This marks the old image to be replaced by new image, which is performed asynchronously. Once the new image is successfully updated, all eligible RDS servers in the farm would also be marked for update with new image, this operation is also performed asynchronously. This operation can also be used to replace an existing scheduled maintenance. Immediate maintenance will take priority over any existing scheduled recurring maintenance. Recurring maintenance for this farm will be put on hold until immediate maintenance has completed. \n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"scheduleMaintenanceV2","parameters":[{"description":"Farm ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmMaintenanceSpecV2"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates maintenance schedule for the specified farm.","tags":["Inventory"]}},"/inventory/v2/global-application-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"listGlobalApplicationEntitlementsV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalApplicationEntitlementSummaryV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Application Entitlements in the environment.","tags":["Inventory"]}},"/inventory/v2/global-application-entitlements/{id}":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"getGlobalApplicationEntitlementV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Application Entitlement in the environment.","tags":["Inventory"]}},"/inventory/v2/global-desktop-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"listGlobalDesktopEntitlementsV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalDesktopEntitlementSummaryV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Desktop Entitlements in the environment.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"createGlobalDesktopEntitlementV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementCreateSpecV2"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v2/global-desktop-entitlements/{id}":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"getGlobalDesktopEntitlementV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Desktop Entitlement in the environment.","tags":["Inventory"]}},"/inventory/v2/global-sessions":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br><br>Exactly one of user_id, pod_id and brokering_pod_id must be set to non-null value.<br><br>This API supports <b>Pagination</b>.<br/><br>At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"queryGlobalSessionsV2","parameters":[{"description":"SID of the user.","example":"S-1-5-21-1111111111-2222222222-3333333333-500","in":"query","name":"user_id","required":false,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session.","example":"96d708fe-badb-40f8-9b80-9029b0ab2ef2","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}},{"description":"ID of the pod that brokered the session.","example":"806ca35f-bcab-4a42-9006-04ba27cad900","in":"query","name":"brokering_pod_id","required":false,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalSessionInfoV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists global sessions in the environment for the given user, pod or brokering pod.","tags":["Inventory"]}},"/inventory/v2/machines":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those unmanaged (physical) machines, that are part of desktop pool, for which the caller needs permission to this privilege.|","operationId":"listMachinesV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MachineInfoV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Machines in the environment.","tags":["Inventory"]}},"/inventory/v2/machines/action/schedule-agent-upgrade":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MAINTENANCE | Caller should have permission to this privilege, to perform this operation. |","operationId":"scheduleAgentForUpgradeV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentUpgradeSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentUpgradeTaskResponseInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Schedule agents for upgrade.","tags":["Inventory"]}},"/inventory/v2/machines/agent-upgrade-tasks":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listAgentUpgradeTasksV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentUpgradeTaskInfoV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"List agent upgrade tasks information.","tags":["Inventory"]}},"/inventory/v2/machines/agent-upgrade-tasks/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getAgentUpgradeTaskV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentUpgradeTaskInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get agent upgrade task information.","tags":["Inventory"]}},"/inventory/v2/machines/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the unmanaged (physical) machines that are part of desktop pool.|","operationId":"getMachineV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Machine information.","tags":["Inventory"]}},"/inventory/v2/physical-machines":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view the physical machines.\n","operationId":"listPhysicalMachinesV2","parameters":[{"description":"Whether the physical machine is associated with any pool or farm","in":"query","name":"in_use","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhysicalMachineInfoV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Physical Machines in the environment.","tags":["Inventory"]}},"/inventory/v2/physical-machines/action/register":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_MACHINE_REGISTER | Caller should have permission to this privilege to register the physical machines.\n","operationId":"registerPhysicalMachinesV2","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Specifications for registering the physical machine.","items":{"$ref":"#/components/schemas/PhysicalMachineRegisterSpecV2"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhysicalMachineBulkRegisterResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Registers the Physical Machine.","tags":["Inventory"]}},"/inventory/v2/physical-machines/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view the physical machines.\n","operationId":"getPhysicalMachineV2","parameters":[{"description":"Physical machine ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PhysicalMachineInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Physical Machine information.","tags":["Inventory"]}},"/inventory/v2/rds-servers":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those registered RDS Servers, that are part of farm, for which the caller needs permission to this privilege. |","operationId":"listRDSServersV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RDSServerInfoV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the RDS Servers in the environment.","tags":["Inventory"]}},"/inventory/v2/rds-servers/action/schedule-agent-upgrade":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MAINTENANCE | Caller should have permission to this privilege, to perform this operation. |","operationId":"scheduleAgentForUpgradeRdsServerV2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentUpgradeSpecV2"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentUpgradeTaskResponseInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Schedule agents for upgrade.","tags":["Inventory"]}},"/inventory/v2/rds-servers/agent-upgrade-tasks":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listRdsServerAgentUpgradeTasksV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentUpgradeTaskInfoV3"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"List agent upgrade tasks information.","tags":["Inventory"]}},"/inventory/v2/rds-servers/agent-upgrade-tasks/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getRdsServerAgentUpgradeTaskV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentUpgradeTaskInfoV3"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get agent upgrade task information.","tags":["Inventory"]}},"/inventory/v2/rds-servers/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"deleteRDSServerV2","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the RDS Server.","tags":["Inventory"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the registered RDS Server that is part of farm. |","operationId":"getRDSServerV2","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the RDS Server information.","tags":["Inventory"]},"put":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"updateRDSServerV2","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RDSServerUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the RDS Server.","tags":["Inventory"]}},"/inventory/v2/sessions":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"listSessionInfoV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessionInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the locally resourced Sessions in the environment","tags":["Inventory"]}},"/inventory/v3/agent-installer-packages":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listAgentInstallerPackagesV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentInstallerPackageInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists agent installer packages.","tags":["Inventory"]}},"/inventory/v3/agent-installer-packages/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getAgentInstallerPackageV3","parameters":[{"description":"Id of agent installer package","example":"8fdefa82-17e4-4367-b5b1-8d97e4fd5e56","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentInstallerPackageInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves an agent installer package.","tags":["Inventory"]}},"/inventory/v3/application-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those application pools, for which caller has permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"listApplicationPoolsV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationPoolInfoV3"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the application pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of desktop pool or farm, to create the application pool. |","operationId":"createApplicationPoolV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolCreateSpecV3"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates an application pool.","tags":["Inventory"]}},"/inventory/v3/application-pools/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"getApplicationPoolV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationPoolInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets application pool.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"updateApplicationPoolV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates application pool.","tags":["Inventory"]}},"/inventory/v3/cp-desktop-pools":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |","operationId":"listCPDesktopPoolsV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CPDesktopPoolInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the capacity provider Desktop Pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"createCPDesktopPoolV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPDesktopPoolCreateSpecV3"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a capacity provider desktop pool.","tags":["Inventory"]}},"/inventory/v3/cp-desktop-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"deleteCPDesktopPoolV3","parameters":[{"description":"Whether or not we want to check if sessions associated to the desktop pool exists. Default value is false","example":true,"in":"query","name":"enforce_associated_session_check","required":false,"schema":{"type":"boolean"}},{"description":"ID of the desktop pool to be deleted.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolDeleteSpec"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a capacity provider desktop pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"getCPDesktopPoolV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CPDesktopPoolInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the capacity provider Desktop Pool information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.<br> To update the access group for the desktop pool, caller should also have permission to this privilege on the access group to which desktop pool will be associated after update.|","operationId":"updateCPDesktopPoolV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CPDesktopPoolUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates capacity provider desktop pool.","tags":["Inventory"]}},"/inventory/v3/desktop-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"listDesktopPoolsV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolInfoV3"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the desktop pools in the environment.","tags":["Inventory"]}},"/inventory/v3/desktop-pools/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"getDesktopPoolV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the desktop pool information.","tags":["Inventory"]}},"/inventory/v3/desktop-pools/{id}/action/schedule-push-image":{"post":{"description":"Request an update of the image in an instant clone desktop pool. This marks the old image to be replaced by new image, which is performed asynchronously. Once the new image is successfully updated, all eligible machines in desktop pool would also be marked for update with new image, this operation is also performed asynchronously.<br>To schedule the request, there should not be any operation on the desktop pool currently.<br>If the current operation of the desktop pool is 'SCHEDULE_PUSH_IMAGE' and schedule has not triggered yet, use this API to reschedule an existing scheduled push image operation. In case of reschedule, other than start time all the parameters of the API should be identical to previous call to this API for the desktop pool.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"schedulePushImageV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolPushImageSpecV3"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Schedule/reschedule a request to update the image in an instant clone desktop pool.","tags":["Inventory"]}},"/inventory/v3/farms":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listFarmsV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FarmInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Farms in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"createFarmV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmCreateSpecV3"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a farm.","tags":["Inventory"]}},"/inventory/v3/farms/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getFarmV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FarmInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Farm information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm.<br> To update the access group for the farm, caller should also have permission to this privilege on the access group to which farm will be associated after update. |","operationId":"updateFarmV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates farm.","tags":["Inventory"]}},"/inventory/v3/farms/{id}/action/schedule-maintenance":{"post":{"description":"Note: This operation is applicable only to Instant clone farms. This can be used for creating both immediate or recurring maintenance. At most one schedule of both the types can co-exist at same time. Optionally user can request an update of the Image in the specified farm. This marks the old image to be replaced by new image, which is performed asynchronously. Once the new image is successfully updated, all eligible RDS servers in the farm would also be marked for update with new image, this operation is also performed asynchronously. This operation can also be used to replace an existing scheduled maintenance. Immediate maintenance will take priority over any existing scheduled recurring maintenance. Recurring maintenance for this farm will be put on hold until immediate maintenance has completed. \n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"scheduleMaintenanceV3","parameters":[{"description":"Farm ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmMaintenanceSpecV3"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates maintenance schedule for the specified farm.","tags":["Inventory"]}},"/inventory/v3/global-application-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"listGlobalApplicationEntitlementsV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalApplicationEntitlementSummaryV3"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Application Entitlements in the environment.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"createGlobalApplicationEntitlementV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementCreateSpecV2"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v3/global-application-entitlements/{id}":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"deleteGlobalApplicationEntitlementV3","parameters":[{"description":"Global Application Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Global Application Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"getGlobalApplicationEntitlementV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Application Entitlement in the environment.","tags":["Inventory"]},"put":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"updateGlobalApplicationEntitlementV3","parameters":[{"description":"Global Application Entitlement object to be updated","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v3/global-desktop-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"listGlobalDesktopEntitlementsV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalDesktopEntitlementSummaryV3"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Desktop Entitlements in the environment.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"createGlobalDesktopEntitlementV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementCreateSpecV3"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v3/global-desktop-entitlements/{id}":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"deleteGlobalDesktopEntitlementV3","parameters":[{"description":"Global Desktop Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Global Desktop Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"getGlobalDesktopEntitlementV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Desktop Entitlement in the environment.","tags":["Inventory"]},"put":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"updateGlobalDesktopEntitlementV3","parameters":[{"description":"Global Desktop Entitlement object to be updated","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v3/global-sessions":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br><br>Exactly one of user_id, pod_id and brokering_pod_id must be set to non-null value.<br><br>This API supports <b>Pagination</b>.<br/><br>At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"queryGlobalSessionsV3","parameters":[{"description":"SID of the user.","example":"S-1-5-21-1111111111-2222222222-3333333333-500","in":"query","name":"user_id","required":false,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session.","example":"96d708fe-badb-40f8-9b80-9029b0ab2ef2","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}},{"description":"ID of the pod that brokered the session.","example":"806ca35f-bcab-4a42-9006-04ba27cad900","in":"query","name":"brokering_pod_id","required":false,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalSessionInfoV3"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists global sessions in the environment for the given user, pod or brokering pod.","tags":["Inventory"]}},"/inventory/v3/machines":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those unmanaged (physical) machines, that are part of desktop pool, for which the caller needs permission to this privilege.|","operationId":"listMachinesV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MachineInfoV3"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Machines in the environment.","tags":["Inventory"]}},"/inventory/v3/machines/action/schedule-agent-upgrade":{"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MAINTENANCE | Caller should have permission to this privilege, to perform this operation. |","operationId":"scheduleAgentForUpgradeV3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentUpgradeSpecV2"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentUpgradeTaskResponseInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Schedule agents for upgrade.","tags":["Inventory"]}},"/inventory/v3/machines/agent-upgrade-tasks":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listAgentUpgradeTasksV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentUpgradeTaskInfoV3"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"List agent upgrade tasks information.","tags":["Inventory"]}},"/inventory/v3/machines/agent-upgrade-tasks/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getAgentUpgradeTaskV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentUpgradeTaskInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get agent upgrade task information.","tags":["Inventory"]}},"/inventory/v3/machines/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the unmanaged (physical) machines that are part of desktop pool.|","operationId":"getMachineV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Machine information.","tags":["Inventory"]}},"/inventory/v3/physical-machines":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view the physical machines.\n","operationId":"listPhysicalMachinesV3","parameters":[{"description":"Whether the physical machine is associated with any pool or farm","in":"query","name":"in_use","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhysicalMachineInfoV3"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Physical Machines in the environment.","tags":["Inventory"]}},"/inventory/v3/physical-machines/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view the physical machines.\n","operationId":"getPhysicalMachineV3","parameters":[{"description":"Physical machine ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PhysicalMachineInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Physical Machine information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_MACHINE_REGISTER | Caller should have permission to this privilege to update the physical machines.\n","operationId":"updatePhysicalMachinesV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalMachineUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the physical machine.","tags":["Inventory"]}},"/inventory/v3/rds-servers":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those registered RDS Servers, that are part of farm, for which the caller needs permission to this privilege. |","operationId":"listRDSServersV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RDSServerInfoV3"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the RDS Servers in the environment.","tags":["Inventory"]}},"/inventory/v3/rds-servers/agent-upgrade-tasks":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listRdsServerAgentUpgradeTasksV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentUpgradeTaskInfoV4"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"List agent upgrade tasks information.","tags":["Inventory"]}},"/inventory/v3/rds-servers/agent-upgrade-tasks/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getRdsServerAgentUpgradeTaskV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentUpgradeTaskInfoV4"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get agent upgrade task information.","tags":["Inventory"]}},"/inventory/v3/rds-servers/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"deleteRDSServerV3","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the RDS Server.","tags":["Inventory"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the registered RDS Server that is part of farm. |","operationId":"getRDSServerV3","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the RDS Server information.","tags":["Inventory"]},"put":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"updateRDSServerV3","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RDSServerUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the RDS Server.","tags":["Inventory"]}},"/inventory/v3/sessions":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"listSessionInfoV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessionInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the locally resourced Sessions in the environment","tags":["Inventory"]}},"/inventory/v3/sessions/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"getSessionInfoV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SessionInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Session information for locally resourced session.","tags":["Inventory"]}},"/inventory/v4/application-pools":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to delete the application pool. |","operationId":"deleteApplicationPools","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of application pool IDs to be deleted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given application pools.","tags":["Inventory"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those application pools, for which caller has permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"listApplicationPoolsV4","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationPoolInfoV4"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the application pools in the environment.","tags":["Inventory"]}},"/inventory/v4/application-pools/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"getApplicationPoolV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationPoolInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets application pool.","tags":["Inventory"]}},"/inventory/v4/desktop-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"listDesktopPoolsV4","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolInfoV4"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the desktop pools in the environment.","tags":["Inventory"]}},"/inventory/v4/desktop-pools/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"getDesktopPoolV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the desktop pool information.","tags":["Inventory"]}},"/inventory/v4/desktop-pools/{id}/action/schedule-push-image":{"post":{"description":"Request an update of the image in an instant clone desktop pool. This marks the old image to be replaced by new image, which is performed asynchronously. Once the new image is successfully updated, all eligible machines in desktop pool would also be marked for update with new image, this operation is also performed asynchronously.<br>To schedule the request, there should not be any operation on the desktop pool currently.<br>If the current operation of the desktop pool is 'SCHEDULE_PUSH_IMAGE' and schedule has not triggered yet, use this API to reschedule an existing scheduled push image operation. In case of reschedule, other than start time all the parameters of the API should be identical to previous call to this API for the desktop pool.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"schedulePushImageV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolPushImageSpecV4"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Schedule/reschedule a request to update the image in an instant clone desktop pool.","tags":["Inventory"]}},"/inventory/v4/farms":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listFarmsV4","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FarmInfoV4"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Farms in the environment.","tags":["Inventory"]}},"/inventory/v4/farms/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getFarmV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FarmInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Farm information.","tags":["Inventory"]}},"/inventory/v4/global-application-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"listGlobalApplicationEntitlementsV4","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalApplicationEntitlementSummaryV4"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Application Entitlements in the environment.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"createGlobalApplicationEntitlementV4","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementCreateSpecV3"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v4/global-application-entitlements/{id}":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"deleteGlobalApplicationEntitlementV4","parameters":[{"description":"Global Application Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Global Application Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"getGlobalApplicationEntitlementV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Application Entitlement in the environment.","tags":["Inventory"]},"put":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"updateGlobalApplicationEntitlementV4","parameters":[{"description":"Global Application Entitlement object to be updated","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v4/global-desktop-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"listGlobalDesktopEntitlementsV4","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalDesktopEntitlementSummaryV4"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Desktop Entitlements in the environment.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"createGlobalDesktopEntitlementV4","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementCreateSpecV4"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v4/global-desktop-entitlements/{id}":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"deleteGlobalDesktopEntitlementV4","parameters":[{"description":"Global Desktop Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Global Desktop Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"getGlobalDesktopEntitlementV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Desktop Entitlement in the environment.","tags":["Inventory"]},"put":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"updateGlobalDesktopEntitlementV4","parameters":[{"description":"Global Desktop Entitlement object to be updated","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v4/global-sessions":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.<br><br>Exactly one of user_id, pod_id and brokering_pod_id must be set to non-null value.<br><br>This API supports <b>Pagination</b>.<br/><br>At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"queryGlobalSessionsV4","parameters":[{"description":"SID of the user.","example":"S-1-5-21-1111111111-2222222222-3333333333-500","in":"query","name":"user_id","required":false,"schema":{"type":"string"}},{"description":"ID of the pod that hosted the session.","example":"96d708fe-badb-40f8-9b80-9029b0ab2ef2","in":"query","name":"pod_id","required":false,"schema":{"type":"string"}},{"description":"ID of the pod that brokered the session.","example":"806ca35f-bcab-4a42-9006-04ba27cad900","in":"query","name":"brokering_pod_id","required":false,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalSessionInfoV4"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists global sessions in the environment for the given user, pod or brokering pod.","tags":["Inventory"]}},"/inventory/v4/machines":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those unmanaged (physical) machines, that are part of desktop pool, for which the caller needs permission to this privilege.|","operationId":"listMachinesV4","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MachineInfoV4"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Machines in the environment.","tags":["Inventory"]}},"/inventory/v4/machines/agent-upgrade-tasks":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listAgentUpgradeTasksV4","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AgentUpgradeTaskInfoV4"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"List agent upgrade tasks information.","tags":["Inventory"]}},"/inventory/v4/machines/agent-upgrade-tasks/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getAgentUpgradeTaskV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentUpgradeTaskInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get agent upgrade task information.","tags":["Inventory"]}},"/inventory/v4/machines/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the unmanaged (physical) machines that are part of desktop pool.|","operationId":"getMachineV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the machine information.","tags":["Inventory"]}},"/inventory/v4/physical-machines":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to delete the physical machines.\n","operationId":"deletePhysicalMachines","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the Physical Machines.","tags":["Inventory"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view the physical machines.\n","operationId":"listPhysicalMachinesV4","parameters":[{"description":"Whether the physical machine is associated with any pool or farm","in":"query","name":"in_use","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhysicalMachineInfoV4"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Physical Machines in the environment.","tags":["Inventory"]}},"/inventory/v4/physical-machines/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view the physical machines.\n","operationId":"getPhysicalMachineV4","parameters":[{"description":"Physical machine ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PhysicalMachineInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Physical Machine information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_MACHINE_REGISTER | Caller should have permission to this privilege to update the physical machines.\n","operationId":"updatePhysicalMachinesV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalMachineUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the physical machine.","tags":["Inventory"]}},"/inventory/v4/rds-servers":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those registered RDS Servers, that are part of farm, for which the caller needs permission to this privilege. |","operationId":"listRDSServersV4","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RDSServerInfoV4"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the RDS Servers in the environment.","tags":["Inventory"]}},"/inventory/v4/rds-servers/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"deleteRDSServerV4","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the RDS Server.","tags":["Inventory"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the registered RDS Server that is part of farm. |","operationId":"getRDSServerV4","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the RDS Server information.","tags":["Inventory"]},"put":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"updateRDSServerV4","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RDSServerUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the RDS Server.","tags":["Inventory"]}},"/inventory/v4/sessions":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"listSessionInfoV4","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessionInfoV4"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the locally resourced Sessions in the environment","tags":["Inventory"]}},"/inventory/v4/sessions/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"getSessionInfoV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SessionInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Session information for locally resourced session.","tags":["Inventory"]}},"/inventory/v5/application-pools":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to delete the application pool. |","operationId":"deleteApplicationPoolsV5","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of application pool IDs to be deleted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given application pools.","tags":["Inventory"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those application pools, for which caller has permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"listApplicationPoolsV5","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationPoolInfoV5"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the application pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of desktop pool or farm, to create the application pool. |","operationId":"createApplicationPoolV5","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolCreateSpecV4"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates an application pool.","tags":["Inventory"]}},"/inventory/v5/application-pools/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"getApplicationPoolV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationPoolInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets application pool.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"updateApplicationPoolV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates application pool.","tags":["Inventory"]}},"/inventory/v5/desktop-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"listDesktopPoolsV5","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolInfoV5"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the desktop pools in the environment.","tags":["Inventory"]}},"/inventory/v5/desktop-pools/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"getDesktopPoolV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the desktop pool information.","tags":["Inventory"]}},"/inventory/v5/farms":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listFarmsV5","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FarmInfoV5"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Farms in the environment.","tags":["Inventory"]}},"/inventory/v5/farms/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getFarmV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FarmInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Farm information.","tags":["Inventory"]}},"/inventory/v5/global-application-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"listGlobalApplicationEntitlementsV5","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalApplicationEntitlementSummaryV5"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Application Entitlements in the environment.","tags":["Inventory"]}},"/inventory/v5/global-desktop-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"listGlobalDesktopEntitlementsV5","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalDesktopEntitlementSummaryV5"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Desktop Entitlements in the environment.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"createGlobalDesktopEntitlementV5","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementCreateSpecV5"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v5/global-desktop-entitlements/{id}":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"deleteGlobalDesktopEntitlementV5","parameters":[{"description":"Global Desktop Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Global Desktop Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"getGlobalDesktopEntitlementV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Desktop Entitlement in the environment.","tags":["Inventory"]},"put":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"updateGlobalDesktopEntitlementV5","parameters":[{"description":"Global Desktop Entitlement object to be updated","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v5/machines":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those unmanaged (physical) machines, that are part of desktop pool, for which the caller needs permission to this privilege.|","operationId":"listMachinesV5","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MachineInfoV5"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Machines in the environment.","tags":["Inventory"]}},"/inventory/v5/machines/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the unmanaged (physical) machines that are part of desktop pool.|","operationId":"getMachineV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the machine information.","tags":["Inventory"]}},"/inventory/v5/physical-machines":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view the physical machines.\n","operationId":"listPhysicalMachinesV5","parameters":[{"description":"Whether the physical machine is associated with any pool or farm","in":"query","name":"in_use","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhysicalMachineInfoV5"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Physical Machines in the environment.","tags":["Inventory"]}},"/inventory/v5/physical-machines/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view the physical machines.\n","operationId":"getPhysicalMachineV5","parameters":[{"description":"Physical machine ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PhysicalMachineInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Physical Machine information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_MACHINE_REGISTER | Caller should have permission to this privilege to update the physical machines.\n","operationId":"updatePhysicalMachinesV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalMachineUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the physical machine.","tags":["Inventory"]}},"/inventory/v5/rds-servers":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those registered RDS Servers, that are part of farm, for which the caller needs permission to this privilege. |","operationId":"listRDSServersV5","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RDSServerInfoV5"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the RDS Servers in the environment.","tags":["Inventory"]}},"/inventory/v5/rds-servers/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"deleteRDSServerV5","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the RDS Server.","tags":["Inventory"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the registered RDS Server that is part of farm. |","operationId":"getRDSServerV5","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the RDS Server information.","tags":["Inventory"]},"put":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"updateRDSServerV5","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RDSServerUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the RDS Server.","tags":["Inventory"]}},"/inventory/v5/sessions":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"listSessionInfoV5","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessionInfoV5"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the locally resourced Sessions in the environment","tags":["Inventory"]}},"/inventory/v5/sessions/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"getSessionInfoV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SessionInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Session information for locally resourced session.","tags":["Inventory"]}},"/inventory/v6/application-pools":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to delete the application pool. |","operationId":"deleteApplicationPoolsV6","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of application pool IDs to be deleted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given application pools.","tags":["Inventory"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those application pools, for which caller has permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"listApplicationPoolsV6","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationPoolInfoV6"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the application pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of desktop pool or farm, to create the application pool. |","operationId":"createApplicationPoolV6","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolCreateSpecV5"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates an application pool.","tags":["Inventory"]}},"/inventory/v6/application-pools/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"getApplicationPoolV6","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationPoolInfoV6"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets application pool.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"updateApplicationPoolV6","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolUpdateSpecV5"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates application pool.","tags":["Inventory"]}},"/inventory/v6/desktop-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"listDesktopPoolsV6","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolInfoV6"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the desktop pools in the environment.","tags":["Inventory"]}},"/inventory/v6/desktop-pools/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"getDesktopPoolV6","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolInfoV6"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the desktop pool information.","tags":["Inventory"]}},"/inventory/v6/farms":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listFarmsV6","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FarmInfoV6"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Farms in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"createFarmV6","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmCreateSpecV4"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a farm.","tags":["Inventory"]}},"/inventory/v6/farms/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"deleteFarmV6","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a farm.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getFarmV6","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FarmInfoV6"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Farm information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm.<br> To update the access group for the farm, caller should also have permission to this privilege on the access group to which farm will be associated after update. |","operationId":"updateFarmV6","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates farm.","tags":["Inventory"]}},"/inventory/v6/global-application-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"listGlobalApplicationEntitlementsV6","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalApplicationEntitlementSummaryV6"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Application Entitlements in the environment.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"createGlobalApplicationEntitlementV6","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementCreateSpecV3"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v6/global-application-entitlements/{id}":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"deleteGlobalApplicationEntitlementV6","parameters":[{"description":"Global Application Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Global Application Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"getGlobalApplicationEntitlementV6","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Application Entitlement in the environment.","tags":["Inventory"]},"put":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"updateGlobalApplicationEntitlementV6","parameters":[{"description":"Global Application Entitlement object to be updated","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v6/global-desktop-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"listGlobalDesktopEntitlementsV6","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalDesktopEntitlementSummaryV6"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Desktop Entitlements in the environment.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"createGlobalDesktopEntitlementV6","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementCreateSpecV5"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v6/global-desktop-entitlements/{id}":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"deleteGlobalDesktopEntitlementV6","parameters":[{"description":"Global Desktop Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Global Desktop Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"getGlobalDesktopEntitlementV6","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementInfoV6"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Desktop Entitlement in the environment.","tags":["Inventory"]},"put":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"updateGlobalDesktopEntitlementV6","parameters":[{"description":"Global Desktop Entitlement object to be updated","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v6/machines":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those unmanaged (physical) machines, that are part of desktop pool, for which the caller needs permission to this privilege.|","operationId":"listMachinesV6","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MachineInfoV6"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Machines in the environment.","tags":["Inventory"]}},"/inventory/v6/machines/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the unmanaged (physical) machines that are part of desktop pool.|","operationId":"getMachineV6","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineInfoV6"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the machine information.","tags":["Inventory"]}},"/inventory/v6/physical-machines":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view the physical machines.\n","operationId":"listPhysicalMachinesV6","parameters":[{"description":"Whether the physical machine is associated with any pool or farm","in":"query","name":"in_use","required":false,"schema":{"type":"boolean"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhysicalMachineInfoV6"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Physical Machines in the environment.","tags":["Inventory"]}},"/inventory/v6/physical-machines/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to view the physical machines.\n","operationId":"getPhysicalMachineV6","parameters":[{"description":"Physical machine ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PhysicalMachineInfoV6"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Physical Machine information.","tags":["Inventory"]}},"/inventory/v6/rds-servers":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those registered RDS Servers, that are part of farm, for which the caller needs permission to this privilege. |","operationId":"listRDSServersV6","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RDSServerInfoV6"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the RDS Servers in the environment.","tags":["Inventory"]}},"/inventory/v6/rds-servers/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"deleteRDSServerV6","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the RDS Server.","tags":["Inventory"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the registered RDS Server that is part of farm. |","operationId":"getRDSServerV6","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerInfoV6"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the RDS Server information.","tags":["Inventory"]}},"/inventory/v6/sessions":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"listSessionInfoV6","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessionInfoV6"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the locally resourced Sessions in the environment","tags":["Inventory"]}},"/inventory/v6/sessions/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"getSessionInfoV6","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SessionInfoV6"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Session information for locally resourced session.","tags":["Inventory"]}},"/inventory/v7/application-pools":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to delete the application pool. |","operationId":"deleteApplicationPoolsV7","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of application pool IDs to be deleted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given application pools.","tags":["Inventory"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those application pools, for which caller has permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"listApplicationPoolsV7","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationPoolInfoV7"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the application pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of desktop pool or farm, to create the application pool. |","operationId":"createApplicationPoolV7","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolCreateSpecV5"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates an application pool.","tags":["Inventory"]}},"/inventory/v7/application-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to delete the application pool. |","operationId":"deleteApplicationPoolV7","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes application pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"getApplicationPoolV7","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationPoolInfoV7"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets application pool.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"updateApplicationPoolV7","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolUpdateSpecV5"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates application pool.","tags":["Inventory"]}},"/inventory/v7/desktop-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"listDesktopPoolsV7","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolInfoV7"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the desktop pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"createDesktopPoolV7","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolCreateSpecV3"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a desktop pool.","tags":["Inventory"]}},"/inventory/v7/desktop-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"deleteDesktopPoolV7","parameters":[{"description":"Whether or not we want to check if sessions associated to the desktop pool exists. Default value is false","example":true,"in":"query","name":"enforce_associated_session_check","required":false,"schema":{"type":"boolean"}},{"description":"ID of the desktop pool to be deleted.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolDeleteSpec"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a desktop pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"getDesktopPoolV7","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolInfoV7"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the desktop pool information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.<br> To update the access group for the desktop pool, caller should also have permission to this privilege on the access group to which desktop pool will be associated after update.|","operationId":"updateDesktopPoolv7","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolUpdateSpecV2"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates desktop pool.","tags":["Inventory"]}},"/inventory/v7/farms":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listFarmsV7","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FarmInfoV7"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Farms in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"createFarmV7","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmCreateSpecV5"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a farm.","tags":["Inventory"]}},"/inventory/v7/farms/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"deleteFarmV7","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a farm.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getFarmV7","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FarmInfoV7"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Farm information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm.<br> To update the access group for the farm, caller should also have permission to this privilege on the access group to which farm will be associated after update. |","operationId":"updateFarmV7","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmUpdateSpecV5"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates farm.","tags":["Inventory"]}},"/inventory/v7/global-application-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"listGlobalApplicationEntitlementsV7","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalApplicationEntitlementSummaryV7"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Application Entitlements in the environment.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"createGlobalApplicationEntitlementV7","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementCreateSpecV4"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v7/global-application-entitlements/{id}":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"deleteGlobalApplicationEntitlementV7","parameters":[{"description":"Global Application Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Global Application Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.\n","operationId":"getGlobalApplicationEntitlementV7","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementInfoV6"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Application Entitlement in the environment.","tags":["Inventory"]},"put":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global application entitlement.\n","operationId":"updateGlobalApplicationEntitlementV7","parameters":[{"description":"Global Application Entitlement object to be updated","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalApplicationEntitlementUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Global Application Entitlement.","tags":["Inventory"]}},"/inventory/v7/global-desktop-entitlements":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"listGlobalDesktopEntitlementsV7","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalDesktopEntitlementSummaryV7"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Global Desktop Entitlements in the environment.","tags":["Inventory"]},"post":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"createGlobalDesktopEntitlementV7","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementCreateSpecV6"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v7/global-desktop-entitlements/{id}":{"delete":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"deleteGlobalDesktopEntitlementV7","parameters":[{"description":"Global Desktop Entitlement ID","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a Global Desktop Entitlement.","tags":["Inventory"]},"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read the global desktop entitlement.\n","operationId":"getGlobalDesktopEntitlementV7","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementInfoV7"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Global Desktop Entitlement in the environment.","tags":["Inventory"]},"put":{"description":"Note: CPA must be initialized for the pod for invoking this API.\n<br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the associated federated access group to manage the global desktop entitlement.\n","operationId":"updateGlobalDesktopEntitlementV7","parameters":[{"description":"Global Desktop Entitlement object to be updated","example":"5134796a-322g-5fe5-343f-4daa5d25ebfe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDesktopEntitlementUpdateSpecV5"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates a Global Desktop Entitlement.","tags":["Inventory"]}},"/inventory/v7/machines":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those unmanaged (physical) machines, that are part of desktop pool, for which the caller needs permission to this privilege.|","operationId":"listMachinesV7","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MachineInfoV7"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Machines in the environment.","tags":["Inventory"]}},"/inventory/v7/machines/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the unmanaged (physical) machines that are part of desktop pool.|","operationId":"getMachineV7","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineInfoV7"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the machine information.","tags":["Inventory"]}},"/inventory/v7/rds-servers":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those registered RDS Servers, that are part of farm, for which the caller needs permission to this privilege. |","operationId":"listRDSServersV7","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RDSServerInfoV7"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the RDS Servers in the environment.","tags":["Inventory"]}},"/inventory/v7/rds-servers/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"deleteRDSServerV7","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the RDS Server.","tags":["Inventory"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the registered RDS Server that is part of farm. |","operationId":"getRDSServerV7","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerInfoV7"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the RDS Server information.","tags":["Inventory"]},"put":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_MANAGEMENT | Caller should have permission to this privilege to perform the operation on the registered RDS Server that is part of farm.|","operationId":"updateRDSServerV7","parameters":[{"description":"RDS Server ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RDSServerUpdateSpec"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates the RDS Server.","tags":["Inventory"]}},"/inventory/v7/sessions":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"listSessionInfoV7","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessionInfoV7"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the locally resourced Sessions in the environment","tags":["Inventory"]}},"/inventory/v7/sessions/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"getSessionInfoV7","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SessionInfoV7"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Session information for locally resourced session.","tags":["Inventory"]}},"/inventory/v8/application-pools":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to delete the application pool. |","operationId":"deleteApplicationPoolsV8","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of application pool IDs to be deleted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given application pools.","tags":["Inventory"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those application pools, for which caller has permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"listApplicationPoolsV8","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationPoolInfoV8"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the application pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of desktop pool or farm, to create the application pool. |","operationId":"createApplicationPoolV8","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolCreateSpecV5"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates an application pool.","tags":["Inventory"]}},"/inventory/v8/application-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to delete the application pool. |","operationId":"deleteApplicationPoolV8","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes application pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"getApplicationPoolV8","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationPoolInfoV8"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets application pool.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"updateApplicationPoolV8","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolUpdateSpecV5"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates application pool.","tags":["Inventory"]}},"/inventory/v8/desktop-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"listDesktopPoolsV8","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolInfoV8"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the desktop pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"createDesktopPoolV8","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolCreateSpecV4"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a desktop pool.","tags":["Inventory"]}},"/inventory/v8/desktop-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"deleteDesktopPoolV8","parameters":[{"description":"Whether or not we want to check if sessions associated to the desktop pool exists. Default value is false","example":true,"in":"query","name":"enforce_associated_session_check","required":false,"schema":{"type":"boolean"}},{"description":"ID of the desktop pool to be deleted.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolDeleteSpec"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a desktop pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"getDesktopPoolV8","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolInfoV8"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the desktop pool information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.<br> To update the access group for the desktop pool, caller should also have permission to this privilege on the access group to which desktop pool will be associated after update.|","operationId":"updateDesktopPoolv8","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolUpdateSpecV3"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates desktop pool.","tags":["Inventory"]}},"/inventory/v8/farms":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listFarmsV8","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FarmInfoV8"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Farms in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"createFarmV8","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmCreateSpecV6"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a farm.","tags":["Inventory"]}},"/inventory/v8/farms/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"deleteFarmV8","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a farm.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getFarmV8","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FarmInfoV8"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Farm information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm.<br> To update the access group for the farm, caller should also have permission to this privilege on the access group to which farm will be associated after update. |","operationId":"updateFarmV8","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmUpdateSpecV5"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates farm.","tags":["Inventory"]}},"/inventory/v8/machines":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |","operationId":"deleteMachinesV8","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineDeleteSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the specified machines.","tags":["Inventory"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those unmanaged (physical) machines, that are part of desktop pool, for which the caller needs permission to this privilege.|","operationId":"listMachinesV8","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MachineInfoV8"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Machines in the environment.","tags":["Inventory"]}},"/inventory/v8/machines/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |","operationId":"deleteMachineV8","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineDeleteData"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the machine.","tags":["Inventory"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the unmanaged (physical) machines that are part of desktop pool.|","operationId":"getMachineV8","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineInfoV8"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the machine information.","tags":["Inventory"]}},"/inventory/v8/sessions":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Returns results only for those sessions, for which the caller has permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"listSessionInfoV8","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessionInfoV8"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the locally resourced Sessions in the environment","tags":["Inventory"]}},"/inventory/v8/sessions/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of session's pool or farm. |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, on the associated federated access group of session's global desktop entitlement or global application entitlement. |","operationId":"getSessionInfoV8","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SessionInfoV8"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Session information for locally resourced session.","tags":["Inventory"]}},"/inventory/v9/application-pools":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to delete the application pool. |","operationId":"deleteApplicationPoolsV9","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","description":"List of application pool IDs to be deleted.","items":{"type":"string"}}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the given application pools.","tags":["Inventory"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those application pools, for which caller has permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"listApplicationPoolsV9","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationPoolInfoV9"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the application pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of desktop pool or farm, to create the application pool. |","operationId":"createApplicationPoolV9","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolCreateSpecV6"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates an application pool.","tags":["Inventory"]}},"/inventory/v9/application-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group to delete the application pool. |","operationId":"deleteApplicationPoolV9","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes application pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the application pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group to read the global application entitlement ID field of a application pool. Else, it will be unset.","operationId":"getApplicationPoolV9","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationPoolInfoV9"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets application pool.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the application pool. |","operationId":"updateApplicationPoolV9","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPoolUpdateSpecV6"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates application pool.","tags":["Inventory"]}},"/inventory/v9/desktop-pools":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those desktop pools, for which the caller has permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"listDesktopPoolsV9","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolInfoV9"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the desktop pools in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"createDesktopPoolV9","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolCreateSpecV5"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a desktop pool.","tags":["Inventory"]}},"/inventory/v9/desktop-pools/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool. |","operationId":"deleteDesktopPoolV9","parameters":[{"description":"Whether or not we want to check if sessions associated to the desktop pool exists. Default value is false","example":true,"in":"query","name":"enforce_associated_session_check","required":false,"schema":{"type":"boolean"}},{"description":"ID of the desktop pool to be deleted.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolDeleteSpec"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a desktop pool.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the desktop pool. |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federation access group, to read the global desktop entitlement ID field of a desktop pool. Else, it will be unset.","operationId":"getDesktopPoolV9","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopPoolInfoV9"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the desktop pool information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the desktop pool.<br> To update the access group for the desktop pool, caller should also have permission to this privilege on the access group to which desktop pool will be associated after update.|","operationId":"updateDesktopPoolV9","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesktopPoolUpdateSpecV4"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates desktop pool.","tags":["Inventory"]}},"/inventory/v9/farms":{"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\n <br>All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listFarmsV9","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FarmInfoV9"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Farms in the environment.","tags":["Inventory"]},"post":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"createFarmV9","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmCreateSpecV7"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Creates a farm.","tags":["Inventory"]}},"/inventory/v9/farms/{id}":{"delete":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"deleteFarmV9","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes a farm.","tags":["Inventory"]},"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getFarmV9","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FarmInfoV9"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the Farm information.","tags":["Inventory"]},"put":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm.<br> To update the access group for the farm, caller should also have permission to this privilege on the access group to which farm will be associated after update. |","operationId":"updateFarmV9","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FarmUpdateSpecV6"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Updates farm.","tags":["Inventory"]}},"/inventory/v9/machines":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |","operationId":"deleteMachinesV9","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineDeleteSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}}}},"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the specified machines.","tags":["Inventory"]},"get":{"description":"This API supports <b>Pagination</b> and <b>Filters.</b><br/>For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'Omnissa Horizon Server API' in code.omnissa.com\nAt least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those unmanaged (physical) machines, that are part of desktop pool, for which the caller needs permission to this privilege.|","operationId":"listMachinesV9","parameters":[{"in":"query","name":"group_id","required":false,"schema":{"type":"string"}},{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MachineInfoV9"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Machines in the environment.","tags":["Inventory"]}},"/inventory/v9/machines/{id}":{"delete":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |\n| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |","operationId":"deleteMachineV9","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineDeleteData"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Deletes the machine.","tags":["Inventory"]},"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of machine's desktop pool. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the unmanaged (physical) machines that are part of desktop pool.|","operationId":"getMachineV9","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineInfoV9"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the machine information.","tags":["Inventory"]}},"/key-agreement":{"post":{"operationId":"keyAgreement","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientKeyDerivationSpec"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServerKeyDerivationInfo"}}},"description":"OK"},"400":{"description":"Bad Request"},"429":{"description":"Too many requests"}},"summary":"Uses Diffie-Hellman algorithm to achieve encryption key agreement between client and server, which then can be used to encrypt and decrypt sensitive information.","tags":["Auth"]}},"/login":{"get":{"description":"Note: Smart card authentication is only supported in admin console.","operationId":"authenticateSmartCard","parameters":[{"in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"in":"query","name":"client_reference_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SmartCardAuthTokens"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"summary":"Logs in a user with smart card. Returns access and refresh tokens.","tags":["Auth"]},"post":{"description":"Note: UPN(e.g. testadmin@example.com) based login is not supported.","operationId":"loginUser","parameters":[{"allowEmptyValue":true,"description":"Header to support localization.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string","enum":["de","en","es","fr","ja","ko","zh-CN","zh-TW"],"default":"en"}},{"description":"Client reference identifier present in the response of key-agreement api.","in":"query","name":"client_reference_id","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthLogin"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AuthTokens"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"summary":"Logs in a user. Returns access token and refresh token.","tags":["Auth"]}},"/logout":{"post":{"operationId":"logoutUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshToken"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"429":{"description":"Too many requests"},"500":{"description":"Internal Server Error"}},"summary":"Logs out a user.","tags":["Auth"]}},"/monitor/ad-domains":{"get":{"operationId":"listADDomainMonitors","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADDomainMonitorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to AD Domains of the environment.","tags":["Monitor"]}},"/monitor/app-volumes-managers":{"get":{"operationId":"listAppVolumesManagerMonitorInfoV1","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppVolumesManagerMonitorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to App volumes managers registered in the environment.","tags":["Monitor"]}},"/monitor/app-volumes-managers/{id}":{"get":{"operationId":"getAppVolumesManagerMonitorInfo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AppVolumesManagerMonitorInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about an app volumes manager.","tags":["Monitor"]}},"/monitor/connection-servers":{"get":{"operationId":"listConnectionServerMonitors","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionServerMonitorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Connection Servers of the environment.","tags":["Monitor"]}},"/monitor/desktops":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listDesktopMonitors","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopMonitorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to desktop pools in the environment.","tags":["Monitor"]}},"/monitor/event-database":{"get":{"operationId":"getEventDatabaseMonitor","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EventDatabaseMonitorInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns monitoring information related to Event database of the environment.","tags":["Monitor"]}},"/monitor/farms":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listFarmMonitors","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FarmMonitorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Farms of the environment.","tags":["Monitor"]}},"/monitor/gateways":{"get":{"operationId":"listGatewayMonitorInfoV1","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GatewayMonitorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Gateways registered in the environment.","tags":["Monitor"]}},"/monitor/rds-servers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those registered RDS Servers, that are part of farm, for which the caller needs permission to this privilege. |","operationId":"listRDSServerMonitors","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RDSServerMonitorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to RDS Servers of the environment.","tags":["Monitor"]}},"/monitor/saml-authenticators":{"get":{"operationId":"listSAMLAuthenticatorMonitorsV1","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SAMLAuthenticatorMonitorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to SAML Authenticators of the environment.","tags":["Monitor"]}},"/monitor/v1/connection-servers/schema-master":{"get":{"operationId":"listConnectionServerSchemaMasterMonitors","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionServerLdapSchemaMasterInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to current schema master of the environment.","tags":["Monitor"]}},"/monitor/v1/connection-servers/{id}":{"get":{"operationId":"getConnectionServerMonitorInfoV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ConnectionServerMonitorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to Connection Server.","tags":["Monitor"]}},"/monitor/v1/datastores/usage-metrics":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated desktop pool or farm.","operationId":"listDesktopPoolOrFarmDatastoreUsageInfo","parameters":[{"description":"Virtual Center ID","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","in":"query","name":"vcenter_id","required":true,"schema":{"type":"string"}},{"description":"Datastore ID","example":"datastore-29","in":"query","name":"datastore_id","required":true,"schema":{"type":"string"}},{"description":"Host or Cluster ID","example":"domain-c85","in":"query","name":"host_or_cluster_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolOrFarmDatastoreUsageInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the Desktop pool or Farm and its usage details for a given datastore.","tags":["Monitor"]}},"/monitor/v1/desktop-pools/metrics":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW| Caller should have permission to this privilege on the associated access group of each desktop pool to read corresponding desktop pool metrics","operationId":"listDesktopPoolMetrics","parameters":[{"description":"Desktop pool IDs","in":"query","name":"ids","required":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolMetricsInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists metrics of desktop pools (except RDS desktop pools).","tags":["Monitor"]}},"/monitor/v1/desktops/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getDesktopMonitorInfo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopMonitorInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information related to a desktop pool.","tags":["Monitor"]}},"/monitor/v1/farms/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getFarmMonitorInfo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FarmMonitorInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to farm.","tags":["Monitor"]}},"/monitor/v1/gateways/{id}":{"get":{"operationId":"getGatewayMonitorInfo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GatewayMonitorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to a Gateway.","tags":["Monitor"]}},"/monitor/v1/global-desktop-entitlements/metrics":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listGlobalDesktopEntitlementsMetrics","parameters":[{"description":"Global desktop entitlements IDs","in":"query","name":"ids","required":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalDesktopEntitlementsMetricsInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists metrics of global desktop entitlements.","tags":["Monitor"]}},"/monitor/v1/health-metrics":{"get":{"operationId":"listHealthMetricsInfo","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HealthMetricsInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists the health metrics related information for all the components.","tags":["Monitor"]}},"/monitor/v1/licenses/usage-metrics":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getLicenseUsageMetrics","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/LicenseUsageMetricsInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get metrics of current and highest historical usage numbers of the product license.","tags":["Monitor"]}},"/monitor/v1/machines/count-metrics":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |\n","operationId":"getMachineStateCountMetrics","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineStateCountMetrics"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the state count metrics of the machines.","tags":["Monitor"]}},"/monitor/v1/message-clients":{"get":{"operationId":"listMessageClientsMonitors","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MessageClientMonitorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to registered message clients in the environment.","tags":["Monitor"]}},"/monitor/v1/message-clients/{id}":{"get":{"operationId":"getMessageClientMonitor","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MessageClientMonitorInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to registered message client.","tags":["Monitor"]}},"/monitor/v1/pods":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW| Caller should have permission to this privilege on any federation access group, to read pods.","operationId":"listPodMonitorInfosV1","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PodMonitorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to the remote pods.","tags":["Monitor"]}},"/monitor/v1/pods/global-session-metrics":{"get":{"description":"Note: CPA must be initialized for the pod for invoking this API.\nAll the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_SESSIONS_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getPodSessionMetricsInfo","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PodSessionMetricsInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Get the global session counts related to all Pods in the Pod Federation.","tags":["Monitor"]}},"/monitor/v1/pods/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW| Caller should have permission to this privilege on any federation access group, to read pods.","operationId":"getPodMonitorInfoV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PodMonitorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to the remote pod.","tags":["Monitor"]}},"/monitor/v1/rds-servers/count-metrics":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the registered RDS Server that is part of farm. |","operationId":"getRDSServerStateCountMetrics","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerStateCountMetrics"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets State Counts related to RDS Server.","tags":["Monitor"]}},"/monitor/v1/rds-servers/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the registered RDS Server that is part of farm. |","operationId":"getRDSServerMonitors","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerMonitorInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to RDS Server.","tags":["Monitor"]}},"/monitor/v1/saml-authenticators/{id}":{"get":{"operationId":"getSAMLAuthenticatorMonitorInfo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorMonitorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets Monitoring Information related to a SAML Authenticator","tags":["Monitor"]}},"/monitor/v1/sessions/metrics":{"get":{"operationId":"getSessionMetrics","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SessionMetrics"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets summary of local session metrics.","tags":["Monitor"]}},"/monitor/v1/system-metrics":{"get":{"operationId":"getSystemMetricsInfo","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SystemMetricsInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the system metrics of all the components.","tags":["Monitor"]}},"/monitor/v1/true-sso":{"get":{"operationId":"listTrueSSOMonitorInfos","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TrueSSOMonitorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to True SSO connectors.","tags":["Monitor"]}},"/monitor/v1/true-sso/{id}":{"get":{"operationId":"getTrueSSOMonitorInfo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/TrueSSOMonitorInfo"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to a True SSO connector.","tags":["Monitor"]}},"/monitor/v1/view-composers/{vcId}":{"get":{"deprecated":true,"operationId":"getViewComposerByVCId","parameters":[{"in":"path","name":"vcId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ViewComposerMonitorInfoV2"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"View Composer is no longer supported from Horizon version 2012 onwards.","tags":["Monitor"]}},"/monitor/v1/virtual-centers/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getVirtualCenterMonitorInfo","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/VirtualCenterMonitorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to Virtual Center.","tags":["Monitor"]}},"/monitor/v2/ad-domains":{"get":{"operationId":"listADDomainMonitorInfosV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADDomainMonitorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to AD Domains of the environment.","tags":["Monitor"]}},"/monitor/v2/app-volumes-managers":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listAppVolumesManagerMonitorInfoV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppVolumesManagerMonitorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to App volumes managers registered in the environment.","tags":["Monitor"]}},"/monitor/v2/app-volumes-managers/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getAppVolumesManagerMonitorInfoV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AppVolumesManagerMonitorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information about an app volumes manager.","tags":["Monitor"]}},"/monitor/v2/connection-servers":{"get":{"operationId":"listConnectionServerMonitorsV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionServerMonitorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Connection Servers of the environment.","tags":["Monitor"]}},"/monitor/v2/connection-servers/{id}":{"get":{"operationId":"getConnectionServerMonitorInfoV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ConnectionServerMonitorInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to Connection Server.","tags":["Monitor"]}},"/monitor/v2/desktop-pools/metrics":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW| Caller should have permission to this privilege on the associated access group of each desktop pool to read corresponding desktop pool metrics","operationId":"listDesktopPoolMetricsV2","parameters":[{"description":"Desktop pool IDs","in":"query","name":"ids","required":false,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolMetricsInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists metrics of desktop pools (except RDS desktop pools).","tags":["Monitor"]}},"/monitor/v2/desktops":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listDesktopMonitorInfosV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopMonitorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to desktop pools in the environment (except RDS desktop pools).","tags":["Monitor"]}},"/monitor/v2/desktops/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getDesktopMonitorInfoV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DesktopMonitorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Retrieves information related to a desktop pool (except RDS desktop pools).","tags":["Monitor"]}},"/monitor/v2/event-database":{"get":{"operationId":"getEventDatabaseMonitorV2","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EventDatabaseMonitorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns monitoring information related to Event database of the environment.","tags":["Monitor"]}},"/monitor/v2/farms":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Returns results only for those farms, for which the caller has permission to this privilege, on the associated access group of the farm. |","operationId":"listFarmMonitorsV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FarmMonitorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring data related to Farms of the environment.","tags":["Monitor"]}},"/monitor/v2/farms/{id}":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of the farm. |","operationId":"getFarmMonitorInfoV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/FarmMonitorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring data related to farm.","tags":["Monitor"]}},"/monitor/v2/gateways":{"get":{"operationId":"listGatewayMonitorInfoV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GatewayMonitorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Gateways registered in the environment.","tags":["Monitor"]}},"/monitor/v2/gateways/{id}":{"get":{"operationId":"getGatewayMonitorInfoV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GatewayMonitorInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to a Gateway.","tags":["Monitor"]}},"/monitor/v2/machines/count-metrics":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those machines, for which the caller has permission to this privilege, on the associated access group of machine's desktop pool. |\n","operationId":"getMachineStateCountMetricsV2","parameters":[{"description":"Desktop pool IDs","in":"query","name":"ids","required":false,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineStateCountMetricsV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the state count metrics of the machines.","tags":["Monitor"]}},"/monitor/v2/pods":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| FEDERATED_LDAP_VIEW| Caller should have permission to this privilege on any federation access group, to read pods.","operationId":"listPodMonitorInfosV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PodMonitorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to the remote pods.","tags":["Monitor"]}},"/monitor/v2/rds-servers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those registered RDS Servers, that are part of farm, for which the caller needs permission to this privilege. |","operationId":"listRDSServerMonitorsV2","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RDSServerMonitorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to RDS Servers of the environment.","tags":["Monitor"]}},"/monitor/v2/rds-servers/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the registered RDS Server that is part of farm. |","operationId":"getRDSServerMonitorsV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerMonitorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to RDS Server.","tags":["Monitor"]}},"/monitor/v2/saml-authenticators":{"get":{"operationId":"listSAMLAuthenticatorMonitorsV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SAMLAuthenticatorMonitorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to SAML Authenticators of the environment.","tags":["Monitor"]}},"/monitor/v2/system-metrics":{"get":{"operationId":"getSystemMetricsInfoV2","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SystemMetricsInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets the system metrics of all the components.","tags":["Monitor"]}},"/monitor/v2/true-sso":{"get":{"operationId":"listTrueSSOMonitorInfosV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TrueSSOMonitorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to True SSO connectors.","tags":["Monitor"]}},"/monitor/v2/true-sso/{id}":{"get":{"operationId":"getTrueSSOMonitorInfoV2","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/TrueSSOMonitorInfoV2"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to a True SSO connector.","tags":["Monitor"]}},"/monitor/v2/view-composers":{"get":{"deprecated":true,"operationId":"listViewComposerMonitorsV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ViewComposerMonitorInfoV2"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"View Composer is no longer supported from Horizon version 2012 onwards.","tags":["Monitor"]}},"/monitor/v2/virtual-centers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVirtualCenterMonitorsV2","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCenterMonitorInfoV2"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Virtual Centers of the environment.","tags":["Monitor"]}},"/monitor/v3/ad-domains":{"get":{"operationId":"listADDomainMonitorInfosV3","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADDomainMonitorInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to AD Domains of the environment.","tags":["Monitor"]}},"/monitor/v3/connection-servers":{"get":{"operationId":"listConnectionServerMonitorsV3","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionServerMonitorInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Connection Servers of the environment.","tags":["Monitor"]}},"/monitor/v3/desktop-pools/metrics":{"get":{"description":"All the listed privileges are required -  \n| Privileges | Description |\n| ---- | ---- |\n| POOL_VIEW| Caller should have permission to this privilege on the associated access group of each desktop pool to read corresponding desktop pool metrics","operationId":"listDesktopPoolMetricsV3","parameters":[{"description":"Desktop pool IDs","in":"query","name":"ids","required":false,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DesktopPoolMetricsInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists metrics of desktop pools (except RDS desktop pools).","tags":["Monitor"]}},"/monitor/v3/event-database":{"get":{"operationId":"getEventDatabaseMonitorV3","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EventDatabaseMonitorInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Returns monitoring information related to Event database of the environment.","tags":["Monitor"]}},"/monitor/v3/gateways":{"get":{"operationId":"listGatewayMonitorInfoV3","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GatewayMonitorInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Gateways registered in the environment.","tags":["Monitor"]}},"/monitor/v3/rds-servers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those registered RDS Servers, that are part of farm, for which the caller needs permission to this privilege. |","operationId":"listRDSServerMonitorsV3","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RDSServerMonitorInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to RDS Servers of the environment.","tags":["Monitor"]}},"/monitor/v3/rds-servers/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the registered RDS Server that is part of farm. |","operationId":"getRDSServerMonitorsV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerMonitorInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to RDS Server.","tags":["Monitor"]}},"/monitor/v3/saml-authenticators":{"get":{"operationId":"listSAMLAuthenticatorMonitorsV3","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SAMLAuthenticatorMonitorInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to SAML Authenticators of the environment.","tags":["Monitor"]}},"/monitor/v3/saml-authenticators/{id}":{"get":{"operationId":"getSAMLAuthenticatorMonitorInfoV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorMonitorInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets Monitoring Information related to a SAML Authenticator","tags":["Monitor"]}},"/monitor/v3/virtual-centers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVirtualCenterMonitorsV3","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCenterMonitorInfoV3"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Virtual Centers of the environment.","tags":["Monitor"]}},"/monitor/v3/virtual-centers/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getVirtualCenterMonitorInfoV3","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/VirtualCenterMonitorInfoV3"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to Virtual Center.","tags":["Monitor"]}},"/monitor/v4/ad-domains":{"get":{"operationId":"listADDomainMonitorInfosV4","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ADDomainMonitorInfoV4"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to AD Domains of the environment.","tags":["Monitor"]}},"/monitor/v4/connection-servers":{"get":{"operationId":"listConnectionServerMonitorsV4","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionServerMonitorInfoV4"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Connection Servers of the environment.","tags":["Monitor"]}},"/monitor/v4/connection-servers/{id}":{"get":{"operationId":"getConnectionServerMonitorInfoV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ConnectionServerMonitorInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to Connection Server.","tags":["Monitor"]}},"/monitor/v4/gateways":{"get":{"operationId":"listGatewayMonitorInfoV4","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GatewayMonitorInfoV4"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Gateways registered in the environment.","tags":["Monitor"]}},"/monitor/v4/gateways/{id}":{"get":{"operationId":"getGatewayMonitorInfoV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GatewayMonitorInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to a Gateway.","tags":["Monitor"]}},"/monitor/v4/rds-servers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Returns results only for those RDS Servers, for which the caller has permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Returns results only for those registered RDS Servers, that are part of farm, for which the caller needs permission to this privilege. |","operationId":"listRDSServerMonitorsV4","parameters":[{"description":"page, if passed should be > 0.","example":1,"in":"query","name":"page","schema":{"type":"integer"}},{"description":"size, if passed should be > 0.","example":10,"in":"query","name":"size","schema":{"type":"integer"}},{"description":"filter expression built using fields with <b>'supported filters'</b> as described in output <b>model</b> schema of this API.","example":{"type":"And","filters":[{"type":"Equals","name":"<>","value":"<>"}]},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Field that would be used to sort the results.","example":"<property-name>","in":"query","name":"sort_by","schema":{"type":"string"}},{"description":"Determines the ordering of results.","example":"ASC","in":"query","name":"order_by","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RDSServerMonitorInfoV4"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to RDS Servers of the environment.","tags":["Monitor"]}},"/monitor/v4/rds-servers/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| MACHINE_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| POOL_VIEW | Caller should have permission to this privilege, on the associated access group of RDS Server's farm. |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege to read the registered RDS Server that is part of farm. |","operationId":"getRDSServerMonitorsV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RDSServerMonitorInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to RDS Server.","tags":["Monitor"]}},"/monitor/v4/saml-authenticators":{"get":{"operationId":"listSAMLAuthenticatorMonitorsV4","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SAMLAuthenticatorMonitorInfoV4"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to SAML Authenticators of the environment.","tags":["Monitor"]}},"/monitor/v4/saml-authenticators/{id}":{"get":{"operationId":"getSAMLAuthenticatorMonitorInfoV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SAMLAuthenticatorMonitorInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets Monitoring Information related to a SAML Authenticator","tags":["Monitor"]}},"/monitor/v4/virtual-centers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVirtualCenterMonitorsV4","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCenterMonitorInfoV4"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Virtual Centers of the environment.","tags":["Monitor"]}},"/monitor/v4/virtual-centers/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getVirtualCenterMonitorInfoV4","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/VirtualCenterMonitorInfoV4"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to Virtual Center.","tags":["Monitor"]}},"/monitor/v5/gateways":{"get":{"operationId":"listGatewayMonitorInfoV5","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GatewayMonitorInfoV5"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Gateways registered in the environment.","tags":["Monitor"]}},"/monitor/v5/gateways/{id}":{"get":{"operationId":"getGatewayMonitorInfoV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/GatewayMonitorInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to a Gateway.","tags":["Monitor"]}},"/monitor/v5/virtual-centers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVirtualCenterMonitorsV5","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCenterMonitorInfoV5"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Virtual Centers of the environment.","tags":["Monitor"]}},"/monitor/v5/virtual-centers/{id}":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"getVirtualCenterMonitorInfoV5","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/VirtualCenterMonitorInfoV5"}}},"description":"OK"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Gets monitoring information related to Virtual Center.","tags":["Monitor"]}},"/monitor/view-composers":{"get":{"deprecated":true,"operationId":"listViewComposerMonitorsV1","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ViewComposerMonitorInfo"}}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"View Composer is no longer supported from Horizon version 2012 onwards.","tags":["Monitor"]}},"/monitor/virtual-centers":{"get":{"description":"At least one of the listed privileges is required -  \n| Privileges | Description |\n| ---- | ---- |\n| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |\n| VC_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |","operationId":"listVirtualCenterMonitors","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCenterMonitorInfo"}}}},"description":"OK"},"401":{"description":"User is not authenticated"},"429":{"description":"Too many requests"}},"security":[{"Bearer":[]}],"summary":"Lists monitoring information related to Virtual Centers of the environment.","tags":["Monitor"]}},"/refresh":{"post":{"operationId":"refreshAccessToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshToken"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccessToken"}}},"description":"OK"},"400":{"description":"Bad Request"},"429":{"description":"Too many requests"},"500":{"description":"Internal Server Error"}},"summary":"Refreshes access token from refresh token.","tags":["Auth"]}}},"components":{"schemas":{"ADComputerInfo":{"type":"object","properties":{"cn":{"type":"string","description":"Common Name (CN) of the computer in AD.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nSupports sorting.\n","example":"computer1"},"container":{"type":"string","description":"AD container of the computer.\nSupports sorting.\n"},"dns_host_name":{"type":"string","description":"DNS Host Name of the computer.\nSupports sorting.\n","example":"computer1.example.com"},"domain":{"type":"string","description":"Domain of the computer.\nSupported Filters : 'Equals'.\nSupports sorting.\n","example":"example.com"},"long_display_name":{"type":"string","description":"Login name, domain and name for this computer, else display name.\nSupports sorting.\n"},"object_guid":{"type":"string","description":"Object GUID of the computer in AD.\nSupported Filters : 'Equals'.\n","example":"12345678-1234-1234-1234-123456789012"},"operating_system":{"type":"string","description":"Operating System of the computer.\nSupports sorting.\n","example":"Windows 10 Pro"},"operating_system_version":{"type":"string","description":"Operating System Version of the computer.\nSupports sorting.\n","example":"10.0.19042"},"sam_account_name":{"type":"string","description":"Login name of the computer.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nSupports sorting.\n","example":"COMPUTER1$"},"sid":{"type":"string","description":"Unique SID representing this AD Computer.\nSupported Filters : 'Equals'.\n","example":"S-1-5-21-1111111111-2222222222-3333333333-1000"}},"description":"Information related to AD Computers.\nSupported Filters : 'And', 'Or', 'Equals', 'Contains', 'StartsWith'.\n'Or' filter chain only supports 'Equals' filter on 'sid' and 'domain' field.\n"},"ADContainerInfo":{"type":"object","properties":{"rdn":{"type":"string","description":"The rdn of the active directory container, relative to the root of the domain.","example":"CN=ComPartitions,CN=System"}},"description":"Information about an active directory container."},"ADDomainAdvancedSettings":{"required":["ad_domain_context","port"],"type":"object","properties":{"ad_domain_auto_discovery":{"type":"boolean","description":"Auto discovers domain controllers. Auto discovery, AD domain controllers and preferred site name are mutually exclusive. Only one of them can be defined at a time. Default value is true.","example":true},"ad_domain_context":{"type":"string","description":"Active directory domain Context.","example":"dc=abc,dc=com"},"ad_domain_controllers":{"type":"array","description":"One or more AD domain controllers. Auto discovery, AD domain controllers and preferred site name are mutually exclusive.  Only one of them can be defined at a time.","example":["example.com","example1.com"],"items":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)+([A-Za-z]|[A-Za-z][A-Za-z0-9\\-]*[A-Za-z0-9])$","type":"string","description":"One or more AD domain controllers. Auto discovery, AD domain controllers and preferred site name are mutually exclusive.  Only one of them can be defined at a time.","example":"[\"example.com\",\"example1.com\"]"}},"ad_domain_preferred_site":{"type":"string","description":"ADDomain preferred domain site. Auto discovery, AD domain controllers and preferred site name are mutually exclusive. Only one of them can be defined at a time.","example":"Bengaluru"},"port":{"maximum":65535,"minimum":0,"type":"integer","description":"Port of the server to connect to.","format":"int32","example":389}},"description":"Information related to untrusted Domain advance settings."},"ADDomainAdvancedSettingsInfo":{"type":"object","properties":{"ad_domain_auto_discovery":{"type":"boolean","description":"Auto discovers domain controllers. Auto discovery, AD domain controllers and preferred site name are mutually exclusive. Only one of them can be defined at a time. Default value is true.","example":true},"ad_domain_context":{"type":"string","description":"Active directory domain Context.","example":"dc=abc,dc=com"},"ad_domain_controllers":{"type":"array","description":"One or more AD domain controllers. Auto discovery, AD domain controllers and preferred site name are mutually exclusive.  Only one of them can be defined at a time.","example":"example.com","items":{"type":"string","description":"One or more AD domain controllers. Auto discovery, AD domain controllers and preferred site name are mutually exclusive.  Only one of them can be defined at a time.","example":"example.com"}},"ad_domain_preferred_site":{"type":"string","description":"ADDomain preferred domain site. Auto discovery, AD domain controllers and preferred site name are mutually exclusive. Only one of them can be defined at a time.","example":"Bengaluru"},"port":{"type":"integer","description":"Port of the server to connect to.","format":"int32","example":389}},"description":"Information related to untrusted Domain advance settings."},"ADDomainAuxiliaryAccountCreateSpec":{"required":["auxiliary_accounts"],"type":"object","properties":{"auxiliary_accounts":{"type":"array","description":"Auxiliary service account credentials.","items":{"$ref":"#/components/schemas/ADDomainServiceAccountSpec"}}},"description":"Specification of auxiliary accounts."},"ADDomainAuxiliaryAccountDeleteSpec":{"required":["auxiliary_account_ids"],"type":"object","properties":{"auxiliary_account_ids":{"type":"array","description":"Auxiliary account ID's.","items":{"type":"string","description":"Auxiliary account ID's."}}},"description":"Auxiliary accounts to delete."},"ADDomainAuxiliaryAccountUpdateSpec":{"required":["auxiliary_accounts"],"type":"object","properties":{"auxiliary_accounts":{"type":"array","description":"Auxiliary service account credentials.","items":{"$ref":"#/components/schemas/AuxiliaryAccountUpdateData"}}},"description":"Specification to update auxiliary accounts."},"ADDomainAuxiliaryServiceAccountInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique SID representing auxiliary account.","example":"554c9fc8-d948-4fbb-9612-69cd640191e6_user1"},"username":{"type":"string","description":"Service account username.","example":"Administrator"}},"description":"Information related to auxiliary service accounts of untrusted domain."},"ADDomainBindInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID representing the AD domain.","example":"S-1-5-21-3861703653-2745738756-3849765893"}},"description":"ADDomain bind response."},"ADDomainInfo":{"type":"object","properties":{"dns_name":{"type":"string","description":"DNS name of the AD Domain.","example":"example.com"},"id":{"type":"string","description":"Unique SID representing AD Domain.","example":"S-1-5-21-1085031214-1563985344-725345543"},"netbios_name":{"type":"string","description":"NetBIOS name of the AD Domain.","example":"AD-EXAMPLE1"}},"description":"Information related to AD Domains of the environment."},"ADDomainInfoV2":{"type":"object","properties":{"ad_domain_advanced_settings":{"$ref":"#/components/schemas/ADDomainAdvancedSettingsInfo"},"dns_name":{"type":"string","description":"DNS name of the AD Domain.","example":"example.com"},"domain_type":{"type":"string","description":"AD Domain Type.\n* CONNECTION_SERVER_DOMAIN: The domain having trust with connection server domain.\n* NO_TRUST_DOMAIN: The domain not having any trust with connection server domain.","example":"CONNECTION_SERVER_DOMAIN","enum":["CONNECTION_SERVER_DOMAIN","NO_TRUST_DOMAIN"]},"id":{"type":"string","description":"Unique SID representing AD Domain.","example":"S-1-5-21-1085031214-1563985344-725345543"},"netbios_name":{"type":"string","description":"NetBIOS name of the AD Domain.","example":"AD-EXAMPLE1"},"primary_account":{"$ref":"#/components/schemas/ADDomainPrimaryServiceAccountInfo"}},"description":"Information related to AD Domains of the environment."},"ADDomainInfoV3":{"type":"object","properties":{"ad_domain_advanced_settings":{"$ref":"#/components/schemas/ADDomainAdvancedSettingsInfo"},"auxiliary_accounts":{"type":"array","description":"Auxiliary service accounts information of untrusted domain.","items":{"$ref":"#/components/schemas/ADDomainAuxiliaryServiceAccountInfo"}},"dns_name":{"type":"string","description":"DNS name of the AD Domain.","example":"example.com"},"domain_type":{"type":"string","description":"AD Domain Type.\n* CONNECTION_SERVER_DOMAIN: The domain having trust with connection server domain.\n* NO_TRUST_DOMAIN: The domain not having any trust with connection server domain.","example":"CONNECTION_SERVER_DOMAIN","enum":["CONNECTION_SERVER_DOMAIN","NO_TRUST_DOMAIN"]},"id":{"type":"string","description":"Unique SID representing AD Domain.","example":"S-1-5-21-1085031214-1563985344-725345543"},"netbios_name":{"type":"string","description":"NetBIOS name of the AD Domain.","example":"AD-EXAMPLE1"},"primary_account":{"$ref":"#/components/schemas/ADDomainPrimaryServiceAccountInfo"}},"description":"Information related to AD Domains of the environment."},"ADDomainMonitorConnectionServer":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the connection server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the connection to the domain.\n* UNCONTACTABLE: No domain controllers appear to be present on the network for this domain.\n* FULLY_ACCESSIBLE: The domain controller(s) are accepting bind operations.\n* CANNOT_BIND: The domain controller(s) are only accepting LDAP ping operations.\n* UNKNOWN: Cannot determine accessibility.","example":"FULLY_ACCESSIBLE","enum":["UNCONTACTABLE","FULLY_ACCESSIBLE","CANNOT_BIND","UNKNOWN"]},"trust_relationship":{"type":"string","description":"The trust relationship for the domain.\n* PRIMARY_DOMAIN: The domain is the domain that the broker is present in.\n* FROM_BROKER: The domain is trusted by the domain that the broker is in.\n* TO_BROKER: The domain trusts the broker's domain (this is for completeness and generally will not be used).\n* TWO_WAY: The domain has a two way trust relationship with the broker's domain.\n* TWO_WAY_FOREST: The domain is in the same forest as the broker's domain, implies two way trust.\n* MANUAL: The domain was manually configured (the trust has not been detected).\n* NOTRUST: The domain not having trust with broker domain.\n* UNKNOWN: The trust relationship could not be determined.","example":"TWO_WAY","enum":["PRIMARY_DOMAIN","FROM_BROKER","TO_BROKER","TWO_WAY","TWO_WAY_FOREST","MANUAL","NOTRUST","UNKNOWN"]}},"description":"Information about the AD Domain connection from connection server."},"ADDomainMonitorConnectionServerV2":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the connection server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the connection to the domain.\n* UNCONTACTABLE: No domain controllers appear to be present on the network for this domain.\n* FULLY_ACCESSIBLE: The domain controller(s) are accepting bind operations.\n* CANNOT_BIND: The domain controller(s) are only accepting LDAP ping operations.\n* UNKNOWN: Cannot determine accessibility.","example":"FULLY_ACCESSIBLE","enum":["UNCONTACTABLE","FULLY_ACCESSIBLE","CANNOT_BIND","UNKNOWN"]},"trust_relationship":{"type":"string","description":"The trust relationship for the domain.\n* PRIMARY_DOMAIN: The domain is the domain that the broker is present in.\n* FROM_BROKER: The domain is trusted by the domain that the broker is in.\n* TO_BROKER: The domain trusts the broker's domain (this is for completeness and generally will not be used).\n* TWO_WAY: The domain has a two way trust relationship with the broker's domain.\n* TWO_WAY_FOREST: The domain is in the same forest as the broker's domain, implies two way trust.\n* MANUAL: The domain was manually configured (the trust has not been detected).\n* NOTRUST: The domain not having trust with broker domain.\n* UNKNOWN: The trust relationship could not be determined.","example":"TWO_WAY","enum":["PRIMARY_DOMAIN","FROM_BROKER","TO_BROKER","TWO_WAY","TWO_WAY_FOREST","MANUAL","NOTRUST","UNKNOWN"]}},"description":"Information about the AD Domain connection from connection server."},"ADDomainMonitorConnectionServerV3":{"type":"object","properties":{"connection_status":{"type":"string","description":"Status of the AD Domain connection\n* ERROR: No domain controllers appear to be present on the network for this domain.\n* OK: The domain controller(s) are accepting bind operations.\n* WARN: The domain controller(s) are only accepting LDAP ping operations.\n* UNKNOWN: Cannot determine accessibility.","example":"OK","enum":["ERROR","OK","WARN","UNKNOWN"]},"id":{"type":"string","description":"Unique ID of the connection server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the connection to the domain.\n* UNCONTACTABLE: No domain controllers appear to be present on the network for this domain.\n* FULLY_ACCESSIBLE: The domain controller(s) are accepting bind operations.\n* CANNOT_BIND: The domain controller(s) are only accepting LDAP ping operations.\n* UNKNOWN: Cannot determine accessibility.","example":"FULLY_ACCESSIBLE","enum":["UNCONTACTABLE","FULLY_ACCESSIBLE","CANNOT_BIND","UNKNOWN"]},"trust_relationship":{"type":"string","description":"The trust relationship for the domain.\n* PRIMARY_DOMAIN: The domain is the domain that the broker is present in.\n* FROM_BROKER: The domain is trusted by the domain that the broker is in.\n* TO_BROKER: The domain trusts the broker's domain (this is for completeness and generally will not be used).\n* TWO_WAY: The domain has a two way trust relationship with the broker's domain.\n* TWO_WAY_FOREST: The domain is in the same forest as the broker's domain, implies two way trust.\n* MANUAL: The domain was manually configured (the trust has not been detected).\n* NOTRUST: The domain not having trust with broker domain.\n* UNKNOWN: The trust relationship could not be determined.","example":"TWO_WAY","enum":["PRIMARY_DOMAIN","FROM_BROKER","TO_BROKER","TWO_WAY","TWO_WAY_FOREST","MANUAL","NOTRUST","UNKNOWN"]}},"description":"Information about the AD Domain connection from connection server."},"ADDomainMonitorInfo":{"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the AD Domain connections from each of the connection servers.","items":{"$ref":"#/components/schemas/ADDomainMonitorConnectionServer"}},"dns_name":{"type":"string","description":"The DNS name for the domain.","example":"ad-example1.example.com"},"netbios_name":{"type":"string","description":"The NetBIOS name for the domain.","example":"AD-EXAMPLE1"},"nt4_domain":{"type":"boolean","description":"If this is an NT4 domain or not.","example":true}},"description":"Monitoring information related to AD Domain."},"ADDomainMonitorInfoV2":{"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the AD Domain connections from each of the connection servers.","items":{"$ref":"#/components/schemas/ADDomainMonitorConnectionServerV2"}},"dns_name":{"type":"string","description":"The DNS name for the domain.","example":"ad-example1.example.com"},"netbios_name":{"type":"string","description":"The NetBIOS name for the domain.","example":"AD-EXAMPLE1"},"nt4_domain":{"type":"boolean","description":"If this is an NT4 domain or not.","example":true}},"description":"Monitoring information related to AD Domain."},"ADDomainMonitorInfoV3":{"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the AD Domain connections from each of the connection servers.","items":{"$ref":"#/components/schemas/ADDomainMonitorConnectionServerV2"}},"dns_name":{"type":"string","description":"The DNS name for the domain.","example":"ad-example1.example.com"},"domain_type":{"type":"string","description":"AD Domain Type.\n* CONNECTION_SERVER_DOMAIN: The domain having trust with connection server domain.\n* NO_TRUST_DOMAIN: The domain not having any trust with connection server domain.","example":"CONNECTION_SERVER_DOMAIN","enum":["CONNECTION_SERVER_DOMAIN","NO_TRUST_DOMAIN"]},"netbios_name":{"type":"string","description":"The NetBIOS name for the domain.","example":"AD-EXAMPLE1"},"nt4_domain":{"type":"boolean","description":"If this is an NT4 domain or not.","example":true},"service_accounts":{"type":"array","description":"Service accounts for the domain.","items":{"$ref":"#/components/schemas/ServiceAccount"}}},"description":"Monitoring information related to AD Domain."},"ADDomainMonitorInfoV4":{"type":"object","properties":{"connection_servers_v3":{"type":"array","description":"Information about the AD Domain connections from each of the connection servers.","items":{"$ref":"#/components/schemas/ADDomainMonitorConnectionServerV3"}},"dns_name":{"type":"string","description":"The DNS name for the domain.","example":"ad-example1.example.com"},"domain_type":{"type":"string","description":"AD Domain Type.\n* CONNECTION_SERVER_DOMAIN: The domain having trust with connection server domain.\n* NO_TRUST_DOMAIN: The domain not having any trust with connection server domain.","example":"CONNECTION_SERVER_DOMAIN","enum":["CONNECTION_SERVER_DOMAIN","NO_TRUST_DOMAIN"]},"netbios_name":{"type":"string","description":"The NetBIOS name for the domain.","example":"AD-EXAMPLE1"},"nt4_domain":{"type":"boolean","description":"If this is an NT4 domain or not.","example":true},"service_accounts":{"type":"array","description":"Service accounts for the domain.","items":{"$ref":"#/components/schemas/ServiceAccount"}}},"description":"Monitoring information related to AD Domain."},"ADDomainPrimaryServiceAccountInfo":{"type":"object","properties":{"username":{"type":"string","description":"Service account username.","example":"Administrator"}},"description":"Information related to untrusted Domain service accounts."},"ADDomainServiceAccountSpec":{"required":["password","username"],"type":"object","properties":{"password":{"type":"array","description":"Service account user password.","example":"<password>","items":{"type":"string","description":"Service account user password.","example":"<password>"}},"username":{"type":"string","description":"Service account username.","example":"Administrator"}},"description":"Information related to untrusted Domain service accounts."},"ADDomainSpec":{"required":["ad_domain_advanced_settings","dns_name","netbios_name","primary_account"],"type":"object","properties":{"ad_domain_advanced_settings":{"$ref":"#/components/schemas/ADDomainAdvancedSettings"},"dns_name":{"pattern":"^((?!-)[A-Za-z0-9-]{1,63}(?<!-)\\.)+[A-Za-z0-9]{2,63}$","type":"string","description":"The DNS name of the domain.","example":"example.com"},"netbios_name":{"type":"string","description":"The NetBIOS name of the domain.","example":"EXAMPLE"},"primary_account":{"$ref":"#/components/schemas/ADDomainServiceAccountSpec"}},"description":"Specification of untrusted domain."},"ADDomainUpdateSpec":{"required":["ad_domain_advanced_settings","primary_account"],"type":"object","properties":{"ad_domain_advanced_settings":{"$ref":"#/components/schemas/ADDomainAdvancedSettings"},"primary_account":{"$ref":"#/components/schemas/ADDomainServiceAccountSpec"}},"description":"Untrusted domain object to be updated."},"ADSiteInfo":{"type":"object","properties":{"ad_site_name":{"type":"string","description":"Name of the AD Site.","example":"Default-First-Site-Name"}},"description":"Information related to an AD site."},"ADUserChangePasswordSpec":{"required":["key_id","new_encrypted_password","old_encrypted_password","protected_password_key","username"],"type":"object","properties":{"domain":{"type":"string","description":"The domain of user. Note that domain is optional if UPN is supplied.","example":"example.com"},"key_id":{"type":"string","description":"The keyId of the cluster's SSO KeyPair used to encrypt the password key.","example":"ut0yGq7CbhtBUGfW3ngjkvjQ2cc="},"new_encrypted_password":{"type":"string","description":"New password for the user in encrypted format.","example":"4TGdfggfwrrGUPSg4/JK/tYub7lUI8pGtyHd/ty5g8h5="},"old_encrypted_password":{"type":"string","description":"Old password for the user in encrypted format.","example":"9QYxpdXrcrOGPSSz1/K/pJu8QlYT7pDkaKg/rb3hlw4="},"protected_password_key":{"type":"string","description":"Decryption key for the password. This key is itself encrypted with cluster's SSO keypair.","example":"Qvvjglg5iZinyuldroueo/hQFyqydMMDJPmfYGgIebqxbU9chJ9I8iM9SCBRHSkSW9y+RMQOfC"},"username":{"type":"string","description":"The username or UPN.","example":"testuser or testuser@example.com"}},"description":"AD user password object to be changed."},"ADUserEncryptedCredentialSpec":{"required":["encrypted_password","key_id","protected_password_key","username"],"type":"object","properties":{"domain":{"type":"string","description":"The domain of user. Note that domain is optional if UPN is supplied.","example":"example.com"},"encrypted_password":{"type":"string","description":"Encrypted password for the user.","example":"9QYxpdXrcrOGPSSz1/K/pJu8QlYT7pDkaKg/rb3hlw4="},"key_id":{"type":"string","description":"The keyId of the cluster's SSO KeyPair used to encrypt the protectedPasswordKey.","example":"ut0yGq7CbhtBUGfW3ngjkvjQ2cc="},"protected_password_key":{"type":"string","description":"Decryption key for the password. This key is itself encrypted with cluster's SSO keypair.","example":"Qvvjglg5iZinyuldroueo/hQFyqydMMDJPmfYGgIebqxbU9chJ9I8iM9SCBRHSkSW9y+RM"},"username":{"type":"string","description":"The username or UPN.","example":"testuser or testuser@example.com"}},"description":"AD user encrypted credentials object to be validated."},"ADUserInfo":{"type":"object","properties":{"domain":{"type":"string","description":"DNS name of the domain in which this user or group belongs to.","example":"example.com"},"group_guids":{"type":"array","description":"Guids of the user's groups in RFC 4122 format.","example":["5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA","6H8S6Y4-35D3-6534-5ERC-A678E3YG4FAD"],"items":{"type":"string","description":"Guids of the user's groups in RFC 4122 format.","example":"[\"5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA\",\"6H8S6Y4-35D3-6534-5ERC-A678E3YG4FAD\"]"}},"group_sids":{"type":"array","description":"List of unique SIDs of the groups, this user or group belongs to.","example":["S-1-5-21-544","S-1-5-21-1111111111-2222222222-3333333333-513"],"items":{"type":"string","description":"List of unique SIDs of the groups, this user or group belongs to.","example":"[\"S-1-5-21-544\",\"S-1-5-21-1111111111-2222222222-3333333333-513\"]"}},"user_guid":{"type":"string","description":"GUID of the user in RFC 4122 format.","example":"5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA"},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of this user.","example":"testuser@example.com"},"user_sid":{"type":"string","description":"Unique SID representing this AD User.","example":"S-1-5-21-544"},"username":{"type":"string","description":"Username of this user.","example":"testuser"}},"description":"Information related to AD User."},"ADUserOrGroupInfo":{"type":"object","properties":{"container":{"type":"string","description":"AD container for this user or group.","example":"example.com/Users"},"description":{"type":"string","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"Test User account"},"display_name":{"type":"string","description":"Login name with domain of this user or group.","example":"example.com\\\\testuser"},"distinguished_name":{"type":"string","description":"Active Directory distinguished name for this user or group.","example":"CN=Test User,CN=Users,DC=example,DC=com"},"domain":{"type":"string","description":"DNS name of the domain in which this user or group belongs.\nSupported Filters : 'Equals'.\n Also, if 'Or' filter is used anywhere in filter string for this model class, then that 'Or' filter should nest only 'Equals' filter on 'domain' or 'id' field.","example":"example.com"},"email":{"type":"string","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"testuser@example.com"},"first_name":{"type":"string","description":"First name of this user or group.","example":"Test"},"group":{"type":"boolean","description":"Indicates if this object represents a group.\nThis field is NOT supported in filter string. To use any filter on 'group', use 'group_only' query param directly.","example":false},"group_membership_ids":{"type":"array","description":"List of unique SIDs of the groups, this user or group belongs to.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":["S-1-5-21-544","S-1-5-21-1111111111-2222222222-3333333333-513"],"items":{"type":"string","description":"List of unique SIDs of the groups, this user or group belongs to.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"[\"S-1-5-21-544\",\"S-1-5-21-1111111111-2222222222-3333333333-513\"]"}},"guid":{"type":"string","description":"GUID of the user or group in RFC 4122 format.\nSupported Filters : 'Equals'.","example":"5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA"},"id":{"type":"string","description":"Unique SID representing this AD User or Group.\nSupported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"kiosk_user":{"type":"boolean","description":"Indicates if this user or group is a \"kiosk user\" that supports client authentication. Client authentication is the process of supporting client devices directly logging into resources.","example":false},"last_name":{"type":"string","description":"Last name of this user or group.","example":"User"},"login_name":{"type":"string","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"testuser"},"long_display_name":{"type":"string","description":"Login name, domain and name for this user or group, else display name","example":"testuser@example.com (Test User)"},"name":{"type":"string","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"Test User"},"phone":{"type":"string","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"1-877-486-9273"},"sub_group_count":{"type":"integer","description":"Number of subgroups in this group, or 0 if not a group.\n Supported Filters : 'Equals', 'Between'.","format":"int32","example":2},"user_count":{"type":"integer","description":"Number of users in this group, or 0 if not a group.\n Supported Filters : 'Equals', 'Between'.","format":"int32","example":2},"user_display_name":{"type":"string","description":"User or group's display name. This corresponds with displayName attribute in AD.","example":"Test User"},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"testuser@example.com"}},"description":"Information related to AD User or Group."},"ADUserOrGroupInfoV2":{"type":"object","properties":{"container":{"type":"string","description":"AD container for this user or group.","example":"example.com/Users"},"description":{"type":"string","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"Test User account"},"display_name":{"type":"string","description":"Login name with domain of this user or group.","example":"example.com\\\\testuser"},"distinguished_name":{"type":"string","description":"Active Directory distinguished name for this user or group.","example":"CN=Test User,CN=Users,DC=example,DC=com"},"domain":{"type":"string","description":"DNS name of the domain in which this user or group belongs.\nSupported Filters : 'Equals'.\n Also, if 'Or' filter is used anywhere in filter string for this model class, then that 'Or' filter should nest only 'Equals' filter on 'domain' or 'id' field.","example":"example.com"},"email":{"type":"string","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"testuser@example.com"},"first_name":{"type":"string","description":"First name of this user or group.","example":"Test"},"group":{"type":"boolean","description":"Indicates if this object represents a group.\nThis field is NOT supported in filter string. To use any filter on 'group', use 'group_only' query param directly.","example":false},"group_membership_guids":{"type":"array","description":"List of unique GUIDs of the groups, this user or group belongs to.","example":["5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA","6F5A45D9-15C0-4654-8FCF-D589C0EF3ECB"],"items":{"type":"string","description":"List of unique GUIDs of the groups, this user or group belongs to.","example":"[\"5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA\",\"6F5A45D9-15C0-4654-8FCF-D589C0EF3ECB\"]"}},"group_membership_ids":{"type":"array","description":"List of unique SIDs of the groups, this user or group belongs to.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":["S-1-5-21-544","S-1-5-21-1111111111-2222222222-3333333333-513"],"items":{"type":"string","description":"List of unique SIDs of the groups, this user or group belongs to.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"[\"S-1-5-21-544\",\"S-1-5-21-1111111111-2222222222-3333333333-513\"]"}},"guid":{"type":"string","description":"GUID of the user or group in RFC 4122 format.\nSupported Filters : 'Equals'.","example":"5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA"},"id":{"type":"string","description":"Unique SID representing this AD User or Group.\nSupported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"kiosk_user":{"type":"boolean","description":"Indicates if this user or group is a \"kiosk user\" that supports client authentication. Client authentication is the process of supporting client devices directly logging into resources.","example":false},"last_name":{"type":"string","description":"Last name of this user or group.","example":"User"},"login_name":{"type":"string","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"testuser"},"long_display_name":{"type":"string","description":"Login name, domain and name for this user or group, else display name","example":"testuser@example.com (Test User)"},"name":{"type":"string","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"Test User"},"phone":{"type":"string","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"1-877-486-9273"},"sub_group_count":{"type":"integer","description":"Number of subgroups in this group, or 0 if not a group.\n Supported Filters : 'Equals', 'Between'.","format":"int32","example":2},"user_count":{"type":"integer","description":"Number of users in this group, or 0 if not a group.\n Supported Filters : 'Equals', 'Between'.","format":"int32","example":2},"user_display_name":{"type":"string","description":"User or group's display name. This corresponds with displayName attribute in AD.","example":"Test User"},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"testuser@example.com"}},"description":"Information related to AD User or Group."},"ADUserOrGroupInfoV4":{"type":"object","properties":{"container":{"type":"string","description":"AD container for this user or group.","example":"example.com/Users"},"description":{"type":"string","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"Test User account"},"display_name":{"type":"string","description":"Login name with domain of this user or group.","example":"example.com\\\\testuser"},"distinguished_name":{"type":"string","description":"Active Directory distinguished name for this user or group.","example":"CN=Test User,CN=Users,DC=example,DC=com"},"domain":{"type":"string","description":"DNS name of the domain in which this user or group belongs.\nSupported Filters : 'Equals'.\n Also, if 'Or' filter is used anywhere in filter string for this model class, then that 'Or' filter should nest only 'Equals' filter on 'domain' or 'id' field.","example":"example.com"},"domain_net_biosname":{"type":"string","description":"netbios name of the domain which this user belongs to.","example":"MYDOMAIN"},"email":{"type":"string","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"testuser@example.com"},"first_name":{"type":"string","description":"First name of this user or group.","example":"Test"},"group":{"type":"boolean","description":"Indicates if this object represents a group.\nThis field is NOT supported in filter string. To use any filter on 'group', use 'group_only' query param directly.","example":false},"group_membership_guids":{"type":"array","description":"List of unique GUIDs of the groups, this user or group belongs to.","example":["5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA","6F5A45D9-15C0-4654-8FCF-D589C0EF3ECB"],"items":{"type":"string","description":"List of unique GUIDs of the groups, this user or group belongs to.","example":"[\"5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA\",\"6F5A45D9-15C0-4654-8FCF-D589C0EF3ECB\"]"}},"group_membership_ids":{"type":"array","description":"List of unique SIDs of the groups, this user or group belongs to.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":["S-1-5-21-544","S-1-5-21-1111111111-2222222222-3333333333-513"],"items":{"type":"string","description":"List of unique SIDs of the groups, this user or group belongs to.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"[\"S-1-5-21-544\",\"S-1-5-21-1111111111-2222222222-3333333333-513\"]"}},"guid":{"type":"string","description":"GUID of the user or group in RFC 4122 format.\nSupported Filters : 'Equals'.","example":"5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA"},"id":{"type":"string","description":"Unique SID representing this AD User or Group.\nSupported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"kiosk_user":{"type":"boolean","description":"Indicates if this user or group is a \"kiosk user\" that supports client authentication. Client authentication is the process of supporting client devices directly logging into resources.","example":false},"last_name":{"type":"string","description":"Last name of this user or group.","example":"User"},"login_name":{"type":"string","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"testuser"},"long_display_name":{"type":"string","description":"Login name, domain and name for this user or group, else display name","example":"testuser@example.com (Test User)"},"name":{"type":"string","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"Test User"},"phone":{"type":"string","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"1-877-486-9273"},"sub_group_count":{"type":"integer","description":"Number of subgroups in this group, or 0 if not a group.\n Supported Filters : 'Equals', 'Between'.","format":"int32","example":2},"unauthenticated_user":{"type":"boolean","description":"Indicates whether the user is unauthenticated access user or not.\n Supported Filters : 'Equals'.","example":false},"user_count":{"type":"integer","description":"Number of users in this group, or 0 if not a group.\n Supported Filters : 'Equals', 'Between'.","format":"int32","example":2},"user_display_name":{"type":"string","description":"User or group's display name. This corresponds with displayName attribute in AD.","example":"Test User"},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"testuser@example.com"}},"description":"Summary information related to AD Users or Groups.\nList API returning this summary information can use search filter query to filter on specific fields supported by filters.\nSupported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'.\nSee the field description to know the filter types it supports."},"ADUserOrGroupSummary":{"type":"object","properties":{"container":{"type":"string","description":"AD container for this user or group.","example":"example.com/Users"},"description":{"type":"string","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"Test User account"},"display_name":{"type":"string","description":"Login name with domain of this user or group.","example":"example.com\\\\testuser"},"distinguished_name":{"type":"string","description":"Active Directory distinguished name for this user or group.","example":"CN=Test User,CN=Users,DC=example,DC=com"},"domain":{"type":"string","description":"DNS name of the domain in which this user or group belongs.\nSupported Filters : 'Equals'.\n Also, if 'Or' filter is used anywhere in filter string for this model class, then that 'Or' filter should nest only 'Equals' filter on 'domain' or 'id' field.","example":"example.com"},"email":{"type":"string","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"testuser@example.com"},"first_name":{"type":"string","description":"First name of this user or group.","example":"Test"},"group":{"type":"boolean","description":"Indicates if this object represents a group.\nThis field is NOT supported in filter string. To use any filter on 'group', use 'group_only' query param directly.","example":false},"guid":{"type":"string","description":"GUID of the user or group in RFC 4122 format.\nSupported Filters : 'Equals'.","example":"5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA"},"id":{"type":"string","description":"Unique SID representing this AD User or Group.\nSupported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"kiosk_user":{"type":"boolean","description":"Indicates if this user or group is a \"kiosk user\" that supports client authentication. Client authentication is the process of supporting client devices directly logging into resources.","example":false},"last_name":{"type":"string","description":"Last name of this user or group.","example":"User"},"login_name":{"type":"string","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"testuser"},"long_display_name":{"type":"string","description":"Login name, domain and name for this user or group, else display name","example":"testuser@example.com (Test User)"},"name":{"type":"string","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"Test User"},"phone":{"type":"string","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"1-877-486-9273"},"user_display_name":{"type":"string","description":"User or group's display name. This corresponds with displayName attribute in AD.","example":"Test User"},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"testuser@example.com"}},"description":"Summary information related to AD Users or Groups.\n List API returning this summary information can use search filter query to filter on specific fields supported by filters.\n Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'.\nSee the field description to know the filter types it supports."},"APIError":{"type":"object","properties":{"error_key":{"type":"string","description":"Error key configured in message bundle.","example":"inventory.machine.not.found"},"error_message":{"type":"string","description":"Error message translated in user's locale.","example":"username cannot be empty"}},"description":"Response for each API which results in error.<br>Contains a unique error key and localised version of error message."},"AWSBundleInfo":{"type":"object","properties":{"description":{"type":"string","description":"The description of the AWS core bundle","example":" description "},"hardware":{"type":"string","description":"The hardware of the AWS core bundle","example":" description "},"id":{"type":"string","description":"The ID of the AWS core bundle","example":" id "},"last_update_time":{"type":"integer","description":"The last time that the bundle was updated","format":"int64","example":1709149129173},"name":{"type":"string","description":"The name of the AWS core bundle","example":" name "},"operating_system":{"type":"string","description":"The operating system of the AWS core bundle","example":" Windows10 "},"state":{"type":"string","description":"The state of the AWS core bundle","example":" AVAILABLE "}},"description":"Information about an AWS bundle."},"AWSDirectoryInfo":{"type":"object","properties":{"alias":{"type":"string","description":"The alias of the AWS core directory","example":" alias "},"id":{"type":"string","description":"The ID of the AWS core directory","example":" id "},"name":{"type":"string","description":"The name of the AWS core directory","example":" Directory_1 "}},"description":"Information about an AWS core directory."},"AWSImageInfo":{"type":"object","properties":{"description":{"type":"string","description":"The description of the AWS core image","example":" description "},"id":{"type":"string","description":"The ID of the AWS core image","example":" id "},"name":{"type":"string","description":"The name of the AWS core image","example":" name "},"state":{"type":"string","description":"The state of the AWS core image","example":" AVAILABLE "}},"description":"Information about an AWS image."},"AWSRegionInfo":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the AWS region","example":" us-east-1 "},"name":{"type":"string","description":"The name of the AWS region","example":" US East (N. Virginia) "}},"description":"Information about an AWS core region."},"AccessToken":{"required":["access_token"],"type":"object","properties":{"access_token":{"type":"string","description":"Access Token to be used in API calls.","example":"<jwt.access.token>"}},"description":"Access Token"},"AdminUserOrGroupPermissionsInfo":{"type":"object","properties":{"federated_privileges_info":{"type":"array","description":"Set of privileges information based on federated access groups for this user or group.","items":{"$ref":"#/components/schemas/AdminUserOrGroupPrivilegesInfo"}},"help_desk_admin":{"type":"boolean"},"id":{"type":"string","description":"Unique SID representing the admin user or group.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"local_privileges_info":{"type":"array","description":"Set of privileges information based on local access groups for this user or group.","items":{"$ref":"#/components/schemas/AdminUserOrGroupPrivilegesInfo"}}},"description":"Information about admin user or group permissions."},"AdminUserOrGroupPreferencesInfo":{"type":"object","properties":{"admin_timeout_in_minutes":{"type":"integer","description":"UI console session timeout preference in minutes for Horizon Console.","format":"int32","example":400},"grid_preferences":{"type":"object","additionalProperties":{"type":"array","description":"Grid preferences for data grids on Horizon Console. Each entry will be the list of hidden columns for a grid identifier.","example":{"desktopsListing":["DisplayName","Type"]},"items":{"type":"string","description":"Grid preferences for data grids on Horizon Console. Each entry will be the list of hidden columns for a grid identifier.","example":"{\"desktopsListing\":[\"DisplayName\",\"Type\"]}"}},"description":"Grid preferences for data grids on Horizon Console. Each entry will be the list of hidden columns for a grid identifier.","example":{"desktopsListing":["DisplayName","Type"]}}},"description":"Preferences for administrators of Horizon Console."},"AdminUserOrGroupPreferencesInfoV2":{"type":"object","properties":{"admin_timeout_in_minutes":{"type":"integer","description":"UI console session timeout preference in minutes for Horizon Console.","format":"int32","example":400},"display_subscription_banner":{"type":"boolean","description":"Indicates whether a banner should be shown to prompt the customers with HUL license to connect to Titan CP and move to subscription based license.","example":true},"grid_preferences":{"type":"object","additionalProperties":{"type":"array","description":"Grid preferences for data grids on Horizon Console. Each entry will be the list of hidden columns for a grid identifier.","example":{"desktopsListing":["DisplayName","Type"]},"items":{"type":"string","description":"Grid preferences for data grids on Horizon Console. Each entry will be the list of hidden columns for a grid identifier.","example":"{\"desktopsListing\":[\"DisplayName\",\"Type\"]}"}},"description":"Grid preferences for data grids on Horizon Console. Each entry will be the list of hidden columns for a grid identifier.","example":{"desktopsListing":["DisplayName","Type"]}}},"description":"Preferences for administrators of Horizon Console."},"AdminUserOrGroupPreferencesUpdateSpec":{"type":"object","properties":{"admin_timeout_in_minutes":{"minimum":2,"type":"integer","description":"UI console session timeout preference in minutes for Horizon Console.","format":"int32","example":400},"grid_preferences":{"type":"object","additionalProperties":{"type":"array","description":"Grid preferences for data grids on Horizon Console.","example":{"desktopsListing":["DisplayName","Type"]},"items":{"type":"string","description":"Grid preferences for data grids on Horizon Console.","example":"{\"desktopsListing\":[\"DisplayName\",\"Type\"]}"}},"description":"Grid preferences for data grids on Horizon Console.","example":{"desktopsListing":["DisplayName","Type"]}}},"description":"Information required to update Horizon Console administrator preferences."},"AdminUserOrGroupPreferencesUpdateSpecV2":{"type":"object","properties":{"admin_timeout_in_minutes":{"minimum":2,"type":"integer","description":"UI console session timeout preference in minutes for Horizon Console.","format":"int32","example":400},"display_subscription_banner":{"type":"boolean","description":"Indicates whether a banner should be shown to prompt the customers with HUL license to connect to Titan CP and move to subscription based license.","example":true},"grid_preferences":{"type":"object","additionalProperties":{"type":"array","description":"Grid preferences for data grids on Horizon Console.","example":{"desktopsListing":["DisplayName","Type"]},"items":{"type":"string","description":"Grid preferences for data grids on Horizon Console.","example":"{\"desktopsListing\":[\"DisplayName\",\"Type\"]}"}},"description":"Grid preferences for data grids on Horizon Console.","example":{"desktopsListing":["DisplayName","Type"]}}},"description":"Information required to update Horizon Console administrator preferences."},"AdminUserOrGroupPrivilegesInfo":{"type":"object","properties":{"access_group_id":{"type":"string","description":"ID of the access group.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"access_group_name":{"type":"string","description":"Name of the access group.","example":"root"},"privileges":{"uniqueItems":true,"type":"array","description":"The set of privileges on the access group.","example":["VC_CONFIG_VIEW","FEDERATED_LDAP_MANAGE","GLOBAL_CONFIG_MANAGEMENT"],"items":{"type":"string","description":"* ADMINISTRATOR_VIEW: Full read only administrator privilege, including Multi-Datacenter View configuration. This is a non-selectable privilege.\n* VC_CONFIG_VIEW: Manage vCenter Configuration (Read Only).\n* LOG_COLLECTION: Collect Operation Logs.\n* FORENSICS: Manage Forensics Operations.\n* MANAGE_CERTIFICATES: Manage Certificates.\n* LCM_MANAGEMENT: Manage Server Life Cycle Management Operations.\n* LCM_VIEW: Manage Server Life Cycle Management Operations (Read Only).\n* LOCAL_ADMINISTRATOR: Full administrator privilege, except to Multi-Datacenter View configuration and to manage roles and privileges. This is a non-selectable privilege.\n* LOCAL_ADMINISTRATOR_VIEW: Full read only administrator privilege, except to Multi-Datacenter View configuration. This is a non-selectable privilege.\n* INVENTORY_ADMINISTRATOR: Access to all inventory objects. This is a non-selectable privilege.\n* INVENTORY_ADMINISTRATOR_VIEW: Read only access to all inventory objects. This is a non-selectable privilege.\n* HELPDESK_ADMINISTRATOR: Manage Help Desk. This is a non-selectable privilege.\n* HELPDESK_ADMINISTRATOR_VIEW: Manage Help Desk (Read only).\n* FEDERATED_LDAP_MANAGE: Manage Pod Federation. \n* FEDERATED_LDAP_VIEW: Manage Global LDAP (Read only). This is a non-selectable privilege.\n* FEDERATED_SESSIONS_MANAGE: Manage Federated Sessions.\n* FEDERATED_SESSIONS_VIEW: Manage Federated Sessions (Read only). This is a non-selectable privilege.\n* GLOBAL_ADMINISTRATOR: Manage Global Configuration. This is a non-selectable privilege.\n* GLOBAL_ADMINISTRATOR_VIEW: Manage Global Configuration (Read only). This is a non-selectable privilege.\n* GLOBAL_ADMIN_UI_INTERACTIVE: Can log into View Administrator. This is a non-selectable privilege.\n* GLOBAL_ADMIN_SDK_INTERACTIVE: Can run all command line utilities and PowerShell commands. This is a non-selectable privilege.\n* GLOBAL_MACHINE_REGISTER: Register non-vCenter machine sources such as Windows Terminal Servers and physical PCs.\n* GLOBAL_ROLE_PERMISSION_MANAGEMENT: Add, modify, and delete administrator roles and permissions.\n* GLOBAL_ROLE_MANAGEMENT: Add, modify, and delete administrator roles. This is a non-selectable privilege.\n* GLOBAL_ROLE_VIEW: Read only access to administrator roles. This is a non-selectable privilege.\n* GLOBAL_PERMISSION_VIEW: Read only access to administrator permissions. This is a non-selectable privilege.\n* GLOBAL_PERMISSION_MANAGEMENT: Add, modify, and delete administrator permissions. This is a non-selectable privilege.\n* GLOBAL_CONFIG_VIEW: Read only access to global (non-inventory) policy, configuration, and RDS server settings, except administrator roles and permissions and global (Multi-Datacenter View) LDAP. This is a non-selectable privilege.\n* GLOBAL_CONFIG_MANAGEMENT: View and change global (non-inventory) policy, configuration, and RDS server settings, except for administrator roles and permissions.\n* FOLDER_MANAGEMENT: Add, modify, and delete access groups.\n* FOLDER_VIEW: Read only access to access groups. This is a non-selectable privilege.\n* POOL_VIEW: Read only access to desktop pools, farms, applications, their local sessions, and their machines. This is a non-selectable privilege.\n* POOL_MANAGEMENT: Add, modify, and delete desktop pools, applications and farms. Add and remove machines from desktop pools.\n* POOL_ENABLE: Enable and disable desktop pools, farms, and applications.\n* POOL_ENTITLE: Add and remove desktop pool and application entitlements.\n* POOL_SVI_IMAGE_MANAGEMENT: Schedule push image, schedule maintenance and change default image for desktop pool and farm.\n* MACHINE_VIEW: Read only access to machines and their local sessions. This is a non-selectable privilege.\n* MACHINE_MANAGEMENT: Perform all machine and session-related commands.\n* MACHINE_REBOOT: Reset local machines.\n* MACHINE_SHUTDOWN: Shutdown local machines.\n* MACHINE_MANAGE_VDI_SESSION: Disconnect, logoff, and send messages to local sessions.\n* MACHINE_MANAGE_OFFLINE_SESSION: Roll back offline sessions and initiate replications.\n* MACHINE_USER_MANAGEMENT: Assign and un-assign users for machines, Update machine aliases for machines.\n* MACHINE_MAINTENANCE: Put machine in and out of maintenance mode.\n* MANAGE_REMOTE_PROCESS: Manage Remote Processes and Applications.\n* REMOTE_ASSISTANCE: Remote Assistance to Remote desktop pool.\n* GLOBAL_CVP_REGISTER: Global CVP Register. This is a non-selectable privilege.\n* GLOBAL_CVP_PUBLICATION: Global CVP Publication. This is a non-selectable privilege.\n* CVP_INTERACTIVE: CVP Interactive. This is a non-selectable privilege.\n* CVP_VIEW: CVP View. This is a non-selectable privilege.\n* CVP_MANAGEMENT: CVP Management.This is a non-selectable privilege.\n* CVP_OWNERSHIP: CVP Ownership.This is a non-selectable privilege.\n* API_SMART_CARD_BYPASS: Allows API's credential based login when smart card authentication mode is REQUIRED.\n* UDD_VIEW: Read only access to persistent disks. This is a non-selectable privilege.\n* UDD_MANAGEMENT: Manage persistent disks.\n* HORIZON_CLOUD_SERVICE: Allows subscription license activation and cloud monitoring through horizon cloud service.\n* SUBSCRIPTION_LICENSE_ADD: Allows subscription license activation.\n* CLOUD_ADMIN: Allows Cloud Admin Authentication.\n* CLOUD_ON_BOARDING_MANAGEMENT: Allows Cloud on-boarding.\n* CLOUD_OPS_MANAGEMENT: Allows Cloud operations post on-boarding.\n* CAPACITY_PROVIDER_CONFIG_VIEW: Manage Capacity Provider Configuration (Read Only).\n* CAPACITY_PROVIDER_CONFIG_MANAGEMENT: Manage Capacity Provider Configuration.\n* MANAGE_EXTERNAL_KEYS: Manage External Keys.\n* UNKNOWN_PRIVILEGE: Unknown Privilege type. This is a non-selectable privilege.","example":"[\"VC_CONFIG_VIEW\",\"FEDERATED_LDAP_MANAGE\",\"GLOBAL_CONFIG_MANAGEMENT\"]","enum":["ADMINISTRATOR","ADMINISTRATOR_VIEW","VC_CONFIG_VIEW","LOG_COLLECTION","FORENSICS","MANAGE_CERTIFICATES","LCM_MANAGEMENT","LCM_VIEW","LOCAL_ADMINISTRATOR","LOCAL_ADMINISTRATOR_VIEW","INVENTORY_ADMINISTRATOR","INVENTORY_ADMINISTRATOR_VIEW","HELPDESK_ADMINISTRATOR","HELPDESK_ADMINISTRATOR_VIEW","FEDERATED_LDAP_MANAGE","FEDERATED_LDAP_VIEW","FEDERATED_SESSIONS_MANAGE","FEDERATED_SESSIONS_VIEW","GLOBAL_ADMINISTRATOR","GLOBAL_ADMINISTRATOR_VIEW","GLOBAL_ADMIN_UI_INTERACTIVE","GLOBAL_ADMIN_SDK_INTERACTIVE","GLOBAL_MACHINE_REGISTER","GLOBAL_ROLE_PERMISSION_MANAGEMENT","GLOBAL_ROLE_MANAGEMENT","GLOBAL_ROLE_VIEW","GLOBAL_PERMISSION_VIEW","GLOBAL_PERMISSION_MANAGEMENT","GLOBAL_CONFIG_VIEW","GLOBAL_CONFIG_MANAGEMENT","FOLDER_MANAGEMENT","FOLDER_VIEW","POOL_VIEW","POOL_MANAGEMENT","POOL_ENABLE","POOL_ENTITLE","POOL_SVI_IMAGE_MANAGEMENT","MACHINE_VIEW","MACHINE_MANAGEMENT","MACHINE_REBOOT","MACHINE_SHUTDOWN","MACHINE_MANAGE_VDI_SESSION","MACHINE_MANAGE_OFFLINE_SESSION","MACHINE_USER_MANAGEMENT","MACHINE_MAINTENANCE","MANAGE_REMOTE_PROCESS","REMOTE_ASSISTANCE","GLOBAL_CVP_REGISTER","GLOBAL_CVP_PUBLICATION","CVP_INTERACTIVE","CVP_VIEW","CVP_MANAGEMENT","CVP_OWNERSHIP","API_SMART_CARD_BYPASS","UDD_VIEW","UDD_MANAGEMENT","HORIZON_CLOUD_SERVICE","SUBSCRIPTION_LICENSE_ADD","CLOUD_ADMIN","CLOUD_ON_BOARDING_MANAGEMENT","CLOUD_OPS_MANAGEMENT","CAPACITY_PROVIDER_CONFIG_VIEW","CAPACITY_PROVIDER_CONFIG_MANAGEMENT","MANAGE_EXTERNAL_KEYS","UNKNOWN_PRIVILEGE"]}}},"description":"Information about admin user or group privileges."},"AgentData_Machines":{"type":"object","properties":{"agent_type":{"type":"string","description":"agent type","example":"Omnissa-Telemetry-Agent"},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"build":{"type":"string","description":"agent build","example":"13255868801"},"has_new_agent_version":{"type":"boolean","description":"newer agent version is available","example":true},"last_update_date_time":{"type":"string","description":"Date of the last agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"version":{"type":"string","description":"agent version","example":"1.2.0"}},"description":"Information related to agents"},"AgentData_RDSServer":{"type":"object","properties":{"agent_type":{"type":"string","description":"agent type","example":"Omnissa-Telemetry-Agent"},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"build":{"type":"string","description":"agent build","example":"13255868801"},"has_new_agent_version":{"type":"boolean","description":"newer agent version is available","example":true},"last_update_date_time":{"type":"string","description":"Date of the last agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"version":{"type":"string","description":"agent version","example":"1.2.0"}},"description":"Information related to agents."},"AgentInstallerPackageInfo":{"type":"object","properties":{"build_number":{"type":"string","description":"Build number of the installer.\nSupported Filters: 'Equals', 'StartsWith'.\nThis property can be used for sorting.","example":"12345678","deprecated":true},"id":{"type":"string","description":"Unique identifier for this agent installer package.Supported Filters : 'Equals'. 'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"087ae070-602e-4498-b67c-d7f5807ab5e4"},"url":{"type":"string","description":"URL of the installer executable.\nSupported Filters: 'Equals' ,'Contains' , 'StartsWith'.\nThis property can be used for sorting.","example":"https://example.com/build.exe"},"version":{"type":"string","description":"Version of the installer MSI.\nSupported Filters: 'Equals', 'StartsWith'.\nThis property can be used for sorting.","example":"8.5.0","deprecated":true}},"description":"Information about a registered agent installer package.Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'.<br>See the field description to know the filter types it supports."},"AgentInstallerPackageInfoV2":{"type":"object","properties":{"agent_name":{"type":"string","description":"Agent name\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"Omnissa-Telemetry-Agent"},"build_number":{"type":"string","description":"Build number of the installer.\nSupported Filters: 'Equals', 'StartsWith'.\nThis property can be used for sorting.","example":"12345678","deprecated":true},"id":{"type":"string","description":"Unique identifier for this agent installer package.Supported Filters : 'Equals'. 'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"087ae070-602e-4498-b67c-d7f5807ab5e4"},"url":{"type":"string","description":"URL of the installer executable.\nSupported Filters: 'Equals' ,'Contains' , 'StartsWith'.\nThis property can be used for sorting.","example":"https://example.com/build.exe"},"version":{"type":"string","description":"Version of the installer MSI.\nSupported Filters: 'Equals', 'StartsWith'.\nThis property can be used for sorting.","example":"8.5.0","deprecated":true}},"description":"Information about a registered agent installer package.Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'.<br>See the field description to know the filter types it supports."},"AgentInstallerPackageInfoV3":{"type":"object","properties":{"agent_build":{"type":"string","description":"Agent build of the agent installer package.\nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"8.5.0-1020202"},"agent_name":{"type":"string","description":"Agent name\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"Omnissa-Telemetry-Agent"},"build_number":{"type":"string","description":"Build number of the installer.\nSupported Filters: 'Equals', 'StartsWith'.\nThis property can be used for sorting.","example":"12345678","deprecated":true},"id":{"type":"string","description":"Unique identifier for this agent installer package.Supported Filters : 'Equals'. 'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"087ae070-602e-4498-b67c-d7f5807ab5e4"},"url":{"type":"string","description":"URL of the installer executable.\nSupported Filters: 'Equals' ,'Contains' , 'StartsWith'.\nThis property can be used for sorting.","example":"https://example.com/build.exe"},"version":{"type":"string","description":"Version of the installer MSI.\nSupported Filters: 'Equals', 'StartsWith'.\nThis property can be used for sorting.","example":"8.5.0","deprecated":true}},"description":"Information about a registered agent installer package.Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'.<br>See the field description to know the filter types it supports."},"AgentInstallerPackageRegisterResponseInfo":{"type":"object","properties":{"agent_installer_package_id":{"type":"string","description":"Id of the installer registered.","example":"d49e4ffa-2238-4bc7-a292-539b2ea96548"}},"description":"Response for agent installer package register operation."},"AgentInstallerPackageRegisterSpec":{"required":["metadata_file_url"],"type":"object","properties":{"metadata_file_url":{"type":"string","description":"URL of the metadata file concerning the agent installer package which is to be registered.","example":"https://example.com/metadata.json"}},"description":"Agent installer package to be registered"},"AgentInstallerPackageRegisterSpecV2":{"required":["metadata_file_url","path_type"],"type":"object","properties":{"metadata_file_url":{"type":"string","description":"URL of the metadata file concerning the agent installer package which is to be registered.","example":"https://example.com/metadata.json"},"path_type":{"type":"string","description":"Indicates the path type for Agent installer package URL or SMB.\n","example":"URL","enum":["SMB","URL"]}},"description":"Agent installer package to be registered"},"AgentRestrictionSettingsInfo":{"type":"object","properties":{"restricted_agent_data":{"type":"array","description":"Information related to restricted Horizon Agents.","items":{"$ref":"#/components/schemas/RestrictedAgentInfo"}},"restricted_agent_message":{"type":"string","description":"The message to be displayed to Horizon clients when agent version of requested session are blocked by the Connection Server.","example":"The system does not support this version of the Horizon Agent."}},"description":"Information related to agent restriction settings."},"AgentRestrictionSettingsUpdateSpec":{"type":"object","properties":{"restricted_agent_data":{"type":"array","description":"Information related to restricted Horizon Agents.","items":{"$ref":"#/components/schemas/RestrictedAgentUpdateSpec"}},"restricted_agent_message":{"type":"string","description":"The message to be displayed to Horizon clients when agent version of requested session are blocked by the Connection Server.","example":"The system does not support this version of the Horizon Agent."}},"description":"Agent restriction settings object to be updated."},"AgentUpgradeData":{"type":"object","properties":{"error_message":{"type":"string","description":"error message.","example":"AGENT_LOGGED_IN_USERS"},"id":{"type":"string","description":"Machines or RDS servers id.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"}},"description":"Information related to agents part of task."},"AgentUpgradeDataV2":{"type":"object","properties":{"error_description":{"type":"string","description":"Additional error description. This is only populated for failed upgrades.","example":"1603 (Fatal error during installation.) - The system must be updated and rebooted before installation can continue."},"error_message":{"type":"string","description":"error message.","example":"AGENT_LOGGED_IN_USERS"},"id":{"type":"string","description":"Machines or RDS servers id.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"}},"description":"Information related to agents part of task."},"AgentUpgradeData_history":{"type":"object","properties":{"error_message":{"type":"string","description":"error message.","example":"AGENT_LOGGED_IN_USERS"},"id":{"type":"string","description":"Machines or RDS servers id.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"}},"description":"Information related to agents part of task."},"AgentUpgradeData_historyV2":{"type":"object","properties":{"error_description":{"type":"string","description":"Additional error description. This is only populated for failed upgrades.","example":"1603 (Fatal error during installation.) - The system must be updated and rebooted before installation can continue."},"error_message":{"type":"string","description":"error message.","example":"AGENT_LOGGED_IN_USERS"},"id":{"type":"string","description":"Machines or RDS servers id.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"}},"description":"Information related to agents part of task. Populated only for past 2 weeks data from tracker."},"AgentUpgradeHistoryInfo":{"type":"object","properties":{"agent_build":{"type":"string","description":"Build to which the agents were upgraded.\nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"8.10.0-12345678"},"cancelled_count":{"type":"integer","description":"Number of machines/RDS servers for which the upgrade was cancelled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int32","example":5},"failed_count":{"type":"integer","description":"Number of machines/RDS servers for which the upgrade failed.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int32","example":10},"skipped_count":{"type":"integer","description":"Number of machines/RDS servers for which the upgrade was skipped.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int32","example":10},"succeeded_count":{"type":"integer","description":"Number of machines/RDS servers for which the upgrade succeeded.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int32","example":20},"task_id":{"type":"string","description":"Task id for the agent upgrade.","example":"7e0db15d-9c07-47b1-8e3a-f450adcac002"},"upgrade_window_end_time":{"type":"integer","description":"Time at which the upgrade window ended.\nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1665417715000},"upgrade_window_start_time":{"type":"integer","description":"Time at which the upgrade window started.\nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1660417715000}},"description":"Information about agent upgrade history.<br>List API returning this summary information can use search filter  query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'Between', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"AgentUpgradeHistoryInfoV2":{"type":"object","properties":{"agent_build":{"type":"string","description":"Build to which the agents were upgraded.\nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"8.10.0-12345678"},"agent_type":{"type":"string","description":"Type of the Agent that was upgraded.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"HZN-Agent"},"cancelled_count":{"type":"integer","description":"Number of machines/RDS servers for which the upgrade was cancelled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int32","example":5},"cancelled_machines_or_rds_servers_data":{"type":"array","description":"List of Machines or RDS servers for which upgrade has been cancelled.Populated only for past 2 weeks data from tracker","items":{"$ref":"#/components/schemas/AgentUpgradeData_history"}},"failed_count":{"type":"integer","description":"Number of machines/RDS servers for which the upgrade failed.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int32","example":10},"failed_machines_or_rds_servers_data":{"type":"array","description":"List of Machines or RDS servers for which upgrade has failed.Populated only for past 2 weeks data from tracker","items":{"$ref":"#/components/schemas/AgentUpgradeData_history"}},"not_started_machine_or_rds_server_ids":{"type":"array","description":"List of Machines or RDS servers for which upgrade has not started.Populated only for past 2 weeks data from tracker","items":{"type":"string","description":"List of Machines or RDS servers for which upgrade has not started.Populated only for past 2 weeks data from tracker"}},"skipped_count":{"type":"integer","description":"Number of machines/RDS servers for which the upgrade was skipped.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int32","example":10},"skipped_machines_or_rds_servers_data":{"type":"array","description":"List of Machines or RDS servers for which upgrade has skipped.Populated only for past 2 weeks data from tracker","items":{"$ref":"#/components/schemas/AgentUpgradeData_history"}},"succeeded_count":{"type":"integer","description":"Number of machines/RDS servers for which the upgrade succeeded.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int32","example":20},"succeeded_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has succeeded.Populated only for past 2 weeks data from tracker","items":{"type":"string","description":"Machines or RDS servers for which upgrade has succeeded.Populated only for past 2 weeks data from tracker"}},"task_id":{"type":"string","description":"Task id for the agent upgrade.","example":"7e0db15d-9c07-47b1-8e3a-f450adcac002"},"task_name":{"type":"string","description":"Task name for the agent upgrade.\nSupported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"updateJob-01"},"upgrade_window_end_time":{"type":"integer","description":"Time at which the upgrade window ended.\nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1665417715000},"upgrade_window_start_time":{"type":"integer","description":"Time at which the upgrade window started.\nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1660417715000}},"description":"Information about agent upgrade history.<br>List API returning this summary information can use search filter  query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'Between', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"AgentUpgradeHistoryInfoV3":{"type":"object","properties":{"agent_build":{"type":"string","description":"Build to which the agents were upgraded.\nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"8.10.0-12345678"},"agent_type":{"type":"string","description":"Type of the Agent that was upgraded.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"HZN-Agent"},"cancelled_count":{"type":"integer","description":"Number of machines/RDS servers for which the upgrade was cancelled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int32","example":5},"cancelled_machines_or_rds_servers_data":{"type":"array","description":"List of Machines or RDS servers for which upgrade has been cancelled.Populated only for past 2 weeks data from tracker","items":{"$ref":"#/components/schemas/AgentUpgradeData_history"}},"failed_count":{"type":"integer","description":"Number of machines/RDS servers for which the upgrade failed.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int32","example":10},"failed_machines_or_rds_servers_data_v2":{"type":"array","description":"List of Machines or RDS servers for which upgrade has been failed.","items":{"$ref":"#/components/schemas/AgentUpgradeData_historyV2"}},"machine_type":{"type":"string","description":"The type of machine. Supported machined types are MANAGED_MACHINE, UNMANAGED_MACHINE, AWS_CORE_MACHINE. This property will only be set for agent upgrade task for machines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"MANAGED_MACHINE"},"not_started_machine_or_rds_server_ids":{"type":"array","description":"List of Machines or RDS servers for which upgrade has not started.Populated only for past 2 weeks data from tracker","items":{"type":"string","description":"List of Machines or RDS servers for which upgrade has not started.Populated only for past 2 weeks data from tracker"}},"skipped_count":{"type":"integer","description":"Number of machines/RDS servers for which the upgrade was skipped.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int32","example":10},"skipped_machines_or_rds_servers_data":{"type":"array","description":"List of Machines or RDS servers for which upgrade has skipped.Populated only for past 2 weeks data from tracker","items":{"$ref":"#/components/schemas/AgentUpgradeData_history"}},"succeeded_count":{"type":"integer","description":"Number of machines/RDS servers for which the upgrade succeeded.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int32","example":20},"succeeded_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has succeeded.Populated only for past 2 weeks data from tracker","items":{"type":"string","description":"Machines or RDS servers for which upgrade has succeeded.Populated only for past 2 weeks data from tracker"}},"task_id":{"type":"string","description":"Task id for the agent upgrade.","example":"7e0db15d-9c07-47b1-8e3a-f450adcac002"},"task_name":{"type":"string","description":"Task name for the agent upgrade.\nSupported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"updateJob-01"},"upgrade_rds_servers":{"type":"boolean","description":"Indicates whether the agent upgrade was scheduled for rds servers.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"upgrade_window_end_time":{"type":"integer","description":"Time at which the upgrade window ended.\nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1665417715000},"upgrade_window_start_time":{"type":"integer","description":"Time at which the upgrade window started.\nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1660417715000}},"description":"Information about agent upgrade history.<br>List API returning this summary information can use search filter  query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'Between', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"AgentUpgradeSpec":{"required":["agent_installer_package_id","end_time","machine_or_rds_server_ids","start_time"],"type":"object","properties":{"agent_installer_package_id":{"type":"string","description":"ID of the agent installer package.","example":"2b6eaeb8-2e91-11ed-a261-0242ac120002"},"batch_size":{"maximum":100,"minimum":1,"type":"integer","description":"Indicates the size of the batch to be considered for agent upgrade, in percentage.","format":"int32","example":20,"default":20},"custom_install_parameters":{"type":"string","description":"Indicates any parameters to be used by the agent for silent install.","example":"ADDLOCAL=Core,USB"},"end_time":{"type":"integer","description":"Agent upgrade end time.","format":"int64","example":1652079610000},"failure_threshold":{"maximum":100,"minimum":1,"type":"integer","description":"Indicates the threshold for tolerating failures, beyond which upgrades will be skipped, in percentage.","format":"int32","example":10,"default":10},"machine_or_rds_server_ids":{"uniqueItems":true,"type":"array","description":"Machines or RDS servers on which the upgrade is to be scheduled.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers on which the upgrade is to be scheduled.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"skip_for_logged_in_users":{"type":"boolean","description":"Indicates whether to skip agent upgrade for logged in users.","example":true},"start_time":{"type":"integer","description":"Agent upgrade start time.","format":"int64","example":1652079610000}},"description":"Agent upgrade spec."},"AgentUpgradeSpecV2":{"required":["agent_installer_package_id","end_time","machine_or_rds_server_ids","start_time","task_name"],"type":"object","properties":{"agent_installer_package_id":{"type":"string","description":"ID of the agent installer package.","example":"2b6eaeb8-2e91-11ed-a261-0242ac120002"},"batch_size":{"maximum":100,"minimum":1,"type":"integer","description":"Indicates the size of the batch to be considered for agent upgrade, in percentage.","format":"int32","example":20,"default":20},"custom_install_parameters":{"type":"string","description":"Indicates any parameters to be used by the agent for silent install.","example":"ADDLOCAL=Core,USB"},"end_time":{"type":"integer","description":"Agent upgrade end time.","format":"int64","example":1652079610000},"failure_threshold":{"maximum":100,"minimum":1,"type":"integer","description":"Indicates the threshold for tolerating failures, beyond which upgrades will be skipped, in percentage.","format":"int32","example":10,"default":10},"machine_or_rds_server_ids":{"uniqueItems":true,"type":"array","description":"Machines or RDS servers on which the upgrade is to be scheduled.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers on which the upgrade is to be scheduled.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"skip_for_logged_in_users":{"type":"boolean","description":"Indicates whether to skip agent upgrade for logged in users.","example":true},"start_time":{"type":"integer","description":"Agent upgrade start time.","format":"int64","example":1652079610000},"task_name":{"type":"string","description":"Name of the agent upgrade task.","example":"UpdateJob"}},"description":"Agent upgrade spec."},"AgentUpgradeTaskInfo":{"type":"object","properties":{"agent_installer_package_id":{"type":"string","description":"ID of the agent installer package.","example":"2b6eaeb8-2e91-11ed-a261-0242ac120002"},"cancelled_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has been cancelled.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"deprecated":true,"items":{"type":"string","description":"Machines or RDS servers for which upgrade has been cancelled.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"end_time":{"type":"integer","description":"Agent upgrade end time.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int64","example":1652079610000},"failed_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has failed.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"deprecated":true,"items":{"type":"string","description":"Machines or RDS servers for which upgrade has failed.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"id":{"type":"string","description":"Task ID of the agent upgrade.","example":"16c2faaa-2e8c-11ed-a261-0242ac120002"},"in_progress_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade are in progress.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers for which upgrade are in progress.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"not_started_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has not started.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers for which upgrade has not started.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"operation":{"type":"string","description":"The current agent upgrade task operation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"SCHEDULED"},"skipped_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has skipped.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"deprecated":true,"items":{"type":"string","description":"Machines or RDS servers for which upgrade has skipped.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"start_time":{"type":"integer","description":"Agent upgrade start time.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int64","example":1652079610000},"state":{"type":"string","description":"The state of an agent upgrade task.\nSupported Filters: 'Equals', 'NotEquals'\nThis property can be used for sorting."},"succeeded_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has succeeded.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers for which upgrade has succeeded.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}}},"description":"Information related to a agent upgrade task.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'Between', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"AgentUpgradeTaskInfoV2":{"type":"object","properties":{"agent_installer_package_id":{"type":"string","description":"ID of the agent installer package.","example":"2b6eaeb8-2e91-11ed-a261-0242ac120002"},"batch_size":{"type":"integer","description":"Indicates the size of the batch to be considered for agent upgrade, in percentage.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int32","example":20},"cancelled_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has been cancelled.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"deprecated":true,"items":{"type":"string","description":"Machines or RDS servers for which upgrade has been cancelled.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"end_time":{"type":"integer","description":"Agent upgrade end time.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int64","example":1652079610000},"failed_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has failed.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"deprecated":true,"items":{"type":"string","description":"Machines or RDS servers for which upgrade has failed.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"failure_threshold":{"type":"integer","description":"Indicates the threshold for tolerating failures, beyond which upgrades will be skipped, in percentage.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int32","example":10},"id":{"type":"string","description":"Task ID of the agent upgrade.","example":"16c2faaa-2e8c-11ed-a261-0242ac120002"},"in_progress_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade are in progress.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers for which upgrade are in progress.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"not_started_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has not started.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers for which upgrade has not started.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"operation":{"type":"string","description":"The current agent upgrade task operation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"SCHEDULED"},"skipped_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has skipped.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"deprecated":true,"items":{"type":"string","description":"Machines or RDS servers for which upgrade has skipped.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"start_time":{"type":"integer","description":"Agent upgrade start time.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int64","example":1652079610000},"state":{"type":"string","description":"The state of an agent upgrade task.\nSupported Filters: 'Equals', 'NotEquals'\nThis property can be used for sorting."},"succeeded_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has succeeded.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers for which upgrade has succeeded.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}}},"description":"Information related to a agent upgrade task.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'Between',  'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"AgentUpgradeTaskInfoV3":{"type":"object","properties":{"agent_installer_package_id":{"type":"string","description":"ID of the agent installer package.","example":"2b6eaeb8-2e91-11ed-a261-0242ac120002"},"batch_size":{"type":"integer","description":"Indicates the size of the batch to be considered for agent upgrade, in percentage.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int32","example":20},"cancelled_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has been cancelled.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"deprecated":true,"items":{"type":"string","description":"Machines or RDS servers for which upgrade has been cancelled.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"cancelled_machines_or_rds_servers_data":{"type":"array","description":"List of Machines or RDS servers for which upgrade has been cancelled","items":{"$ref":"#/components/schemas/AgentUpgradeData"}},"end_time":{"type":"integer","description":"Agent upgrade end time.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int64","example":1652079610000},"failed_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has failed.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"deprecated":true,"items":{"type":"string","description":"Machines or RDS servers for which upgrade has failed.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"failed_machines_or_rds_servers_data":{"type":"array","description":"List of Machines or RDS servers for which upgrade has been failed.","items":{"$ref":"#/components/schemas/AgentUpgradeData"}},"failure_threshold":{"type":"integer","description":"Indicates the threshold for tolerating failures, beyond which upgrades will be skipped, in percentage.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int32","example":10},"id":{"type":"string","description":"Task ID of the agent upgrade.","example":"16c2faaa-2e8c-11ed-a261-0242ac120002"},"in_progress_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade are in progress.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers for which upgrade are in progress.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"not_started_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has not started.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers for which upgrade has not started.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"operation":{"type":"string","description":"The current agent upgrade task operation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"SCHEDULED"},"skipped_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has skipped.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"deprecated":true,"items":{"type":"string","description":"Machines or RDS servers for which upgrade has skipped.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"skipped_machines_or_rds_servers_data":{"type":"array","description":"List of Machines or RDS servers for which upgrade has been skipped","items":{"$ref":"#/components/schemas/AgentUpgradeData"}},"start_time":{"type":"integer","description":"Agent upgrade start time.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int64","example":1652079610000},"state":{"type":"string","description":"The state of an agent upgrade task.\nSupported Filters: 'Equals', 'NotEquals'\nThis property can be used for sorting."},"succeeded_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has succeeded.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers for which upgrade has succeeded.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"task_name":{"type":"string","description":"Name of the agent upgrade task.\nSupported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"UpdateJob"}},"description":"Information related to a agent upgrade task.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'Between', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"AgentUpgradeTaskInfoV4":{"type":"object","properties":{"agent_build":{"type":"string","description":"Agent build of the agent installer package.\nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"8.5.0-1020202"},"agent_installer_package_id":{"type":"string","description":"ID of the agent installer package.","example":"2b6eaeb8-2e91-11ed-a261-0242ac120002"},"agent_type":{"type":"string","description":"Agent type\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"Omnissa-Telemetry-Agent"},"batch_size":{"type":"integer","description":"Indicates the size of the batch to be considered for agent upgrade, in percentage.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int32","example":20},"cancelled_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has been cancelled.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"deprecated":true,"items":{"type":"string","description":"Machines or RDS servers for which upgrade has been cancelled.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"cancelled_machines_or_rds_servers_data":{"type":"array","description":"List of Machines or RDS servers for which upgrade has been cancelled","items":{"$ref":"#/components/schemas/AgentUpgradeData"}},"end_time":{"type":"integer","description":"Agent upgrade end time.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int64","example":1652079610000},"failed_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has failed.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"deprecated":true,"items":{"type":"string","description":"Machines or RDS servers for which upgrade has failed.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"failed_machines_or_rds_servers_data_v2":{"type":"array","description":"List of Machines or RDS servers for which upgrade has been failed.","items":{"$ref":"#/components/schemas/AgentUpgradeDataV2"}},"failure_threshold":{"type":"integer","description":"Indicates the threshold for tolerating failures, beyond which upgrades will be skipped, in percentage.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int32","example":10},"id":{"type":"string","description":"Task ID of the agent upgrade.","example":"16c2faaa-2e8c-11ed-a261-0242ac120002"},"in_progress_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade are in progress.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers for which upgrade are in progress.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"machine_type":{"type":"string","description":"The type of machine. Supported machined types are MANAGED_MACHINE, UNMANAGED_MACHINE, AWS_CORE_MACHINE. This property will only be set for agent upgrade task for machines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"MANAGED_MACHINE"},"not_started_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has not started.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers for which upgrade has not started.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"operation":{"type":"string","description":"The current agent upgrade task operation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"SCHEDULED"},"skipped_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has skipped.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"deprecated":true,"items":{"type":"string","description":"Machines or RDS servers for which upgrade has skipped.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"skipped_machines_or_rds_servers_data":{"type":"array","description":"List of Machines or RDS servers for which upgrade has been skipped","items":{"$ref":"#/components/schemas/AgentUpgradeData"}},"start_time":{"type":"integer","description":"Agent upgrade start time.\nSupported Filters: 'Equals', 'Between' .\nThis property can be used for sorting.","format":"int64","example":1652079610000},"state":{"type":"string","description":"The state of an agent upgrade task.\nSupported Filters: 'Equals', 'NotEquals'\nThis property can be used for sorting."},"succeeded_machine_or_rds_server_ids":{"type":"array","description":"Machines or RDS servers for which upgrade has succeeded.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machines or RDS servers for which upgrade has succeeded.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"task_name":{"type":"string","description":"Name of the agent upgrade task.\nSupported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"UpdateJob"}},"description":"Information related to a agent upgrade task.<br>List API returning this summary information can use search filter  query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'Between', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"AgentUpgradeTaskResponseInfo":{"type":"object","properties":{"details":{"type":"array","description":"List of BulkItemResponseInfo corresponding to each machine id in the action operation.","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}},"task_id":{"type":"string","description":"Unique ID representing the task.","example":"7d01dc94-2e93-11ed-a261-0242ac120002"}}},"AndFilter":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseFilter"},{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/BaseFilter"}}}}],"required":["filters","type"]},"AppVolumeCertificateOverrideData":{"type":"object","properties":{"certificate":{"type":"string","description":"App Volume manage certificate"},"type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]}},"description":"Certificate details and type information, which can be used to override thumbprint details."},"AppVolumeCertificateOverrideDataUpdateSpec":{"type":"object","properties":{"certificate":{"type":"string","description":"App Volume Manager certificate"},"type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]}},"description":"Certificate data to be updated with App Volumes manager"},"AppVolumesApplicationInfo":{"type":"object","properties":{"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"file_types":{"uniqueItems":true,"type":"array","description":"Set of file types reported by the application as supported. If unset, this application does not present any file type support.","items":{"$ref":"#/components/schemas/ApplicationFileTypeData"}},"name":{"type":"string","description":"Application name information, as sent by RDSServer/machine during application discovery.","example":"Firefox"},"other_file_types":{"uniqueItems":true,"type":"array","description":"This represents the different file types reported by Application that can be passed from horizon agent to horizon client via connection server. If unset, this application does not present any other file type support.","items":{"$ref":"#/components/schemas/ApplicationOtherFileTypeData"}},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Information about the application available in App volumes Manager."},"AppVolumesCertificateOverrideDataCreateSpec":{"type":"object","properties":{"certificate":{"type":"string","description":"App Volume Manager certificate"},"type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]}},"description":"Certificate details and type information, which can be used to override thumbprint details."},"AppVolumesManagerCreateSpec":{"required":["password","server_name","username"],"type":"object","properties":{"password":{"type":"array","description":"Password of the account.","example":"<password>","items":{"type":"string","description":"Password of the account.","example":"<password>"}},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port of the App Volumes manager to connect to.","format":"int32","example":443},"server_name":{"type":"string","description":"App Volumes Manager's server name or IP address.","example":"avm.example.com"},"username":{"type":"string","description":"Username to login to App Volumes Manager","example":"administrator"}},"description":"App volumes manager object to be added."},"AppVolumesManagerCreateSpecV2":{"required":["password","server_name","username"],"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/AppVolumesCertificateOverrideDataCreateSpec"},"password":{"type":"array","description":"Password of the account.","example":"<password>","items":{"type":"string","description":"Password of the account.","example":"<password>"}},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port of the App Volumes manager to connect to.","format":"int32","example":443},"server_name":{"type":"string","description":"App Volumes Manager's server name or IP address.","example":"avm.example.com"},"username":{"type":"string","description":"Username to login to App Volumes Manager","example":"administrator"}},"description":"App volumes manager object to be added."},"AppVolumesManagerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique Id of the App Volumes Manager.","example":"625bdb01-7c4f-423e-a9b8-a2256c21447d "},"port":{"type":"integer","description":"Port of the App Volumes Manager to connect to.","format":"int32","example":443},"server_name":{"type":"string","description":"App Volumes Manager's server name or IP address.","example":"avm.example.com"},"username":{"type":"string","description":"Username to login to App Volumes Manager.","example":"administrator"}},"description":"Information about App Volumes Manager."},"AppVolumesManagerInfoV2":{"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/AppVolumeCertificateOverrideData"},"id":{"type":"string","description":"Unique Id of the App Volumes Manager.","example":"625bdb01-7c4f-423e-a9b8-a2256c21447d "},"port":{"type":"integer","description":"Port of the App Volumes Manager to connect to.","format":"int32","example":443},"server_name":{"type":"string","description":"App Volumes Manager's server name or IP address.","example":"avm.example.com"},"username":{"type":"string","description":"Username to login to App Volumes Manager.","example":"administrator"}},"description":"Information about App Volumes Manager."},"AppVolumesManagerMonitorConnectionServer":{"type":"object","properties":{"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the App Volumes Manager Connection with respect to this Connection Server.\n* ERROR: There has been no contact from the App Volumes Manager.\n* OK: The App Volumes Manager is working as expected.","example":"OK","enum":["ERROR","OK"]}},"description":"Information about connection to App Volumes Manager from Connection Server."},"AppVolumesManagerMonitorConnectionServerV2":{"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/CertificateMonitorInfo"},"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the App Volumes Manager Connection with respect to this Connection Server.\n* ERROR: There has been no contact from the App Volumes Manager.\n* OK: The App Volumes Manager is working as expected.","example":"OK","enum":["ERROR","OK"]},"thumbprint_accepted":{"type":"boolean","description":"Indicates if the thumbprints of the App Volumes Manager was accepted.","example":true}},"description":"Information about connection to App Volumes Manager from Connection Server."},"AppVolumesManagerMonitorInfo":{"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the App volumes Manager connections from each of the connection servers.","items":{"$ref":"#/components/schemas/AppVolumesManagerMonitorConnectionServer"}},"description":{"type":"string","description":"App volumes Manager Connection description.\n* SUCCESS: No problem detected.\n* CERT_INVALID_THUMBPRINT_MATCHED: No problem detected. Certificate is untrusted but the thumbprint for the certificate is accepted.\n* CERT_INVALID_THUMBPRINT_MATCH_FAILED: Certificate is untrusted and the thumbprint for the certificate is not accepted. Requires certificate revalidation.\n* PROBLEM: Problem detected in connecting to App Volumes Manager.","example":"SUCCESS","enum":["SUCCESS","CERT_INVALID_THUMBPRINT_MATCHED","CERT_INVALID_THUMBPRINT_MATCH_FAILED","PROBLEM"]},"id":{"type":"string","description":"Unique ID of the App volumes Manager.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"status":{"type":"string","description":"Combined status of the App volumes Manager with respect to all the CS. Set to OK if App volumes Manager is connected with all CS.\n* ERROR: There has been no contact from the App Volumes Manager.\n* OK: The App Volumes Manager is working as expected.","example":"OK","enum":["ERROR","OK"]},"url":{"type":"string","description":"App volumes Manager url.","example":"avm.example.com"},"version":{"type":"string","description":"App volumes Manager version.","example":"App Volumes 4, version 2209 (4.9.0.2996)"}},"description":"Monitoring information related to App volumes Manager registered in the environment."},"AppVolumesManagerMonitorInfoV2":{"type":"object","properties":{"connection_servers_v2":{"type":"array","description":"Information about the App volumes Manager connections from each of the connection servers.","items":{"$ref":"#/components/schemas/AppVolumesManagerMonitorConnectionServerV2"}},"description":{"type":"string","description":"App volumes Manager Connection description.\n* SUCCESS: No problem detected.\n* CERT_INVALID_THUMBPRINT_MATCHED: No problem detected. Certificate is untrusted but the thumbprint for the certificate is accepted.\n* CERT_INVALID_THUMBPRINT_MATCH_FAILED: Certificate is untrusted and the thumbprint for the certificate is not accepted. Requires certificate revalidation.\n* PROBLEM: Problem detected in connecting to App Volumes Manager.","example":"SUCCESS","enum":["SUCCESS","CERT_INVALID_THUMBPRINT_MATCHED","CERT_INVALID_THUMBPRINT_MATCH_FAILED","PROBLEM"]},"id":{"type":"string","description":"Unique ID of the App volumes Manager.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"status":{"type":"string","description":"Combined status of the App volumes Manager with respect to all the CS. Set to OK if App volumes Manager is connected with all CS.\n* ERROR: There has been no contact from the App Volumes Manager.\n* OK: The App Volumes Manager is working as expected.","example":"OK","enum":["ERROR","OK"]},"url":{"type":"string","description":"App volumes Manager url.","example":"avm.example.com"},"version":{"type":"string","description":"App volumes Manager version.","example":"App Volumes 4, version 2209 (4.9.0.2996)"}}},"AppVolumesManagerUpdateSpec":{"required":["password","server_name","username"],"type":"object","properties":{"password":{"type":"array","description":"Password of the account.","example":"<password>","items":{"type":"string","description":"Password of the account.","example":"<password>"}},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port of the app volumes manager to connect to.","format":"int32","example":443},"server_name":{"type":"string","description":"App Volumes Manager's server name or IP address.","example":"avm.example.com"},"username":{"type":"string","description":"Username to login to App Volumes Manager","example":"administrator"}},"description":"App volumes manager object to be updated."},"AppVolumesManagerUpdateSpecV2":{"required":["password","server_name","username"],"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/AppVolumeCertificateOverrideDataUpdateSpec"},"password":{"type":"array","description":"Password of the account.","example":"<password>","items":{"type":"string","description":"Password of the account.","example":"<password>"}},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port of the app volumes manager to connect to.","format":"int32","example":443},"server_name":{"type":"string","description":"App Volumes Manager's server name or IP address.","example":"avm.example.com"},"username":{"type":"string","description":"Username to login to App Volumes Manager","example":"administrator"}},"description":"App volumes manager object to be updated."},"ApplicationAntiAffinityData":{"required":["anti_affinity_count","anti_affinity_patterns"],"type":"object","properties":{"anti_affinity_count":{"maximum":20,"minimum":1,"type":"integer","description":"Maximum number of other applications that can be running on the RDS Server before the RDS Server is rejected for new application sessions.","format":"int32","example":10},"anti_affinity_patterns":{"uniqueItems":true,"type":"array","description":"Set of pattern strings to match against process names on a RDS Server when attempting to launch a session for this Application. For each application running on an RDSServer that matches one of the patterns, the tally against the count threshold is incremented.<br>Pattern strings may contain wildcard characters. '*' matches zero or more characters. '?' matches exactly one character.","example":["*pad.exe","*notepad.???"],"items":{"type":"string","description":"Set of pattern strings to match against process names on a RDS Server when attempting to launch a session for this Application. For each application running on an RDSServer that matches one of the patterns, the tally against the count threshold is incremented.<br>Pattern strings may contain wildcard characters. '*' matches zero or more characters. '?' matches exactly one character.","example":"[\"*pad.exe\",\"*notepad.???\"]"}}},"description":"Anti-affinity data required to create an application pool."},"ApplicationData":{"type":"object","properties":{"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"publisher":{"type":"string","description":"Application publisher.","example":"Mozilla Corporation"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Information about Application."},"ApplicationFileTypeData":{"required":["type"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Friendly name for the file type. If unset, no friendly name will be displayed.","example":"Firefox Document"},"type":{"pattern":"^[^/]*$","type":"string","description":"File type supported by this application. This value is case insensitive. If multiple file types are specified using the same (case insensitive) name and description, all but one will be ignored.","example":".html"}},"description":"Information about the file type supported by the application."},"ApplicationIconAssociateSpec":{"required":["icon_id"],"type":"object","properties":{"icon_id":{"type":"string","description":"Unique ID representing an application icon.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"}},"description":"Icon id to be associated with the application pool."},"ApplicationIconBulkAssociateSpec":{"required":["application_pool_ids","icon_id"],"type":"object","properties":{"application_pool_ids":{"uniqueItems":true,"type":"array","description":"An application icon could be shared by multiple application pools. This is a set of application pool IDs this icon represents.","example":["855ea6c5-720a-41e1-96f4-958c90e6e424","1453c2a3-e549-4301-af12-d62210d18d54"],"items":{"type":"string","description":"An application icon could be shared by multiple application pools. This is a set of application pool IDs this icon represents.","example":"[\"855ea6c5-720a-41e1-96f4-958c90e6e424\",\"1453c2a3-e549-4301-af12-d62210d18d54\"]"}},"icon_id":{"type":"string","description":"Unique ID representing an application icon.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"}},"description":"Specification for associating application icon to list of application pools."},"ApplicationIconCreateSpec":{"required":["data","height","width"],"type":"object","properties":{"data":{"type":"string","format":"byte"},"height":{"maximum":256,"minimum":16,"type":"integer","description":"Icon height.","format":"int64","example":16},"width":{"maximum":256,"minimum":16,"type":"integer","description":"Icon width.","format":"int64","example":16}},"description":"Application icon object to be created."},"ApplicationIconInfo":{"type":"object","properties":{"application_pool_ids":{"uniqueItems":true,"type":"array","description":"An application icon could be shared by multiple application pools. This is a set of application pool IDs this icon represents. Caller should have permission to POOL_VIEW privilege on the access group of any of the associated application pools for this field to be populated.<br>\nSupported Filters : 'Equals', 'Contains'.","example":["855ea6c5-720a-41e1-96f4-958c90e6e424","1453c2a3-e549-4301-af12-d62210d18d54"],"items":{"type":"string","description":"An application icon could be shared by multiple application pools. This is a set of application pool IDs this icon represents. Caller should have permission to POOL_VIEW privilege on the access group of any of the associated application pools for this field to be populated.<br>\nSupported Filters : 'Equals', 'Contains'.","example":"[\"855ea6c5-720a-41e1-96f4-958c90e6e424\",\"1453c2a3-e549-4301-af12-d62210d18d54\"]"}},"data":{"type":"string","format":"byte"},"height":{"type":"integer","description":"Icon height.\nSupported Filters : 'Equals', 'Between'.","format":"int32","example":16},"icon_hash":{"type":"string","description":"MD5 hash of icon image data, to enable quick icon lookup.\nSupported Filters : 'Equals'.","example":"13a5d8a8410445b51edf45b6eee2cd8d"},"icon_source":{"type":"string","description":"Source of the application icon. The icon can be from Machine/RDS Agent or custom icon.\nSupported Filters : 'Equals'.\n* HORIZON_AGENT: When the icon is from machine/RDS agent.\n* HORIZON_CONNECTION_SERVER: When the icon is uploaded by the administrator through connection server.","example":"HORIZON_AGENT","enum":["HORIZON_AGENT","HORIZON_CONNECTION_SERVER"]},"id":{"type":"string","description":"Unique ID representing application icon.\nSupported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"width":{"type":"integer","description":"Icon width.\nSupported Filters : 'Equals', 'Between'.","format":"int32","example":16}},"description":"Application icon information.\nSupported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'."},"ApplicationIconRemoveAssociationSpec":{"required":["application_pool_ids"],"type":"object","properties":{"application_pool_ids":{"uniqueItems":true,"type":"array","description":"An application icon could be shared by multiple application pools. This is a set of application pool IDs this icon represents.","example":["855ea6c5-720a-41e1-96f4-958c90e6e424","1453c2a3-e549-4301-af12-d62210d18d54"],"items":{"type":"string","description":"An application icon could be shared by multiple application pools. This is a set of application pool IDs this icon represents.","example":"[\"855ea6c5-720a-41e1-96f4-958c90e6e424\",\"1453c2a3-e549-4301-af12-d62210d18d54\"]"}}},"description":"List of Application pool Ids"},"ApplicationOtherFileTypeData":{"required":["name","type"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Friendly name for the file type. If unset, no friendly name will be displayed.","example":"Firefox URL"},"name":{"pattern":"^[^?]*$","type":"string","description":"The name for other file type data.","example":"https"},"type":{"type":"string","description":"Other file type currently supported.\n* URL: URL scheme types supported by application.\n* OTHER: Other scheme types supported by application.","example":"URL","enum":["URL","OTHER"]}},"description":"Information about different file types supported by Application that can be passed from agent to client via Connection Server."},"ApplicationPoolCreateSpec":{"required":["executable_path","multi_session_mode","name"],"type":"object","properties":{"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Notes about the application pool.","example":"Application pool description."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is to be created. Once an application pool is created from a desktop pool, it is always associated with that desktop pool, and cannot be removed from the desktop pool, or added to another desktop pool. Either this or farm id should be set.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"The display name is the name that users will see in Horizon client. If the display name is left blank, it defaults to name.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application. Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled. Default value is true","example":true},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is to be created. Once an application pool is created from a farm, it is always associated with that farm, and cannot be removed from the farm, or added to another farm. Either this or desktop pool id should be set.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"max_multi_sessions":{"minimum":1,"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"Default value is 1.","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"DISABLED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"The application pool name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching.","example":"-p myprofile"},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Application pool object to be created."},"ApplicationPoolCreateSpecV2":{"required":["executable_path","multi_session_mode","name"],"type":"object","properties":{"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered. Default value is false.<br>","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Notes about the application pool.","example":"Application pool description."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is to be created. Once an application pool is created from a desktop pool, it is always associated with that desktop pool, and cannot be removed from the desktop pool, or added to another desktop pool. Either this or farm id should be set.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"The display name is the name that users will see in Horizon client. If the display name is left blank, it defaults to name.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application. Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled. Default value is true","example":true},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is to be created. Once an application pool is created from a farm, it is always associated with that farm, and cannot be removed from the farm, or added to another farm. Either this or desktop pool id should be set.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"max_multi_sessions":{"minimum":1,"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"Default value is 1.","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"DISABLED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"The application pool name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching.","example":"-p myprofile"},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Application pool object to be created."},"ApplicationPoolCreateSpecV3":{"required":["executable_path","multi_session_mode","name"],"type":"object","properties":{"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered. Default value is false.<br>","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Notes about the application pool.","example":"Application pool description."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is to be created. Once an application pool is created from a desktop pool, it is always associated with that desktop pool, and cannot be removed from the desktop pool, or added to another desktop pool. Either this or farm id should be set.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"The display name is the name that users will see in Horizon client. If the display name is left blank, it defaults to name.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application. Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled. Default value is true","example":true},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is to be created. Once an application pool is created from a farm, it is always associated with that farm, and cannot be removed from the farm, or added to another farm. Either this or desktop pool id should be set.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"max_multi_sessions":{"minimum":1,"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"Default value is 1.","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"DISABLED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"The application pool name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching.","example":"-p myprofile"},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Application pool object to be created."},"ApplicationPoolCreateSpecV4":{"required":["executable_path","multi_session_mode","name"],"type":"object","properties":{"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the application pool. Default value is false.<br>","example":false},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered. Default value is false.<br>","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Notes about the application pool.","example":"Application pool description."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is to be created. Once an application pool is created from a desktop pool, it is always associated with that desktop pool, and cannot be removed from the desktop pool, or added to another desktop pool. Either this or farm id should be set.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"The display name is the name that users will see in Horizon client. If the display name is left blank, it defaults to name.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application. Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled. Default value is true","example":true},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is to be created. Once an application pool is created from a farm, it is always associated with that farm, and cannot be removed from the farm, or added to another farm. Either this or desktop pool id should be set.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"max_multi_sessions":{"minimum":1,"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"Default value is 1.","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"DISABLED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"The application pool name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching.","example":"-p myprofile"},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Application pool object to be created."},"ApplicationPoolCreateSpecV5":{"required":["executable_path","multi_session_mode","name"],"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the application pool supports session launch from user specified machines.Default value is false.","example":true},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the application pool. Default value is false.<br>","example":false},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered. Default value is false.<br>","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Notes about the application pool.","example":"Application pool description."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is to be created. Once an application pool is created from a desktop pool, it is always associated with that desktop pool, and cannot be removed from the desktop pool, or added to another desktop pool. Either this or farm id should be set.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"The display name is the name that users will see in Horizon client. If the display name is left blank, it defaults to name.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application. Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled. Default value is true","example":true},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is to be created. Once an application pool is created from a farm, it is always associated with that farm, and cannot be removed from the farm, or added to another farm. Either this or desktop pool id should be set.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"max_multi_sessions":{"minimum":1,"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"Default value is 1.","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"DISABLED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"The application pool name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching.","example":"-p myprofile"},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Application pool object to be created."},"ApplicationPoolCreateSpecV6":{"required":["executable_path","multi_session_mode","name"],"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the application pool supports session launch from user specified machines.Default value is false.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nDefault value - BOTH.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the application pool. Default value is false.<br>","example":false},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered. Default value is false.<br>","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Notes about the application pool.","example":"Application pool description."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is to be created. Once an application pool is created from a desktop pool, it is always associated with that desktop pool, and cannot be removed from the desktop pool, or added to another desktop pool. Either this or farm id should be set.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"The display name is the name that users will see in Horizon client. If the display name is left blank, it defaults to name.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application. Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled. Default value is true","example":true},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is to be created. Once an application pool is created from a farm, it is always associated with that farm, and cannot be removed from the farm, or added to another farm. Either this or desktop pool id should be set.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"max_multi_sessions":{"minimum":1,"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"Default value is 1.","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"DISABLED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"The application pool name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching.","example":"-p myprofile"},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect.\nDefault value - false."},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Application pool object to be created."},"ApplicationPoolInfo":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration. For application pool, this is the same as that of the farm or desktop pool that the application pool belongs to.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"customized_icon_ids":{"type":"array","description":"List of customized icon IDs associated with the application which the user has configured.","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26","b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"items":{"type":"string","description":"List of customized icon IDs associated with the application which the user has configured.","example":"[\"e8d7bf41-0fcd-477a-b7e0-1338b3868d26\",\"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e\"]"}},"description":{"type":"string","description":"Notes about the application pool.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"type":"string","description":"The display name is the name that users will see when they connect to view client. If the display name is left blank, it defaults to name.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"executable_path":{"type":"string","description":"Path to application executable.<br>Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"icon_ids":{"uniqueItems":true,"type":"array","description":"List of icon IDs associated with the application which are fetched from the agent.","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac","920b7766-87b4-4712-9dac-1e7afcba28a6"],"items":{"type":"string","description":"List of icon IDs associated with the application which are fetched from the agent.","example":"[\"200fd5fd-26d6-490e-b023-509cbe19c0ac\",\"920b7766-87b4-4712-9dac-1e7afcba28a6\"]"}},"id":{"type":"string","description":"Unique ID representing application pool.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"max_multi_sessions":{"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","description":"The application name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","description":"Application publisher.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application."},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"72.0.2"}},"description":"Application pool information.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"ApplicationPoolInfoV10":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration. For application pool, this is the same as that of the farm or desktop pool that the application pool belongs to.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the application pool supports session launch from user specified machines.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nSupported Filters: Equals.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the application pool. <br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"av_application_package_guid":{"type":"string","description":"Application package guid for the AVM managed application.","example":"d837a5d3-3735-417d-8688-df170373bf30"},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"customized_icon_ids":{"type":"array","description":"List of customized icon IDs associated with the application which the user has configured.","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26","b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"items":{"type":"string","description":"List of customized icon IDs associated with the application which the user has configured.","example":"[\"e8d7bf41-0fcd-477a-b7e0-1338b3868d26\",\"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e\"]"}},"description":{"type":"string","description":"Notes about the application pool.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_name":{"type":"string","description":"Name of the desktop pool from which this application pool is created. Either this or farm name will be set.<br>Supported Filters: 'Equals'.","example":"Desktop1"},"desktop_pool_or_farm_source":{"type":"string","description":"Source of the machine/RDS server in this desktop/farm.<br>","example":"VIRTUAL_CENTER"},"display_name":{"type":"string","description":"The display name is the name that users will see when they connect to view client. If the display name is left blank, it defaults to name.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"executable_path":{"type":"string","description":"Path to application executable.<br>Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"farm_name":{"type":"string","description":"Name of the farm from which this application pool is created. Either this or desktop pool name will be set.<br>Supported Filters: 'Equals'.","example":"Farm1"},"global_application_entitlement_id":{"type":"string","description":"Global application entitlement for this application pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"icon_ids":{"uniqueItems":true,"type":"array","description":"List of icon IDs associated with the application which are fetched from the agent.","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac","920b7766-87b4-4712-9dac-1e7afcba28a6"],"items":{"type":"string","description":"List of icon IDs associated with the application which are fetched from the agent.","example":"[\"200fd5fd-26d6-490e-b023-509cbe19c0ac\",\"920b7766-87b4-4712-9dac-1e7afcba28a6\"]"}},"id":{"type":"string","description":"Unique ID representing application pool.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"launch_id":{"type":"string","description":"Launch ID used by clients to connect to the pool."},"max_multi_sessions":{"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","description":"The application name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","description":"Application publisher.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Mozilla Corporation"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect."},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the ApplicationSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* NATIVE_APPS: if the source of Application is from Desktop or Farms\n* APP_VOLUMES: if the source of Application is App Volume Manager","example":"NATIVE_APPS","enum":["NATIVE_APPS","APP_VOLUMES"]},"start_folder":{"type":"string","description":"Starting folder for application."},"status":{"type":"string","description":"Health status of the application pool.Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AVAILABLE: The application is available in all machines of the desktop/farm.\n* MISSING: The application is missing in one or more machines in the desktop/farm.\n* UNAVAILABLE: Could happen in any of following cases:\n1) The application is missing in all the machines of the desktop/farm. \n2) Desktop/Farm does not have any provisioned machines.\n* DISABLED: The desktop/farm is disabled and the application is disabled.","example":"DISABLED","enum":["AVAILABLE","MISSING","UNAVAILABLE","DISABLED"]},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"user_count":{"type":"integer","description":"Number of users using the application","format":"int32","example":0},"version":{"type":"string","description":"Application version.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"72.0.2"}},"description":"Information related to Application Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"ApplicationPoolInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration. For application pool, this is the same as that of the farm or desktop pool that the application pool belongs to.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"customized_icon_ids":{"type":"array","description":"List of customized icon IDs associated with the application which the user has configured.","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26","b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"items":{"type":"string","description":"List of customized icon IDs associated with the application which the user has configured.","example":"[\"e8d7bf41-0fcd-477a-b7e0-1338b3868d26\",\"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e\"]"}},"description":{"type":"string","description":"Notes about the application pool.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"type":"string","description":"The display name is the name that users will see when they connect to view client. If the display name is left blank, it defaults to name.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"executable_path":{"type":"string","description":"Path to application executable.<br>Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_application_entitlement_id":{"type":"string","description":"Global application entitlement for this application pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"icon_ids":{"uniqueItems":true,"type":"array","description":"List of icon IDs associated with the application which are fetched from the agent.","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac","920b7766-87b4-4712-9dac-1e7afcba28a6"],"items":{"type":"string","description":"List of icon IDs associated with the application which are fetched from the agent.","example":"[\"200fd5fd-26d6-490e-b023-509cbe19c0ac\",\"920b7766-87b4-4712-9dac-1e7afcba28a6\"]"}},"id":{"type":"string","description":"Unique ID representing application pool.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"max_multi_sessions":{"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","description":"The application name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","description":"Application publisher.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application."},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"72.0.2"}},"description":"Information related to Application Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"ApplicationPoolInfoV3":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration. For application pool, this is the same as that of the farm or desktop pool that the application pool belongs to.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"customized_icon_ids":{"type":"array","description":"List of customized icon IDs associated with the application which the user has configured.","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26","b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"items":{"type":"string","description":"List of customized icon IDs associated with the application which the user has configured.","example":"[\"e8d7bf41-0fcd-477a-b7e0-1338b3868d26\",\"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e\"]"}},"description":{"type":"string","description":"Notes about the application pool.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"type":"string","description":"The display name is the name that users will see when they connect to view client. If the display name is left blank, it defaults to name.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"executable_path":{"type":"string","description":"Path to application executable.<br>Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_application_entitlement_id":{"type":"string","description":"Global application entitlement for this application pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"icon_ids":{"uniqueItems":true,"type":"array","description":"List of icon IDs associated with the application which are fetched from the agent.","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac","920b7766-87b4-4712-9dac-1e7afcba28a6"],"items":{"type":"string","description":"List of icon IDs associated with the application which are fetched from the agent.","example":"[\"200fd5fd-26d6-490e-b023-509cbe19c0ac\",\"920b7766-87b4-4712-9dac-1e7afcba28a6\"]"}},"id":{"type":"string","description":"Unique ID representing application pool.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"max_multi_sessions":{"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","description":"The application name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","description":"Application publisher.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application."},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"72.0.2"}},"description":"Information related to Application Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"ApplicationPoolInfoV4":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration. For application pool, this is the same as that of the farm or desktop pool that the application pool belongs to.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"customized_icon_ids":{"type":"array","description":"List of customized icon IDs associated with the application which the user has configured.","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26","b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"items":{"type":"string","description":"List of customized icon IDs associated with the application which the user has configured.","example":"[\"e8d7bf41-0fcd-477a-b7e0-1338b3868d26\",\"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e\"]"}},"description":{"type":"string","description":"Notes about the application pool.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"type":"string","description":"The display name is the name that users will see when they connect to view client. If the display name is left blank, it defaults to name.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"executable_path":{"type":"string","description":"Path to application executable.<br>Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_application_entitlement_id":{"type":"string","description":"Global application entitlement for this application pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"icon_ids":{"uniqueItems":true,"type":"array","description":"List of icon IDs associated with the application which are fetched from the agent.","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac","920b7766-87b4-4712-9dac-1e7afcba28a6"],"items":{"type":"string","description":"List of icon IDs associated with the application which are fetched from the agent.","example":"[\"200fd5fd-26d6-490e-b023-509cbe19c0ac\",\"920b7766-87b4-4712-9dac-1e7afcba28a6\"]"}},"id":{"type":"string","description":"Unique ID representing application pool.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"max_multi_sessions":{"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","description":"The application name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","description":"Application publisher.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application."},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"72.0.2"}},"description":"Information related to Application Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"ApplicationPoolInfoV5":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration. For application pool, this is the same as that of the farm or desktop pool that the application pool belongs to.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the application pool. <br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"customized_icon_ids":{"type":"array","description":"List of customized icon IDs associated with the application which the user has configured.","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26","b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"items":{"type":"string","description":"List of customized icon IDs associated with the application which the user has configured.","example":"[\"e8d7bf41-0fcd-477a-b7e0-1338b3868d26\",\"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e\"]"}},"description":{"type":"string","description":"Notes about the application pool.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"type":"string","description":"The display name is the name that users will see when they connect to view client. If the display name is left blank, it defaults to name.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"executable_path":{"type":"string","description":"Path to application executable.<br>Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_application_entitlement_id":{"type":"string","description":"Global application entitlement for this application pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"icon_ids":{"uniqueItems":true,"type":"array","description":"List of icon IDs associated with the application which are fetched from the agent.","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac","920b7766-87b4-4712-9dac-1e7afcba28a6"],"items":{"type":"string","description":"List of icon IDs associated with the application which are fetched from the agent.","example":"[\"200fd5fd-26d6-490e-b023-509cbe19c0ac\",\"920b7766-87b4-4712-9dac-1e7afcba28a6\"]"}},"id":{"type":"string","description":"Unique ID representing application pool.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"max_multi_sessions":{"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","description":"The application name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","description":"Application publisher.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application."},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"72.0.2"}},"description":"Information related to Application Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"ApplicationPoolInfoV6":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration. For application pool, this is the same as that of the farm or desktop pool that the application pool belongs to.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the application pool supports session launch from user specified machines.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the application pool. <br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"customized_icon_ids":{"type":"array","description":"List of customized icon IDs associated with the application which the user has configured.","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26","b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"items":{"type":"string","description":"List of customized icon IDs associated with the application which the user has configured.","example":"[\"e8d7bf41-0fcd-477a-b7e0-1338b3868d26\",\"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e\"]"}},"description":{"type":"string","description":"Notes about the application pool.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_name":{"type":"string","description":"Name of the desktop pool from which this application pool is created. Either this or farm name will be set.<br>Supported Filters: 'Equals'.","example":"Desktop1"},"display_name":{"type":"string","description":"The display name is the name that users will see when they connect to view client. If the display name is left blank, it defaults to name.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"executable_path":{"type":"string","description":"Path to application executable.<br>Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"farm_name":{"type":"string","description":"Name of the farm from which this application pool is created. Either this or desktop pool name will be set.<br>Supported Filters: 'Equals'.","example":"Farm1"},"global_application_entitlement_id":{"type":"string","description":"Global application entitlement for this application pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"icon_ids":{"uniqueItems":true,"type":"array","description":"List of icon IDs associated with the application which are fetched from the agent.","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac","920b7766-87b4-4712-9dac-1e7afcba28a6"],"items":{"type":"string","description":"List of icon IDs associated with the application which are fetched from the agent.","example":"[\"200fd5fd-26d6-490e-b023-509cbe19c0ac\",\"920b7766-87b4-4712-9dac-1e7afcba28a6\"]"}},"id":{"type":"string","description":"Unique ID representing application pool.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"max_multi_sessions":{"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","description":"The application name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","description":"Application publisher.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application."},"status":{"type":"string","description":"Health status of the application pool.Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AVAILABLE: The application is available in all machines of the desktop/farm.\n* MISSING: The application is missing in one or more machines in the desktop/farm.\n* UNAVAILABLE: Could happen in any of following cases:\n1) The application is missing in all the machines of the desktop/farm. \n2) Desktop/Farm does not have any provisioned machines.\n* DISABLED: The desktop/farm is disabled and the application is disabled.","example":"DISABLED","enum":["AVAILABLE","MISSING","UNAVAILABLE","DISABLED"]},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"72.0.2"}},"description":"Information related to Application Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"ApplicationPoolInfoV7":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration. For application pool, this is the same as that of the farm or desktop pool that the application pool belongs to.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the application pool supports session launch from user specified machines.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the application pool. <br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"av_application_package_guid":{"type":"string","description":"Application package guid for the AVM managed application.","example":"d837a5d3-3735-417d-8688-df170373bf30"},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"customized_icon_ids":{"type":"array","description":"List of customized icon IDs associated with the application which the user has configured.","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26","b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"items":{"type":"string","description":"List of customized icon IDs associated with the application which the user has configured.","example":"[\"e8d7bf41-0fcd-477a-b7e0-1338b3868d26\",\"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e\"]"}},"description":{"type":"string","description":"Notes about the application pool.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_name":{"type":"string","description":"Name of the desktop pool from which this application pool is created. Either this or farm name will be set.<br>Supported Filters: 'Equals'.","example":"Desktop1"},"display_name":{"type":"string","description":"The display name is the name that users will see when they connect to view client. If the display name is left blank, it defaults to name.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"executable_path":{"type":"string","description":"Path to application executable.<br>Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"farm_name":{"type":"string","description":"Name of the farm from which this application pool is created. Either this or desktop pool name will be set.<br>Supported Filters: 'Equals'.","example":"Farm1"},"global_application_entitlement_id":{"type":"string","description":"Global application entitlement for this application pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"icon_ids":{"uniqueItems":true,"type":"array","description":"List of icon IDs associated with the application which are fetched from the agent.","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac","920b7766-87b4-4712-9dac-1e7afcba28a6"],"items":{"type":"string","description":"List of icon IDs associated with the application which are fetched from the agent.","example":"[\"200fd5fd-26d6-490e-b023-509cbe19c0ac\",\"920b7766-87b4-4712-9dac-1e7afcba28a6\"]"}},"id":{"type":"string","description":"Unique ID representing application pool.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"max_multi_sessions":{"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","description":"The application name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","description":"Application publisher.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application."},"status":{"type":"string","description":"Health status of the application pool.Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AVAILABLE: The application is available in all machines of the desktop/farm.\n* MISSING: The application is missing in one or more machines in the desktop/farm.\n* UNAVAILABLE: Could happen in any of following cases:\n1) The application is missing in all the machines of the desktop/farm. \n2) Desktop/Farm does not have any provisioned machines.\n* DISABLED: The desktop/farm is disabled and the application is disabled.","example":"DISABLED","enum":["AVAILABLE","MISSING","UNAVAILABLE","DISABLED"]},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"72.0.2"}},"description":"Information related to Application Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"ApplicationPoolInfoV8":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration. For application pool, this is the same as that of the farm or desktop pool that the application pool belongs to.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the application pool supports session launch from user specified machines.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the application pool. <br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"av_application_package_guid":{"type":"string","description":"Application package guid for the AVM managed application.","example":"d837a5d3-3735-417d-8688-df170373bf30"},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"customized_icon_ids":{"type":"array","description":"List of customized icon IDs associated with the application which the user has configured.","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26","b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"items":{"type":"string","description":"List of customized icon IDs associated with the application which the user has configured.","example":"[\"e8d7bf41-0fcd-477a-b7e0-1338b3868d26\",\"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e\"]"}},"description":{"type":"string","description":"Notes about the application pool.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_name":{"type":"string","description":"Name of the desktop pool from which this application pool is created. Either this or farm name will be set.<br>Supported Filters: 'Equals'.","example":"Desktop1"},"display_name":{"type":"string","description":"The display name is the name that users will see when they connect to view client. If the display name is left blank, it defaults to name.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"executable_path":{"type":"string","description":"Path to application executable.<br>Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"farm_name":{"type":"string","description":"Name of the farm from which this application pool is created. Either this or desktop pool name will be set.<br>Supported Filters: 'Equals'.","example":"Farm1"},"global_application_entitlement_id":{"type":"string","description":"Global application entitlement for this application pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"icon_ids":{"uniqueItems":true,"type":"array","description":"List of icon IDs associated with the application which are fetched from the agent.","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac","920b7766-87b4-4712-9dac-1e7afcba28a6"],"items":{"type":"string","description":"List of icon IDs associated with the application which are fetched from the agent.","example":"[\"200fd5fd-26d6-490e-b023-509cbe19c0ac\",\"920b7766-87b4-4712-9dac-1e7afcba28a6\"]"}},"id":{"type":"string","description":"Unique ID representing application pool.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"max_multi_sessions":{"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","description":"The application name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","description":"Application publisher.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the ApplicationSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* NATIVE_APPS: if the source of Application is from Desktop or Farms\n* APP_VOLUMES: if the source of Application is App Volume Manager","example":"NATIVE_APPS","enum":["NATIVE_APPS","APP_VOLUMES"]},"start_folder":{"type":"string","description":"Starting folder for application."},"status":{"type":"string","description":"Health status of the application pool.Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AVAILABLE: The application is available in all machines of the desktop/farm.\n* MISSING: The application is missing in one or more machines in the desktop/farm.\n* UNAVAILABLE: Could happen in any of following cases:\n1) The application is missing in all the machines of the desktop/farm. \n2) Desktop/Farm does not have any provisioned machines.\n* DISABLED: The desktop/farm is disabled and the application is disabled.","example":"DISABLED","enum":["AVAILABLE","MISSING","UNAVAILABLE","DISABLED"]},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"user_count":{"type":"integer","description":"Number of users using the application","format":"int32","example":0},"version":{"type":"string","description":"Application version.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"72.0.2"}},"description":"Information related to Application Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"ApplicationPoolInfoV9":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration. For application pool, this is the same as that of the farm or desktop pool that the application pool belongs to.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the application pool supports session launch from user specified machines.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nSupported Filters: Equals.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the application pool. <br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"av_application_package_guid":{"type":"string","description":"Application package guid for the AVM managed application.","example":"d837a5d3-3735-417d-8688-df170373bf30"},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"customized_icon_ids":{"type":"array","description":"List of customized icon IDs associated with the application which the user has configured.","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26","b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"items":{"type":"string","description":"List of customized icon IDs associated with the application which the user has configured.","example":"[\"e8d7bf41-0fcd-477a-b7e0-1338b3868d26\",\"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e\"]"}},"description":{"type":"string","description":"Notes about the application pool.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting."},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_name":{"type":"string","description":"Name of the desktop pool from which this application pool is created. Either this or farm name will be set.<br>Supported Filters: 'Equals'.","example":"Desktop1"},"display_name":{"type":"string","description":"The display name is the name that users will see when they connect to view client. If the display name is left blank, it defaults to name.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"executable_path":{"type":"string","description":"Path to application executable.<br>Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"farm_id":{"type":"string","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"farm_name":{"type":"string","description":"Name of the farm from which this application pool is created. Either this or desktop pool name will be set.<br>Supported Filters: 'Equals'.","example":"Farm1"},"global_application_entitlement_id":{"type":"string","description":"Global application entitlement for this application pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"icon_ids":{"uniqueItems":true,"type":"array","description":"List of icon IDs associated with the application which are fetched from the agent.","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac","920b7766-87b4-4712-9dac-1e7afcba28a6"],"items":{"type":"string","description":"List of icon IDs associated with the application which are fetched from the agent.","example":"[\"200fd5fd-26d6-490e-b023-509cbe19c0ac\",\"920b7766-87b4-4712-9dac-1e7afcba28a6\"]"}},"id":{"type":"string","description":"Unique ID representing application pool.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"launch_id":{"type":"string","description":"Launch ID used by clients to connect to the pool."},"max_multi_sessions":{"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","description":"The application name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Firefox"},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","description":"Application publisher.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Mozilla Corporation"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect."},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the ApplicationSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* NATIVE_APPS: if the source of Application is from Desktop or Farms\n* APP_VOLUMES: if the source of Application is App Volume Manager","example":"NATIVE_APPS","enum":["NATIVE_APPS","APP_VOLUMES"]},"start_folder":{"type":"string","description":"Starting folder for application."},"status":{"type":"string","description":"Health status of the application pool.Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AVAILABLE: The application is available in all machines of the desktop/farm.\n* MISSING: The application is missing in one or more machines in the desktop/farm.\n* UNAVAILABLE: Could happen in any of following cases:\n1) The application is missing in all the machines of the desktop/farm. \n2) Desktop/Farm does not have any provisioned machines.\n* DISABLED: The desktop/farm is disabled and the application is disabled.","example":"DISABLED","enum":["AVAILABLE","MISSING","UNAVAILABLE","DISABLED"]},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"user_count":{"type":"integer","description":"Number of users using the application","format":"int32","example":0},"version":{"type":"string","description":"Application version.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"72.0.2"}},"description":"Information related to Application Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"ApplicationPoolUpdateSpec":{"required":["enable_pre_launch","enabled","executable_path","multi_session_mode","supported_file_types_data"],"type":"object","properties":{"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Notes about the application pool.","example":"Application pool description."},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"The display name is the name that users will see in Horizon client. ","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.","example":true},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"max_multi_sessions":{"minimum":1,"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"Default value is 1.","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"parameters":{"type":"string","description":"Parameters to pass to application when launching.","example":"-p myprofile"},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Application pool object to be updated."},"ApplicationPoolUpdateSpecV2":{"required":["enable_pre_launch","enabled","executable_path","multi_session_mode","supported_file_types_data"],"type":"object","properties":{"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered. Default value is false.<br>","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Notes about the application pool.","example":"Application pool description."},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"The display name is the name that users will see in Horizon client. ","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.","example":true},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"max_multi_sessions":{"minimum":1,"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"Default value is 1.","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"parameters":{"type":"string","description":"Parameters to pass to application when launching.","example":"-p myprofile"},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Application pool object to be updated."},"ApplicationPoolUpdateSpecV3":{"required":["enable_pre_launch","enabled","executable_path","multi_session_mode","supported_file_types_data"],"type":"object","properties":{"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered. Default value is false.<br>","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Notes about the application pool.","example":"Application pool description."},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"The display name is the name that users will see in Horizon client. ","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.","example":true},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"max_multi_sessions":{"minimum":1,"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"Default value is 1.","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"parameters":{"type":"string","description":"Parameters to pass to application when launching.","example":"-p myprofile"},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Application pool object to be updated."},"ApplicationPoolUpdateSpecV4":{"required":["enable_pre_launch","enabled","executable_path","multi_session_mode","supported_file_types_data"],"type":"object","properties":{"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the application pool. Default value is false.<br>","example":false},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered. Default value is false.<br>","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Notes about the application pool.","example":"Application pool description."},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"The display name is the name that users will see in Horizon client. ","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.","example":true},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"max_multi_sessions":{"minimum":1,"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"Default value is 1.","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"parameters":{"type":"string","description":"Parameters to pass to application when launching.","example":"-p myprofile"},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Application pool object to be updated."},"ApplicationPoolUpdateSpecV5":{"required":["allow_users_to_choose_machines","enable_pre_launch","enabled","executable_path","multi_session_mode","supported_file_types_data"],"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the application pool supports session launch from user specified machines.","example":true},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the application pool. Default value is false.<br>","example":false},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered. Default value is false.<br>","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Notes about the application pool.","example":"Application pool description."},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"The display name is the name that users will see in Horizon client. ","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.","example":true},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"max_multi_sessions":{"minimum":1,"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"Default value is 1.","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"parameters":{"type":"string","description":"Parameters to pass to application when launching.","example":"-p myprofile"},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Application pool object to be updated."},"ApplicationPoolUpdateSpecV6":{"required":["allow_users_to_choose_machines","enable_pre_launch","enabled","executable_path","multi_session_mode","supported_file_types_data"],"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the application pool supports session launch from user specified machines.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nDefault value - BOTH.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"anti_affinity_data":{"$ref":"#/components/schemas/ApplicationAntiAffinityData"},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the application pool. Default value is false.<br>","example":false},"avm_shortcut_id":{"type":"string","description":"Shortcut ID of AVM managed application.","example":"1"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_brokered":{"type":"boolean","description":"Indicates whether the application pool is cloud brokered. Default value is false.<br>","example":false},"cs_restriction_tags":{"uniqueItems":true,"type":"array","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Notes about the application pool.","example":"Application pool description."},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"The display name is the name that users will see in Horizon client. ","example":"Firefox"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"Whether to pre-launch the application.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the application pool is enabled.","example":true},"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"max_multi_sessions":{"minimum":1,"type":"integer","description":"Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to \"ENABLED_DEFAULT_OFF\", \"ENABLED_DEFAULT_ON\", or \"ENABLED_ENFORCED\"Default value is 1.","format":"int32","example":5},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"parameters":{"type":"string","description":"Parameters to pass to application when launching.","example":"-p myprofile"},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect.\nDefault value - false."},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.","items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"$ref":"#/components/schemas/ApplicationSupportedFileTypesData"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Application pool object to be updated."},"ApplicationSupportedFileTypesData":{"type":"object","properties":{"enable_auto_update_file_types":{"type":"boolean","description":"Whether or not the file types supported by this application should be allowed to automatically update to reflect changes reported by the agent. Typically this should be set to false if the application has manually configured supported file types. Default is true.","example":true},"enable_auto_update_other_file_types":{"type":"boolean","description":"Whether or not the other file types supported by this application should be allowed to automatically update to reflect changes reported by the agent. Typically this should be set to false if the application has manually configured supported file types. Default is true.","example":true},"file_types":{"uniqueItems":true,"type":"array","description":"Set of file types reported by the application as supported (if this application is discovered) or as specified by the administrator (if this application is manually configured). If unset, this application does not present any file type support.","items":{"$ref":"#/components/schemas/ApplicationFileTypeData"}},"other_file_types":{"uniqueItems":true,"type":"array","description":"This represents the different file types reported by Application that can be passed from agent to client via broker or as specified by the administrator (if this application is manually configured). If unset, this application does not present any other file type support.","items":{"$ref":"#/components/schemas/ApplicationOtherFileTypeData"}}},"description":"Information about the file types supported by the application."},"AuditEventAttributeInfo":{"type":"object","properties":{"event_data":{"type":"object","description":"Key value pairs representing Extended attributes related to the event.\n","example":{"AttrChangeType":"MODIFY","AttrName":"generalData.clientIdleSessionTimeoutMinutes","AttrValue":"15","UserDisplayName":"domain\\administrator"}},"id":{"type":"integer","description":"Unique id representing an event.\n","format":"int64","example":1001}},"description":"Extended attributes related to events."},"AuditEventSummary":{"type":"object","properties":{"application_pool_name":{"type":"string","description":"Application Pool associated with this event. Will be unset if there is no application association for this event.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":"calculator"},"desktop_pool_name":{"type":"string","description":"Desktop Pool associated with this event. Will be unset if there is no desktop association for this event.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":"manual pool"},"id":{"type":"integer","description":"Unique id representing an event.\nSupported Filters : 'Equals'.","format":"int64","example":1001},"machine_dns_name":{"type":"string","description":"FQDN of the machine in the Pod that has logged this event.\nSupported Filters : 'Equals', 'ContainsFilter'.\nThis property can be used for sorting.","example":"broker.domain.com"},"machine_id":{"type":"string","description":"Machine associated with this event. Will be unset if there is no machine association for this event.\nSupported Filters : 'Equals'.","example":"3d78ef58-20a6-4f0e-923d-cb61938002bb"},"message":{"type":"string","description":"Audit event message.\nSupported Filters : 'Equals', 'ContainsFilter'.\nThis property can be used for sorting.","example":"Broker broker1 has started handling events"},"module":{"type":"string","description":"Horizon component that has logged this event.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":"Broker"},"severity":{"type":"string","description":"Severity type of the event.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.\n* INFO: Audit event is of INFO severity.\n* WARNING: Audit event is of WARNING severity\n* ERROR: Audit event is of ERROR severity\n* AUDIT_SUCCESS: Audit event is of AUDIT_SUCCESS severity\n* AUDIT_FAIL: Audit event is of AUDIT_FAIL severity\n* UNKNOWN: Not able to identify severity","example":"AUDIT_SUCCESS","enum":["INFO","WARNING","ERROR","AUDIT_SUCCESS","AUDIT_FAIL","UNKNOWN"]},"time":{"type":"integer","description":"Time at which the event occurred.\nSupported Filters : 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181831000},"type":{"type":"string","description":"Event name that corresponds to an item in the message catalog.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":"AGENT_CONNECTED"},"user_id":{"type":"string","description":"Sid of the user associated with this event.\nSupported Filters : 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"}},"description":"Information related to Audit Events.<br> Supported Filters : 'And', 'Or', 'Equals' and 'Between'.<br>See the field description to know the filter types it supports."},"AuditEventSummaryV2":{"type":"object","properties":{"application_pool_name":{"type":"string","description":"Application Pool associated with this event. Will be unset if there is no application association for this event.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":"calculator"},"desktop_pool_name":{"type":"string","description":"Desktop Pool associated with this event. Will be unset if there is no desktop association for this event.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":"manual pool"},"id":{"type":"integer","description":"Unique id representing an event.\nSupported Filters : 'Equals'.","format":"int64","example":1001},"machine_dns_name":{"type":"string","description":"FQDN of the machine in the Pod that has logged this event.\nSupported Filters : 'Equals', 'ContainsFilter'.\nThis property can be used for sorting.","example":"broker.domain.com"},"machine_id":{"type":"string","description":"Machine associated with this event. Will be unset if there is no machine association for this event.\nSupported Filters : 'Equals'.","example":"3d78ef58-20a6-4f0e-923d-cb61938002bb"},"message":{"type":"string","description":"Audit event message.\nSupported Filters : 'Equals', 'ContainsFilter'.\nThis property can be used for sorting.","example":"Broker broker1 has started handling events"},"module":{"type":"string","description":"Horizon component that has logged this event.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":"Broker"},"persistent_disk_id":{"type":"string","description":"Persistent disk associated with this event. <br>Will be unset if there is no persistent disk association for this event.\nSupported Filters : 'Equals'.","example":"c1d5aec7-2126-3c55-aefa-11949003c9c2"},"severity":{"type":"string","description":"Severity type of the event.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.\n* INFO: Audit event is of INFO severity.\n* WARNING: Audit event is of WARNING severity\n* ERROR: Audit event is of ERROR severity\n* AUDIT_SUCCESS: Audit event is of AUDIT_SUCCESS severity\n* AUDIT_FAIL: Audit event is of AUDIT_FAIL severity\n* UNKNOWN: Not able to identify severity","example":"AUDIT_SUCCESS","enum":["INFO","WARNING","ERROR","AUDIT_SUCCESS","AUDIT_FAIL","UNKNOWN"]},"time":{"type":"integer","description":"Time at which the event occurred.\nSupported Filters : 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181831000},"type":{"type":"string","description":"Event name that corresponds to an item in the message catalog.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":"AGENT_CONNECTED"},"user_id":{"type":"string","description":"Sid of the user associated with this event.\nSupported Filters : 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"}},"description":"Information related to Audit Events.<br> Supported Filters : 'And', 'Or', 'Equals' and 'Between'.<br>See the field description to know the filter types it supports."},"AuthBaseDataCreateSpec":{"type":"object","properties":{"certificate":{"type":"string","description":"Capacity provider certificate.","example":"<certificate>"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"password":{"type":"array","description":"Password for the capacity provider. Applicable for deployment type PRISM.","items":{"type":"string","description":"Password for the capacity provider. Applicable for deployment type PRISM."}},"server_name":{"pattern":"^[\\w.-]+$","type":"string","description":"FQDN of the capacity provider. Applicable for deployment type PRISM.","example":"server-name.example.com"},"user_name":{"type":"string","description":"Username for the capacity provider. Applicable for deployment type PRISM.","example":"user-name"}},"description":"Auth base data of the capacity server"},"AuthBaseDataInfo":{"type":"object","properties":{"certificate":{"type":"string","description":"Capacity provider certificate.","example":"<certificate>"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"server_name":{"pattern":"^[\\w.-]+$","type":"string","description":"FQDN of the capacity provider. Applicable for deployment type PRISM.","example":"server-name.example.com"},"user_name":{"type":"string","description":"Username for the capacity provider. Applicable for deployment type PRISM.","example":"user-name"}},"description":"Auth base data of the capacity server"},"AuthBaseDataUpdateSpec":{"type":"object","properties":{"certificate":{"type":"string","description":"Capacity provider certificate.","example":"<certificate>"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"password":{"type":"array","description":"Password for the capacity provider. Applicable for deployment type PRISM.","items":{"type":"string","description":"Password for the capacity provider. Applicable for deployment type PRISM."}},"server_name":{"pattern":"^[\\w.-]+$","type":"string","description":"FQDN of the capacity provider. Applicable for deployment type PRISM.","example":"server-name.example.com"},"user_name":{"type":"string","description":"Username for the capacity provider. Applicable for deployment type PRISM.","example":"user-name"}},"description":"Auth base data of the capacity server"},"AuthLogin":{"required":["domain","password","username"],"type":"object","properties":{"domain":{"type":"string","description":"Domain","example":"AD-TEST-DOMAIN"},"password":{"type":"array","description":"User password","example":"<password>","items":{"type":"string","description":"User password","example":"<password>"}},"username":{"type":"string","description":"User Name","example":"Administrator"}},"description":"Login credentials needed for Authentication"},"AuthTokens":{"required":["access_token","refresh_token"],"type":"object","properties":{"access_token":{"type":"string","description":"Access Token to be used in API calls.","example":"<jwt.access.token>"},"refresh_token":{"type":"string","description":"Refresh Token to be used to get a new Access token.","example":"<jwt.refresh.token>"}},"description":"Authentication Tokens"},"AuxiliaryAccountUpdateData":{"required":["id","password"],"type":"object","properties":{"id":{"type":"string","description":"Auxiliary Service account ID.","example":"1f95a15c-a7a5-4584-963f-2c3f5355b49f"},"password":{"type":"array","description":"Service account user password.","example":"<password>","items":{"type":"string","description":"Service account user password.","example":"<password>"}}},"description":"Auxiliary service account credentials."},"AwsCoreDesktopSettings":{"type":"object","properties":{"aws_core_workspace_schedules":{"type":"array","description":"Indicates the Schedules for workspace power policy","items":{"$ref":"#/components/schemas/AwsCoreWorkspaceSchedule"}},"bundle_id":{"type":"string","description":"Indicates AWS core bundle ID","example":"wdy-hv3jhyzb2"},"bundle_name":{"type":"string","description":"Name of the AWS core bundle","example":"cs1-bundle1"},"directory_id":{"type":"string","description":"Indicates AWS core directory ID","example":"d-94673ede63"},"directory_name":{"type":"string","description":"Name of the AWS core directory","example":"hznonaws.com"},"running_mode":{"type":"string","description":"Running mode for the AWS core workspaces in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALWAYS_ON: Billed monthly. Instant access to an always running WorkSpace.\n* MANUAL: Billed by the hour. WorkSpace starts and stops automatically at scheduled duration if the workspace schedule specified.","example":"ALWAYS_ON","enum":["ALWAYS_ON","MANUAL"]}},"description":"AWS core settings for automated desktop pool"},"AwsCoreDesktopSettingsCreateSpec":{"required":["bundle_id","directory_id","running_mode"],"type":"object","properties":{"aws_core_workspace_schedules":{"type":"array","description":"The Schedules for workspace power policy can only be set for workspaces where the running mode is set to MANUAL","items":{"$ref":"#/components/schemas/AwsCoreWorkspaceScheduleCreateSpec"}},"bundle_id":{"type":"string","description":"AWS core bundle ID","example":"wdy-hv3jhyzb2"},"directory_id":{"type":"string","description":"AWS core directory ID","example":"d-94673ede63"},"running_mode":{"type":"string","description":"Running mode for the AWS core workspaces in the desktop pool. This property has a default value of ALWAYS_ON\n* ALWAYS_ON: Billed monthly. Instant access to an always running WorkSpace.\n* MANUAL: Billed by the hour. WorkSpace starts and stops automatically at scheduled duration if the workspace schedule specified.","example":"ALWAYS_ON","enum":["ALWAYS_ON","MANUAL"]}},"description":"AWS core settings for automated desktop pool"},"AwsCoreDesktopSettingsCreateSpecV2":{"required":["bundle_id","directory_id","running_mode"],"type":"object","properties":{"aws_core_workspace_schedules":{"type":"array","description":"The Schedules for workspace power policy can only be set for workspaces where the running mode is set to MANUAL","items":{"$ref":"#/components/schemas/AwsCoreWorkspaceScheduleCreateSpec"}},"bundle_id":{"type":"string","description":"AWS core bundle ID","example":"wdy-hv3jhyzb2"},"directory_id":{"type":"string","description":"AWS core directory ID","example":"d-94673ede63"},"idle_session_timeout":{"type":"integer","description":"Idle session timeout minutes for the aws desktop pools","format":"int32","example":10},"idle_session_timeout_policy":{"type":"string","description":"Idle session timeout policy for the aws desktop pools\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"NEVER","enum":["AFTER","IMMEDIATE","NEVER"]},"running_mode":{"type":"string","description":"Running mode for the AWS core workspaces in the desktop pool. This property has a default value of ALWAYS_ON\n* ALWAYS_ON: Billed monthly. Instant access to an always running WorkSpace.\n* MANUAL: Billed by the hour. WorkSpace starts and stops automatically at scheduled duration if the workspace schedule specified.","example":"ALWAYS_ON","enum":["ALWAYS_ON","MANUAL"]}},"description":"AWS core settings for automated desktop pool"},"AwsCoreDesktopSettingsUpdateSpec":{"type":"object","properties":{"aws_core_workspace_schedules":{"type":"array","description":"The Schedules for workspace power policy can only be set for workspaces where the running mode is set to MANUAL","items":{"$ref":"#/components/schemas/AwsCoreWorkspaceScheduleUpdateSpec"}}},"description":"AWS core settings for automated desktop pool, This property can be set only when source is set to AWS_CORE"},"AwsCoreDesktopSettingsUpdateSpecV2":{"type":"object","properties":{"aws_core_workspace_schedules":{"type":"array","description":"The Schedules for workspace power policy can only be set for workspaces where the running mode is set to MANUAL","items":{"$ref":"#/components/schemas/AwsCoreWorkspaceScheduleUpdateSpec"}},"idle_session_timeout":{"type":"integer","description":"Idle session timeout minutes for the aws desktop pools","format":"int32","example":10},"idle_session_timeout_policy":{"type":"string","description":"Idle session timeout policy for the aws desktop pools\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"NEVER","enum":["AFTER","IMMEDIATE","NEVER"]}},"description":"AWS core settings for automated desktop pool"},"AwsCoreDesktopSettingsV2":{"type":"object","properties":{"aws_core_workspace_schedules":{"type":"array","description":"Indicates the Schedules for workspace power policy","items":{"$ref":"#/components/schemas/AwsCoreWorkspaceSchedule"}},"bundle_id":{"type":"string","description":"Indicates AWS core bundle ID","example":"wdy-hv3jhyzb2"},"bundle_name":{"type":"string","description":"Name of the AWS core bundle","example":"cs1-bundle1"},"directory_id":{"type":"string","description":"Indicates AWS core directory ID","example":"d-94673ede63"},"directory_name":{"type":"string","description":"Name of the AWS core directory","example":"hznonaws.com"},"idle_session_timeout":{"type":"integer","description":"Idle session timeout minutes for the aws desktop pools","format":"int32","example":10},"idle_session_timeout_policy":{"type":"string","description":"Idle session timeout policy for the aws desktop pools\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"NEVER","enum":["AFTER","IMMEDIATE","NEVER"]},"image_name":{"type":"string","description":"Indicates AWS core Image Name","example":"wdy-hv3jhyzb2"},"running_mode":{"type":"string","description":"Running mode for the AWS core workspaces in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALWAYS_ON: Billed monthly. Instant access to an always running WorkSpace.\n* MANUAL: Billed by the hour. WorkSpace starts and stops automatically at scheduled duration if the workspace schedule specified.","example":"ALWAYS_ON","enum":["ALWAYS_ON","MANUAL"]}},"description":"AWS core settings for automated desktop pool"},"AwsCoreFarmSettingsCreateSpec":{"required":["bundle_id","directory_id","running_mode"],"type":"object","properties":{"bundle_id":{"type":"string","description":"Indicates AWS core bundle ID","example":"wdy-hv3jhyzb2"},"directory_id":{"type":"string","description":"Indicates AWS core directory ID","example":"d-94673ede63"},"running_mode":{"type":"string","description":"Running mode for the AWS core workspaces in the farm\n* ALWAYS_ON: Billed monthly. Instant access to an always running WorkSpace.","example":"ALWAYS_ON","enum":["ALWAYS_ON"]}},"description":"AWS core settings for automated farm"},"AwsCoreFarmSettingsInfoSpec":{"type":"object","properties":{"bundle_id":{"type":"string","description":"Indicates AWS core bundle ID","example":"wdy-hv3jhyzb2"},"bundle_name":{"type":"string","description":"Name of the AWS core bundle","example":"cs1-bundle1"},"directory_id":{"type":"string","description":"Indicates AWS core directory ID","example":"d-94673ede63"},"directory_name":{"type":"string","description":"Name of the AWS core directory","example":"hznonaws.com"},"image_id":{"type":"string","description":"ID of the source image that is associated with this AWS core bundle","example":"wsi-7b1ymfqqk"},"image_name":{"type":"string","description":"Name of the source image that is associated with this AWS core bundle","example":"hzn-image"},"running_mode":{"type":"string","description":"Running mode for the AWS core workspaces in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALWAYS_ON: Billed monthly. Instant access to an always running WorkSpace.","example":"ALWAYS_ON","enum":["ALWAYS_ON"]}},"description":"AWS core settings for automated farm"},"AwsCoreWorkspaceSchedule":{"type":"object","properties":{"days_of_the_week":{"type":"array","description":"Days of the week","example":["MONDAY","TUESDAY"],"items":{"type":"string","description":"Days of the week","example":"[\"MONDAY\",\"TUESDAY\"]"}},"name":{"type":"string","description":"Name of the schedule","example":"weekday"},"resume_time":{"type":"string","description":"Workspace resume time, This property must contain the time in 24 hours format.","example":"09:30"},"suspend_time":{"type":"string","description":"Workspace suspend time, This property must contain the time in 24 hours format.","example":"17:30"},"timezone":{"type":"string","description":"Timezone of the schedule","example":"Asia/Kolkata"}},"description":"The Schedules for workspace power policy."},"AwsCoreWorkspaceScheduleCreateSpec":{"required":["name","resume_time","suspend_time","timezone"],"type":"object","properties":{"days_of_the_week":{"type":"array","description":"Days of the week","example":["MONDAY","TUESDAY"],"items":{"type":"string","description":"Days of the week","example":"[\"MONDAY\",\"TUESDAY\"]"}},"name":{"type":"string","description":"Name of the schedule","example":"weekday"},"resume_time":{"type":"string","description":"Workspace resume time, This property must contain the time in 24 hours format.","example":"09:30"},"suspend_time":{"type":"string","description":"Workspace suspend time, This property must contain the time in 24 hours format.","example":"17:30"},"timezone":{"type":"string","description":"Timezone of the schedule","example":"Asia/Kolkata"}},"description":"The Schedules for AWS core workspace. This can only be set for workspaces where the running mode is set to MANUAL"},"AwsCoreWorkspaceScheduleUpdateSpec":{"required":["name","resume_time","suspend_time","timezone"],"type":"object","properties":{"days_of_the_week":{"type":"array","description":"Days of the week","example":["MONDAY","TUESDAY"],"items":{"type":"string","description":"Days of the week","example":"[\"MONDAY\",\"TUESDAY\"]"}},"name":{"type":"string","description":"Name of the schedule","example":"weekday"},"resume_time":{"type":"string","description":"Workspace resume time, This property must contain the time in 24 hours format.","example":"09:30"},"suspend_time":{"type":"string","description":"Workspace suspend time, This property must contain the time in 24 hours format.","example":"17:30"},"timezone":{"type":"string","description":"Timezone of the schedule","example":"Asia/Kolkata"}},"description":"The Schedules for workspace power policy. This can only be set for workspaces where the running mode is set to MANUAL"},"BaseFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Allowable values - And, Or, Not, NotEquals, Equals, Contains, NotContains, StartsWith, EndsWith, Between."}},"discriminator":{"propertyName":"type"}},"BaseSnapshotInfo":{"type":"object","properties":{"created_timestamp":{"type":"integer","description":"Epoch time in milli seconds, when the VM snapshot was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"description":{"type":"string","description":"Description of the VM snapshot.\nSupported Filters : 'Equals'.","example":"Base image snapshot"},"disk_size_mb":{"type":"integer","description":"Sum of capacities of all the virtual disks in the VM snapshot, in MB.\nSupported Filters : 'Between','Equals'.","format":"int64","example":42949},"hardware_version":{"type":"integer","description":"VM snapshot hardware version\nSupported Filters : 'Equals'.","format":"int32","example":13},"id":{"type":"string","description":"Unique ID representing the VM snapshot.\nSupported Filters : 'Equals'.","example":"snapshot-4"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this VM snapshot from being used in linked/instant clone desktop pool or farm creation.\nSupported Filters : 'Equals'.","items":{"type":"string","description":"* POWERED_ON: When the VM is powered ON.\n* INCOMPATIBLE_HARDWARE_VERSION: When the hardware version is not 11 or above, the VM cannot be used in instant clone desktop pool creation.","enum":["POWERED_ON","INCOMPATIBLE_HARDWARE_VERSION"]}},"max_number_of_monitors":{"type":"integer","description":"Maximum number of monitors set in SVGA settings for the VM snapshot in vCenter.\nSupported Filters : 'Equals'.","format":"int32","example":1},"max_resolution_of_any_one_monitor":{"type":"string","description":"Maximum resolution of any one monitor set in SVGA settings for the VM snapshot in vCenter.\nSupported Filters : 'Equals'.","example":"1600x1200"},"memory_mb":{"type":"integer","description":"The physical memory size of VM snapshot, in MB\nSupported Filters : 'Equals'.","format":"int32","example":4096},"memory_reservation_mb":{"type":"integer","description":"Amount of memory that is guaranteed available to the virtual machine, in MB.\nSupported Filters : 'Equals'.","format":"int64","example":0},"name":{"type":"string","description":"VM snapshot name.\nSupported Filters : 'Equals','StartsWith', 'Contains'.","example":"Snapshot1"},"path":{"type":"string","description":"VM snapshot path.\nSupported Filters : 'Equals'.","example":"/Snapshot1"},"renderer3d":{"type":"string","description":"Indicate how the virtual video device for the VM snapshot renders 3D graphics. Will be set only if VM snapshot supports 3D functions.\nSupported Filters : 'Equals'.\n* AUTOMATIC: 3D rendering is automatic.\n* DISABLED: 3D rendering is disabled.\n* HARDWARE: 3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.","example":"DISABLED","enum":["AUTOMATIC","DISABLED","HARDWARE","MANAGE_BY_VSPHERE_CLIENT","SOFTWARE"]},"total_video_memory_mb":{"type":"number","description":"Total video memory in MB set in SVGA settings for the VM snapshot in vCenter.\nSupported Filters : 'Equals'.","format":"double","example":8.0},"vcenter_id":{"type":"string","description":"Virtual Center id for this VM snapshot.\nSupported Filters : 'Equals'.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"vgpu_type":{"type":"string","description":"NVIDIA GRID vGPU type configured on this VM snapshot.\nSupported Filters : 'Equals'."}},"description":"Information related to VM snapshot."},"BaseSnapshotInfoV2":{"type":"object","properties":{"created_timestamp":{"type":"integer","description":"Epoch time in milli seconds, when the VM snapshot was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"description":{"type":"string","description":"Description of the VM snapshot.\nSupported Filters : 'Equals'.","example":"Base image snapshot"},"disk_size_mb":{"type":"integer","description":"Sum of capacities of all the virtual disks in the VM snapshot, in MB.\nSupported Filters : 'Between','Equals'.","format":"int64","example":42949},"hardware_version":{"type":"integer","description":"VM snapshot hardware version\nSupported Filters : 'Equals'.","format":"int32","example":13},"id":{"type":"string","description":"Unique ID representing the VM snapshot.\nSupported Filters : 'Equals'.","example":"snapshot-4"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this VM snapshot from being used in linked/instant clone desktop pool or farm creation.\nSupported Filters : 'Equals'.","items":{"type":"string","description":"* POWERED_ON: When the VM is powered ON.\n* INCOMPATIBLE_HARDWARE_VERSION: When the hardware version is not 11 or above, the VM cannot be used in instant clone desktop pool creation.","enum":["POWERED_ON","INCOMPATIBLE_HARDWARE_VERSION"]}},"max_number_of_monitors":{"type":"integer","description":"Maximum number of monitors set in SVGA settings for the VM snapshot in vCenter.\nSupported Filters : 'Equals'.","format":"int32","example":1},"max_resolution_of_any_one_monitor":{"type":"string","description":"Maximum resolution of any one monitor set in SVGA settings for the VM snapshot in vCenter.\nSupported Filters : 'Equals'.","example":"1600x1200"},"memory_mb":{"type":"integer","description":"The physical memory size of VM snapshot, in MB\nSupported Filters : 'Equals'.","format":"int32","example":4096},"memory_reservation_mb":{"type":"integer","description":"Amount of memory that is guaranteed available to the virtual machine, in MB.\nSupported Filters : 'Equals'.","format":"int64","example":0},"name":{"type":"string","description":"VM snapshot name.\nSupported Filters : 'Equals','StartsWith', 'Contains'.","example":"Snapshot1"},"num_cores_per_socket":{"type":"integer","description":"Number of cores per socket present on the VM snapshot.\nSupported Filters : 'Equals'.","format":"int32","example":2},"num_cpus":{"type":"integer","description":"Number of CPUs present on the VM snapshot.\nSupported Filters : 'Equals'.","format":"int32","example":4},"path":{"type":"string","description":"VM snapshot path.\nSupported Filters : 'Equals'.","example":"/Snapshot1"},"renderer3d":{"type":"string","description":"Indicate how the virtual video device for the VM snapshot renders 3D graphics. Will be set only if VM snapshot supports 3D functions.\nSupported Filters : 'Equals'.\n* AUTOMATIC: 3D rendering is automatic.\n* DISABLED: 3D rendering is disabled.\n* HARDWARE: 3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.","example":"DISABLED","enum":["AUTOMATIC","DISABLED","HARDWARE","MANAGE_BY_VSPHERE_CLIENT","SOFTWARE"]},"total_video_memory_mb":{"type":"number","description":"Total video memory in MB set in SVGA settings for the VM snapshot in vCenter.\nSupported Filters : 'Equals'.","format":"double","example":8.0},"vcenter_id":{"type":"string","description":"Virtual Center id for this VM snapshot.\nSupported Filters : 'Equals'.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"vgpu_type":{"type":"string","description":"NVIDIA GRID vGPU type configured on this VM snapshot.\nSupported Filters : 'Equals'."}},"description":"Information related to VM snapshot."},"BaseSnapshotInfoV3":{"type":"object","properties":{"carbon_black_ready_to_clone":{"type":"boolean","description":"Contains information on Carbon Black is ready to clone status.\n","example":false},"carbon_black_scan_percentage":{"type":"integer","description":"Contains information on Carbon Black scan percentage.\n","format":"int32","example":100},"created_timestamp":{"type":"integer","description":"Epoch time in milli seconds, when the VM snapshot was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"description":{"type":"string","description":"Description of the VM snapshot.\nSupported Filters : 'Equals'.","example":"Base image snapshot"},"disk_size_mb":{"type":"integer","description":"Sum of capacities of all the virtual disks in the VM snapshot, in MB.\nSupported Filters : 'Between','Equals'.","format":"int64","example":42949},"hardware_version":{"type":"integer","description":"VM snapshot hardware version\nSupported Filters : 'Equals'.","format":"int32","example":13},"id":{"type":"string","description":"Unique ID representing the VM snapshot.\nSupported Filters : 'Equals'.","example":"snapshot-4"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this VM snapshot from being used in linked/instant clone desktop pool or farm creation.\nSupported Filters : 'Equals'.","items":{"type":"string","description":"* POWERED_ON: When the VM is powered ON.\n* INCOMPATIBLE_HARDWARE_VERSION: When the hardware version is not 11 or above, the VM cannot be used in instant clone desktop pool creation.","enum":["POWERED_ON","INCOMPATIBLE_HARDWARE_VERSION"]}},"max_number_of_monitors":{"type":"integer","description":"Maximum number of monitors set in SVGA settings for the VM snapshot in vCenter.\nSupported Filters : 'Equals'.","format":"int32","example":1},"max_resolution_of_any_one_monitor":{"type":"string","description":"Maximum resolution of any one monitor set in SVGA settings for the VM snapshot in vCenter.\nSupported Filters : 'Equals'.","example":"1600x1200"},"memory_mb":{"type":"integer","description":"The physical memory size of VM snapshot, in MB\nSupported Filters : 'Equals'.","format":"int32","example":4096},"memory_reservation_mb":{"type":"integer","description":"Amount of memory that is guaranteed available to the virtual machine, in MB.\nSupported Filters : 'Equals'.","format":"int64","example":0},"name":{"type":"string","description":"VM snapshot name.\nSupported Filters : 'Equals','StartsWith', 'Contains'.","example":"Snapshot1"},"num_cores_per_socket":{"type":"integer","description":"Number of cores per socket present on the VM snapshot.\nSupported Filters : 'Equals'.","format":"int32","example":2},"num_cpus":{"type":"integer","description":"Number of CPUs present on the VM snapshot.\nSupported Filters : 'Equals'.","format":"int32","example":4},"path":{"type":"string","description":"VM snapshot path.\nSupported Filters : 'Equals'.","example":"/Snapshot1"},"renderer3d":{"type":"string","description":"Indicate how the virtual video device for the VM snapshot renders 3D graphics. Will be set only if VM snapshot supports 3D functions.\nSupported Filters : 'Equals'.\n* AUTOMATIC: 3D rendering is automatic.\n* DISABLED: 3D rendering is disabled.\n* HARDWARE: 3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.","example":"DISABLED","enum":["AUTOMATIC","DISABLED","HARDWARE","MANAGE_BY_VSPHERE_CLIENT","SOFTWARE"]},"total_video_memory_mb":{"type":"number","description":"Total video memory in MB set in SVGA settings for the VM snapshot in vCenter.\nSupported Filters : 'Equals'.","format":"double","example":8.0},"vcenter_id":{"type":"string","description":"Virtual Center id for this VM snapshot.\nSupported Filters : 'Equals'.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"vgpu_type":{"type":"string","description":"NVIDIA GRID vGPU type configured on this VM snapshot.\nSupported Filters : 'Equals'."}},"description":"Information related to VM snapshot."},"BaseVMInfo":{"type":"object","properties":{"datacenter_id":{"type":"string","description":"Datacenter id for this VM.\nSupported Filters : 'Equals'.","example":"datacenter-1"},"id":{"type":"string","description":"Unique ID representing a VM.\nSupported Filters : 'Equals'.","example":"vm-416"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this BaseVM from having its snapshots used in linked or instant clone desktop or farm creation.\nSupported Filters : 'Equals', 'Contains'.","items":{"type":"string","description":"* IN_USE_BY_DESKTOP_POOL: When this base VM is already a machine that belongs to another manual or automatic desktop pool or farm.\n* IN_USE_BY_LINKED_CLONE_DESKTOP_POOL: When this base VM is already a machine that belongs to a linked clone desktop pool or farm.\n* VIEW_COMPOSER_REPLICA: When this base VM is a View Composer or Instant Clone Engine replica.\n* UNSUPPORTED_OS_FOR_FARM: When this base VM has an unsupported server operating system.\n* UNSUPPORTED_OS: When this base VM has an unsupported machine operating system. Certain desktop server operating systems are only supported when SettingsInfo.GeneralSettings.enableServerInSingleUserMode is true.\n* NO_SNAPSHOTS: When this base VM has a supported OS but contains no snapshots.\n* INSTANT_INTERNAL: When this base VM is a Instant Clone Engine internal virtual machine.\n* IN_USE_BY_INSTANT_CLONE_DESKTOP_POOL: When this base VM is already a machine that belongs to a instant clone desktop pool or farm.","enum":["IN_USE_BY_DESKTOP_POOL","IN_USE_BY_LINKED_CLONE_DESKTOP_POOL","VIEW_COMPOSER_REPLICA","UNSUPPORTED_OS_FOR_FARM","UNSUPPORTED_OS","NO_SNAPSHOTS","INSTANT_INTERNAL","IN_USE_BY_INSTANT_CLONE_DESKTOP_POOL"]}},"name":{"type":"string","description":"VM name.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting.","example":"Win10"},"network_type":{"type":"string","description":"Type of network base VM belongs to.\nSupported Filters : 'Equals'.\n* STANDARD_NETWORK: Standard network.\n* OPAQUE_NETWORK: Opaque network.\n* DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS port group.","example":"STANDARD_NETWORK","enum":["STANDARD_NETWORK","OPAQUE_NETWORK","DISTRUBUTED_VIRTUAL_PORT_GROUP"]},"operating_system":{"type":"string","description":"Operating system.\nSupported Filters : 'Equals'.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_10","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_display_name":{"type":"string","description":"Operating system display name from Virtual Center.\nSupported Filters : 'Equals','StartsWith','Contains'.","example":"Microsoft Windows 10 (64-bit)"},"path":{"type":"string","description":"VM path.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting.","example":"/Datacenter/vm/VMs/Win10"},"vcenter_id":{"type":"string","description":"Virtual Center id for this VM.\nSupported Filters : 'Equals'.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}},"description":"Information related to base VM."},"BaseVMInfoV2":{"type":"object","properties":{"datacenter_id":{"type":"string","description":"Datacenter id for this VM.\nSupported Filters : 'Equals'.","example":"datacenter-1"},"id":{"type":"string","description":"Unique ID representing a VM.\nSupported Filters : 'Equals'.","example":"vm-416"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this BaseVM from having its snapshots used in linked or instant clone desktop or farm creation.\nSupported Filters : 'Equals', 'Contains'.","items":{"type":"string","description":"* IN_USE_BY_DESKTOP_POOL: When this base VM is already a machine that belongs to another manual or automatic desktop pool or farm.\n* IN_USE_BY_LINKED_CLONE_DESKTOP_POOL: When this base VM is already a machine that belongs to a linked clone desktop pool or farm.\n* VIEW_COMPOSER_REPLICA: When this base VM is a View Composer or Instant Clone Engine replica.\n* UNSUPPORTED_OS_FOR_FARM: When this base VM has an unsupported server operating system.\n* UNSUPPORTED_OS: When this base VM has an unsupported machine operating system. Certain desktop server operating systems are only supported when SettingsInfo.GeneralSettings.enableServerInSingleUserMode is true.\n* NO_SNAPSHOTS: When this base VM has a supported OS but contains no snapshots.\n* INSTANT_INTERNAL: When this base VM is a Instant Clone Engine internal virtual machine.\n* IN_USE_BY_INSTANT_CLONE_DESKTOP_POOL: When this base VM is already a machine that belongs to a instant clone desktop pool or farm.","enum":["IN_USE_BY_DESKTOP_POOL","IN_USE_BY_LINKED_CLONE_DESKTOP_POOL","VIEW_COMPOSER_REPLICA","UNSUPPORTED_OS_FOR_FARM","UNSUPPORTED_OS","NO_SNAPSHOTS","INSTANT_INTERNAL","IN_USE_BY_INSTANT_CLONE_DESKTOP_POOL"]}},"name":{"type":"string","description":"VM name.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting.","example":"Win10"},"network_type":{"type":"string","description":"Type of network base VM belongs to.\nSupported Filters : 'Equals'.\n* STANDARD_NETWORK: Standard network.\n* OPAQUE_NETWORK: Opaque network.\n* DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS port group.","example":"STANDARD_NETWORK","enum":["STANDARD_NETWORK","OPAQUE_NETWORK","DISTRUBUTED_VIRTUAL_PORT_GROUP"]},"num_nics":{"type":"integer","description":"Number of network interface cards in a VM.\nSupported Filters : 'Equals'.","format":"int32","example":2},"operating_system":{"type":"string","description":"Operating system.\nSupported Filters : 'Equals'.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_10","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_display_name":{"type":"string","description":"Operating system display name from Virtual Center.\nSupported Filters : 'Equals','StartsWith','Contains'.","example":"Microsoft Windows 10 (64-bit)"},"path":{"type":"string","description":"VM path.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting.","example":"/Datacenter/vm/VMs/Win10"},"vcenter_id":{"type":"string","description":"Virtual Center id for this VM.\nSupported Filters : 'Equals'.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}},"description":"Information related to base VM."},"BaseVMInfoV3":{"type":"object","properties":{"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the Base-VM was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"datacenter_id":{"type":"string","description":"Datacenter id for this VM.\nSupported Filters : 'Equals'.","example":"datacenter-1"},"id":{"type":"string","description":"Unique ID representing a VM.\nSupported Filters : 'Equals'.","example":"vm-416"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this BaseVM from having its snapshots used in linked or instant clone desktop or farm creation.\nSupported Filters : 'Equals', 'Contains'.","items":{"type":"string","description":"* IN_USE_BY_DESKTOP_POOL: When this base VM is already a machine that belongs to another manual or automatic desktop pool or farm.\n* IN_USE_BY_LINKED_CLONE_DESKTOP_POOL: When this base VM is already a machine that belongs to a linked clone desktop pool or farm.\n* VIEW_COMPOSER_REPLICA: When this base VM is a View Composer or Instant Clone Engine replica.\n* UNSUPPORTED_OS_FOR_FARM: When this base VM has an unsupported server operating system.\n* UNSUPPORTED_OS: When this base VM has an unsupported machine operating system. Certain desktop server operating systems are only supported when SettingsInfo.GeneralSettings.enableServerInSingleUserMode is true.\n* NO_SNAPSHOTS: When this base VM has a supported OS but contains no snapshots.\n* INSTANT_INTERNAL: When this base VM is a Instant Clone Engine internal virtual machine.\n* IN_USE_BY_INSTANT_CLONE_DESKTOP_POOL: When this base VM is already a machine that belongs to a instant clone desktop pool or farm.","enum":["IN_USE_BY_DESKTOP_POOL","IN_USE_BY_LINKED_CLONE_DESKTOP_POOL","VIEW_COMPOSER_REPLICA","UNSUPPORTED_OS_FOR_FARM","UNSUPPORTED_OS","NO_SNAPSHOTS","INSTANT_INTERNAL","IN_USE_BY_INSTANT_CLONE_DESKTOP_POOL"]}},"name":{"type":"string","description":"VM name.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting.","example":"Win10"},"network_type":{"type":"string","description":"Type of network base VM belongs to.\nSupported Filters : 'Equals'.\n* STANDARD_NETWORK: Standard network.\n* OPAQUE_NETWORK: Opaque network.\n* DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS port group.","example":"STANDARD_NETWORK","enum":["STANDARD_NETWORK","OPAQUE_NETWORK","DISTRUBUTED_VIRTUAL_PORT_GROUP"]},"num_nics":{"type":"integer","description":"Number of network interface cards in a VM.\nSupported Filters : 'Equals'.","format":"int32","example":2},"operating_system":{"type":"string","description":"Operating system.\nSupported Filters : 'Equals'.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_10","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_display_name":{"type":"string","description":"Operating system display name from Virtual Center.\nSupported Filters : 'Equals','StartsWith','Contains'.","example":"Microsoft Windows 10 (64-bit)"},"path":{"type":"string","description":"VM path.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting.","example":"/Datacenter/vm/VMs/Win10"},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the Base-VM was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"vcenter_id":{"type":"string","description":"Virtual Center id for this VM.\nSupported Filters : 'Equals'.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}},"description":"Information related to base VM."},"BetweenFilter":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseFilter"},{"type":"object","properties":{"from_value":{"type":"object"},"name":{"type":"string"},"to_value":{"type":"object"}}}],"required":["from_value","name","to_value","type"]},"BlastPerformanceData":{"type":"object","properties":{"audio_bytes_received":{"type":"integer","description":"The number of bytes of audio data that have been received.","format":"int64","example":1652079610000},"audio_bytes_transmitted":{"type":"integer","description":"The number of bytes of audio data that have been transmitted.","format":"int64","example":1652079610000},"cdr_bytes_received":{"type":"integer","description":"The number of bytes of CDR data that have been received.","format":"int64","example":1652079610000},"cdr_bytes_transmitted":{"type":"integer","description":"The number of bytes of CDR data that have been transmitted.","format":"int64","example":1652079610000},"imaging_bytes_received":{"type":"integer","description":"The number of bytes of imaging data that have been received.","format":"int64","example":1652079610000},"imaging_bytes_transmitted":{"type":"integer","description":"The number of bytes of imaging data that have been transmitted.","format":"int64","example":1652079610000},"imaging_encoder_type":{"type":"string","description":"The codec value for Blast Performance Data","example":"test"},"imaging_frames_per_second":{"type":"integer","description":"Number of image frames per second.","format":"int64","example":1652079610000},"session_bandwidth_uplink":{"type":"integer","description":"Uplink bandwidth averaged over the sampling period, in kilobits per second.","format":"int64","example":3872079619320},"session_bytes_transmitted":{"type":"integer","description":"Transmitted bytes on the connection.","format":"int64","example":1652079610000},"session_packet_loss_uplink":{"type":"integer","description":"Network packet loss for uplink.","format":"int64","example":1652079610000},"session_round_trip_time":{"type":"integer","description":"The round trip time in milliseconds between the server and the client.","format":"int64","example":1652079610000}},"description":"Information related to Blast Performance Data."},"BlastPerformanceDataV2":{"type":"object","properties":{"audio_bytes_received":{"type":"integer","description":"The number of bytes of audio data that have been received.","format":"int64","example":1652079610000},"audio_bytes_transmitted":{"type":"integer","description":"The number of bytes of audio data that have been transmitted.","format":"int64","example":1652079610000},"cdr_bytes_received":{"type":"integer","description":"The number of bytes of CDR data that have been received.","format":"int64","example":1652079610000},"cdr_bytes_transmitted":{"type":"integer","description":"The number of bytes of CDR data that have been transmitted.","format":"int64","example":1652079610000},"imaging_bytes_received":{"type":"integer","description":"The number of bytes of imaging data that have been received.","format":"int64","example":1652079610000},"imaging_bytes_transmitted":{"type":"integer","description":"The number of bytes of imaging data that have been transmitted.","format":"int64","example":1652079610000},"imaging_encoder_type":{"type":"string","description":"The codec value for Blast Performance Data","example":"test"},"imaging_frames_per_second":{"type":"integer","description":"Number of image frames per second.","format":"int64","example":1652079610000},"session_bandwidth_uplink":{"type":"integer","description":"Uplink bandwidth averaged over the sampling period, in kilobits per second.","format":"int64","example":3872079619320},"session_bytes_transmitted":{"type":"integer","description":"Transmitted bytes on the connection.","format":"int64","example":1652079610000},"session_instantaneous_received_bytes_tcp":{"type":"integer","description":"Current received bytes for the active session over TCP.","format":"int64","example":1652079610000},"session_instantaneous_received_bytes_udp":{"type":"integer","description":"Current received bytes for the active session over UDP.","format":"int64","example":1652079610560},"session_instantaneous_transmitted_bytes_tcp":{"type":"integer","description":"Current transmitted bytes for the active session over TCP.","format":"int64","example":1652079613200},"session_instantaneous_transmitted_bytes_udp":{"type":"integer","description":"Current transmitted bytes for the active session over UDP.","format":"int64","example":3872079619320},"session_packet_loss_uplink":{"type":"integer","description":"Network packet loss for uplink.","format":"int64","example":1652079610000},"session_round_trip_time":{"type":"integer","description":"The round trip time in milliseconds between the server and the client.","format":"int64","example":1652079610000}},"description":"Information related to Blast Performance Data."},"BulkEntitlementResponseInfo":{"type":"object","properties":{"details":{"type":"array","description":"List of entitlement response info objects corresponding to each of the given ad-user-or-group SID.","items":{"$ref":"#/components/schemas/EntitlementResponseInfo"}},"error_messages":{"type":"array","description":"Reasons for the failure of the operation. This field is deprecated since 2203 release.","example":["Entity does not exists.","Property is mandatory."],"deprecated":true,"items":{"type":"string","description":"Reasons for the failure of the operation. This field is deprecated since 2203 release.","example":"[\"Entity does not exists.\",\"Property is mandatory.\"]"}},"errors":{"type":"array","description":"List of error objects containing error key and error message.","items":{"$ref":"#/components/schemas/APIError"}},"id":{"type":"string","description":"Unique ID representing the resource for the entitlement operation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"status_code":{"type":"integer","description":"Response HTTP status code of the operation.","format":"int32","example":200},"timestamp":{"type":"integer","description":"Timestamp in milliseconds when the operation failed. Measured as epoch time.","format":"int64","example":1561939200000}},"description":"Response for each of the entitlement operation for a resource in a bulk entitlement operation."},"BulkGlobalSessionActionResponseInfo":{"type":"object","properties":{"details":{"type":"array","description":"List of BulkItemResponseInfo corresponding to each session id in the action operation.","items":{"$ref":"#/components/schemas/BulkItemResponseInfo"}},"error_messages":{"type":"array","description":"Reasons for failure of the operation. This field is deprecated since 2203 release.","example":["Entity does not exist."],"deprecated":true,"items":{"type":"string","description":"Reasons for failure of the operation. This field is deprecated since 2203 release.","example":"[\"Entity does not exist.\"]"}},"errors":{"type":"array","description":"List of error objects containing error key and error message.","items":{"$ref":"#/components/schemas/APIError"}},"pod_id":{"type":"string","description":"ID of the hosting pod for the sessions.","example":"54c122e0-d6b5-476c-af91-fd00392e5983"},"status_code":{"type":"integer","description":"HTTP Status Code of the operation.","format":"int32","example":200},"timestamp":{"type":"integer","description":"Timestamp in milliseconds when the operation failed. \nMeasured as epoch time.","format":"int64","example":1611939200000}},"description":"Response corresponding to each pod in a bulk global session action operation."},"BulkItemResponseInfo":{"type":"object","properties":{"error_messages":{"type":"array","description":"Reasons for the failure of the operation. This field is deprecated since 2203 release.","example":["Entity does not exist.","Property is mandatory."],"deprecated":true,"items":{"type":"string","description":"Reasons for the failure of the operation. This field is deprecated since 2203 release.","example":"[\"Entity does not exist.\",\"Property is mandatory.\"]"}},"errors":{"type":"array","description":"List of error objects containing error key and error message.","items":{"$ref":"#/components/schemas/APIError"}},"id":{"type":"string","description":"Unique ID representing the entity on which the operation was performed. Will not be populated for create operation if the operation fails.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"key":{"type":"string","description":"Key on which the operation was performed.","example":"user1"},"status_code":{"type":"integer","description":"Response HTTP status code of the operation.","format":"int32","example":200},"timestamp":{"type":"integer","description":"Timestamp in milliseconds when the operation failed. Measured as epoch time.","format":"int64","example":1561939200000}},"description":"Response for each of the operation in a bulk operation."},"CEIPInfo":{"type":"object","properties":{"company_size":{"type":"string","description":"The size of the company.\n* SIZE_1_100: Company size between 1 and 100.\n* SIZE_101_500: Company size between 101 and 500.\n* SIZE_501_1000: Company size between 501 and 1000.\n* SIZE_1001_5000: Company size between 1001 and 5000.\n* SIZE_5001_10000: Company size between 5001 and 10000.\n* SIZE_10001: Company size greater than 10000.","example":"SIZE_1_100","enum":["SIZE_1_100","SIZE_101_500","SIZE_501_1000","SIZE_1001_5000","SIZE_5001_10000","SIZE_10001"]},"enabled":{"type":"boolean","description":"Indicates whether to send information to VMware.","example":true},"geolocation":{"type":"string","description":"The geolocation of the company.","example":"ASIA_PACIFIC"},"vertical":{"type":"string","description":"The vertical of the company.","example":"BANKING_FINANCE"}},"description":"Configuration information for the customer experience improvement program."},"CEIPUpdateSpec":{"required":["enabled"],"type":"object","properties":{"company_size":{"type":"string","description":"The size of the company.\n* SIZE_1_100: Company size between 1 and 100.\n* SIZE_101_500: Company size between 101 and 500.\n* SIZE_501_1000: Company size between 501 and 1000.\n* SIZE_1001_5000: Company size between 1001 and 5000.\n* SIZE_5001_10000: Company size between 5001 and 10000.\n* SIZE_10001: Company size greater than 10000.","example":"SIZE_1_100","enum":["SIZE_1_100","SIZE_101_500","SIZE_501_1000","SIZE_1001_5000","SIZE_5001_10000","SIZE_10001"]},"enabled":{"type":"boolean","description":"Indicates whether to send information to Omnissa.","example":true},"geolocation":{"type":"string","description":"The geolocation of the company.\n* AFRICA: Africa\n* AMERICA_NORTH: North America\n* AMERICA_SOUTH_CENTRAL: Central or South America\n* ASIA_PACIFIC: Asia Pacific\n* AUSTRALIA: Australia\n* EUROPE: Europe\n* MIDDLE_EAST: Middle East","example":"ASIA_PACIFIC","enum":["AFRICA","AMERICA_NORTH","AMERICA_SOUTH_CENTRAL","ASIA_PACIFIC","AUSTRALIA","EUROPE","MIDDLE_EAST"]},"vertical":{"type":"string","description":"The vertical of the company.\n* AGRICULTURE: Agriculture\n* BANKING_FINANCE: Banking and Finance\n* BUSINESS_SERVICES: Business Services\n* COMMUNICATIONS: Communications\n* CONSTRUCTION: Construction\n* EDUCATION: Education\n* ENERGY_MINING: Energy and Mining\n* GOV_FEDERAL_NATIONAL: Federal or National Government\n* GOV_STATE_LOCAL: State or Local Government\n* HEALTH_CARE: Health Care\n* HIGH_TECH: High Tech\n* LIFE_SCIENCES: Life Sciences\n* MANUFACTURING_DISCRETE: Discrete Manufacturing\n* MANUFACTURING_PROCESS: Manufacturing Processes\n* MEDIA_ENTERTAINMENT: Media and Entertainment\n* OTHER: Other\n* PHARMACEUTICAL: Pharmaceutical\n* RETAIL_WHOLESALE: Retail and Wholesale\n* SERVICES: Services\n* TRANSPORTATION: Transportation\n* UTILITIES: Utilities","example":"BANKING_FINANCE","enum":["AGRICULTURE","BANKING_FINANCE","BUSINESS_SERVICES","COMMUNICATIONS","CONSTRUCTION","EDUCATION","ENERGY_MINING","GOV_FEDERAL_NATIONAL","GOV_STATE_LOCAL","HEALTH_CARE","HIGH_TECH","LIFE_SCIENCES","MANUFACTURING_DISCRETE","MANUFACTURING_PROCESS","MEDIA_ENTERTAINMENT","OTHER","PHARMACEUTICAL","RETAIL_WHOLESALE","SERVICES","TRANSPORTATION","UTILITIES"]}},"description":"CEIP object to be updated."},"CPAEjectSpec":{"required":["pod_id"],"type":"object","properties":{"pod_id":{"type":"string","description":"The ID of the pod that has to be removed from Pod Federation.","example":"9e94a90d-e7c2-40b6-a702-bd781512408d"}},"description":"The specification for removing a pod from pod federation."},"CPAJoinSpec":{"required":["password","remote_pod_address","username"],"type":"object","properties":{"password":{"type":"array","description":"The password for the user.","example":"<password>","items":{"type":"string","description":"The password for the user.","example":"<password>"}},"remote_pod_address":{"type":"string","description":"The IP address or hostname for the remote pod.","example":"cs1.example.com"},"username":{"type":"string","description":"The user name, along with domain name, with sufficient privilege to perform a global LDAP join against the remote pod. The down-level logon name format (domain\\username) is allowed.","example":"AD-TEST-DOMAIN\\Administrator"}},"description":"The specification for joining the pod federation."},"CPAKeyPairRotationSpec":{"type":"object","properties":{"retain_latest_key_pair":{"type":"integer","description":"Number of key pairs to retain from existing generations of CPA key pair. Default value is 0.","format":"int32","example":1}},"description":"The specification for rotating CPA key pair."},"CPATaskResponseInfo":{"type":"object","properties":{"task_id":{"type":"string","description":"Unique ID representing the task.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"}},"description":"CPA action response."},"CPAUpdateSpec":{"required":["name"],"type":"object","properties":{"name":{"maxLength":64,"minLength":0,"type":"string","description":"Name of the pod federation.","example":"Horizon Cloud Pod Federation"}},"description":"Pod Federation object to be updated."},"CPAUpdateSpecV2":{"required":["name"],"type":"object","properties":{"name":{"maxLength":64,"minLength":0,"type":"string","description":"Name of the pod federation.","example":"Horizon Cloud Pod Federation"},"site_redirection_settings":{"$ref":"#/components/schemas/SiteRedirectionSettings"}},"description":"Pod Federation object to be updated."},"CPAutomatedFarmSettings":{"type":"object","properties":{"capacity_provider_id":{"type":"string","description":"ID of the capacity provider.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"capacity_provider_identifier":{"type":"string","description":"Identifier of the Capacity Provider that manages the RDS server of the farm.","example":"prism.example"},"capacity_provider_resource_settings":{"$ref":"#/components/schemas/CPFarmCapacityProviderResourceSettings"},"customization_settings":{"$ref":"#/components/schemas/CPFarmCustomizationSettings"},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by default.","example":true},"image_source":{"type":"string","description":"Applicable To: Automated farm.<br>Source of image used in the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"operating_system":{"type":"string","description":"The guest operating system.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2016","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"provisioning_settings":{"$ref":"#/components/schemas/CPFarmProvisioningSettings"},"provisioning_status_data":{"$ref":"#/components/schemas/CPFarmProvisioningStatusData"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm.\nThis property can be used for sorting.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]}},"description":"Settings for Automated farm"},"CPDesktopPoolCreateSpec":{"required":["capacity_provider_id","disk_type","name","persistence","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true. This should be false for the AWS-CORE desktop pools.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nDefault value - BOTH.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"assignment_method":{"type":"string","description":"Applicable To: Dedicated desktop pools<br>Assignment method of the machine. \n* AUTOMATIC: Automatic assignment of a user the first time they access the machine.\n* MANUAL: Manual assignment of a user to the machine\n* MULTI_USER: Multiple users assignment to the machine","example":"AUTOMATIC","enum":["AUTOMATIC","MANUAL","MULTI_USER"]},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"capacity_provider_resource_settings":{"$ref":"#/components/schemas/DesktopCapacityProviderResourceSettingsCreateSpec"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopCustomizationSettingsCreateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"desktop_session_settings":{"$ref":"#/components/schemas/DesktopSessionSettingsCreateSpec"},"disk_type":{"type":"string","description":"Disk type of the Desktop Pool.\n* FULL_CLONE: The Desktop Pool uses full clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.","example":"FULL_CLONE","enum":["FULL_CLONE","LINKED_CLONE"]},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","example":"ManualPool"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool. Default value is false.","example":false},"persistence":{"type":"string","description":"Persistence of the Desktop Pool.\n* PERSISTENCE: Persistence\n* NON_PERSISTENCE: Non persistense","example":"Persistent","enum":["PERSISTENCE","NON_PERSISTENCE"]},"power_policy":{"type":"string","description":"Applicable to managed machines with default value as ALWAYS_POWERED_ON. Power policy for the machines in the desktop pool.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\n* SCHEDULED: Desktops power operations are scheduled.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION","SCHEDULED"]},"power_schedules":{"type":"array","description":"The Schedules for the machines. This can only be set when the power_policy is set to SCHEDULED","items":{"$ref":"#/components/schemas/DesktopPowerScheduleCreateSpec"}},"provisioning_settings":{"$ref":"#/components/schemas/DesktopProvisioningSettingsCreateSpec"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect.\nDefault value - false."},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"type":{"type":"string","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.<br>\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]}},"description":"Desktop pool object to be created."},"CPDesktopPoolCreateSpecV2":{"required":["capacity_provider_id","disk_type","name","persistence","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools with default value as false.<br>Indicates whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user from session_settings will be applicable. <br>","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true. This should be false for the AWS-CORE desktop pools.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nDefault value - BOTH.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"assignment_method":{"type":"string","description":"Applicable To: Dedicated desktop pools<br>Assignment method of the machine. \n* AUTOMATIC: Automatic assignment of a user the first time they access the machine.\n* MANUAL: Manual assignment of a user to the machine\n* MULTI_USER: Multiple users assignment to the machine","example":"AUTOMATIC","enum":["AUTOMATIC","MANUAL","MULTI_USER"]},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"capacity_provider_resource_settings":{"$ref":"#/components/schemas/DesktopCapacityProviderResourceSettingsCreateSpec"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop pool is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is true.This can be changed to false only if there are no entitlements.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop pool is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>This cannot be set to true, if any of the conditions are satisfied:<br>1. user is provided.<br>2. enabled is false.<br>3. session_type is not DESKTOP.<br>4. global_entitlement is set.<br>5. user_assignment is DEDICATED.<br>6. automatic_user_assignment is false.<br>7. Local entitlements are configured.<br>8. Any of the machines in the pool have users assigned.<br>9. cs_restriction_tags is not set.<br>10. type is MANUAL.<br>","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopCustomizationSettingsCreateSpecV2"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"desktop_session_settings":{"$ref":"#/components/schemas/DesktopSessionSettingsCreateSpec"},"disk_type":{"type":"string","description":"Disk type of the Desktop Pool.\n* FULL_CLONE: The Desktop Pool uses full clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.","example":"FULL_CLONE","enum":["FULL_CLONE","LINKED_CLONE"]},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS Desktop pool.<br>Farm is needed to create RDS desktop pool. This is required for RDS desktop pools.This Farm must not already be associated with another RDS desktop.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","example":"ManualPool"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool. Default value is false.","example":false},"persistence":{"type":"string","description":"Persistence of the Desktop Pool.\n* PERSISTENCE: Persistence\n* NON_PERSISTENCE: Non persistense","example":"Persistent","enum":["PERSISTENCE","NON_PERSISTENCE"]},"power_policy":{"type":"string","description":"Applicable to managed machines with default value as ALWAYS_POWERED_ON. Power policy for the machines in the desktop pool.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\n* SCHEDULED: Desktops power operations are scheduled.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION","SCHEDULED"]},"power_schedules":{"type":"array","description":"The Schedules for the machines. This can only be set when the power_policy is set to SCHEDULED","items":{"$ref":"#/components/schemas/DesktopPowerScheduleCreateSpec"}},"provisioning_settings":{"$ref":"#/components/schemas/DesktopProvisioningSettingsCreateSpec"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect.\nDefault value - false."},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"type":{"type":"string","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"uem_server_id":{"type":"string","description":"UEM Server Id.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"user_assignment":{"type":"string","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.<br>\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]}},"description":"Desktop pool object to be created."},"CPDesktopPoolCreateSpecV3":{"required":["capacity_provider_id","disk_type","entra_sso_enabled","name","persistence","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools with default value as false.<br>Indicates whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user from session_settings will be applicable. <br>","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true. This should be false for the AWS-CORE desktop pools.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nDefault value - BOTH.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"assignment_method":{"type":"string","description":"Applicable To: Dedicated desktop pools<br>Assignment method of the machine. \n* AUTOMATIC: Automatic assignment of a user the first time they access the machine.\n* MANUAL: Manual assignment of a user to the machine\n* MULTI_USER: Multiple users assignment to the machine","example":"AUTOMATIC","enum":["AUTOMATIC","MANUAL","MULTI_USER"]},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"capacity_provider_resource_settings":{"$ref":"#/components/schemas/DesktopCapacityProviderResourceSettingsCreateSpec"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop pool is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is true.This can be changed to false only if there are no entitlements.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop pool is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>This cannot be set to true, if any of the conditions are satisfied:<br>1. user is provided.<br>2. enabled is false.<br>3. session_type is not DESKTOP.<br>4. global_entitlement is set.<br>5. user_assignment is DEDICATED.<br>6. automatic_user_assignment is false.<br>7. Local entitlements are configured.<br>8. Any of the machines in the pool have users assigned.<br>9. cs_restriction_tags is not set.<br>10. type is MANUAL.<br>","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopCustomizationSettingsCreateSpecV2"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"desktop_session_settings":{"$ref":"#/components/schemas/DesktopSessionSettingsCreateSpec"},"disk_type":{"type":"string","description":"Disk type of the Desktop Pool.\n* FULL_CLONE: The Desktop Pool uses full clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.","example":"FULL_CLONE","enum":["FULL_CLONE","LINKED_CLONE"]},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled for desktop pool","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS Desktop pool.<br>Farm is needed to create RDS desktop pool. This is required for RDS desktop pools.This Farm must not already be associated with another RDS desktop.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","example":"ManualPool"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool. Default value is false.","example":false},"persistence":{"type":"string","description":"Persistence of the Desktop Pool.\n* PERSISTENCE: Persistence\n* NON_PERSISTENCE: Non persistense","example":"Persistent","enum":["PERSISTENCE","NON_PERSISTENCE"]},"power_policy":{"type":"string","description":"Applicable to managed machines with default value as ALWAYS_POWERED_ON. Power policy for the machines in the desktop pool.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\n* SCHEDULED: Desktops power operations are scheduled.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION","SCHEDULED"]},"power_schedules":{"type":"array","description":"The Schedules for the machines. This can only be set when the power_policy is set to SCHEDULED","items":{"$ref":"#/components/schemas/DesktopPowerScheduleCreateSpec"}},"provisioning_settings":{"$ref":"#/components/schemas/DesktopProvisioningSettingsCreateSpec"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect.\nDefault value - false."},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"type":{"type":"string","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"uem_server_id":{"type":"string","description":"UEM Server Id.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"user_assignment":{"type":"string","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.<br>\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]}},"description":"Desktop pool object to be created."},"CPDesktopPoolInfo":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true.\nThis property can be used for sorting.","example":true},"assignment_method":{"type":"string","description":"Applicable To: Dedicated desktop pools<br>Assignment method of the machine. \n* AUTOMATIC: Automatic assignment of a user the first time they access the machine.\n* MANUAL: Manual assignment of a user to the machine\n* MULTI_USER: Multiple users assignment to the machine","example":"Persistent","enum":["AUTOMATIC","MANUAL","MULTI_USER"]},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider. Supported Filters: 'Equals'.","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"capacity_provider_name":{"type":"string","description":"Name of the Capacity Provider that manages the machines of the desktop pool.","example":"prism.example"},"capacity_provider_resource_settings":{"$ref":"#/components/schemas/CapacityProviderResourceSettings"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server."}},"customization_settings":{"$ref":"#/components/schemas/CustomizationSettings"},"default_display_protocol":{"type":"string","description":"The default display protocol for the desktop pool. For a managed desktop pool, this will default to PCOIP.For an unmanaged desktop pool, this will default to RDP.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"desktop_session_settings":{"$ref":"#/components/schemas/DesktopSessionSettings"},"disk_type":{"type":"string","description":"Disk type of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* FULL_CLONE: The Desktop Pool uses full clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.","example":"FULL_CLONE","enum":["FULL_CLONE","LINKED_CLONE"]},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_entitlement_name":{"type":"string","description":"Total Number of Application Sessions on the Desktop.\n"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"num_sessions":{"type":"integer","description":"Total Number of Sessions on the Desktop.\n","format":"int32"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool.","example":false},"persistence":{"type":"string","description":"Persistence of the Desktop Pool.\n* PERSISTENCE: Persistence\n* NON_PERSISTENCE: Non persistense","example":"Persistent","enum":["PERSISTENCE","NON_PERSISTENCE"]},"power_policy":{"type":"string","description":"Power policy for the machines in the desktop pool after logoff. This setting is only relevant for managed machines.Default value is TAKE_NO_POWER_ACTION.\nThis property can be used for sorting.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\n* SCHEDULED: Desktops power operations are scheduled.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION","SCHEDULED"]},"power_schedules":{"type":"array","description":"The Schedules for the machines. This can only be set when the power_policy is set to SCHEDULED","items":{"$ref":"#/components/schemas/PowerSchedule"}},"provisioning_settings":{"$ref":"#/components/schemas/ProvisioningSettings"},"provisioning_status_data":{"$ref":"#/components/schemas/ProvisioningStatusData"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.","example":"PRISM"},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","description":"Count of user or group entitlements present for the desktop pool.\nThis property can be used for sorting.","format":"int32","example":1}},"description":"Information required to desktop pool."},"CPDesktopPoolInfoV2":{"required":["customization_settings"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true.\nThis property can be used for sorting.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nSupported Filters: Equals.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"application_count":{"type":"integer","description":"Number of applications associated with the desktop","format":"int32","example":2},"assignment_method":{"type":"string","description":"Applicable To: Dedicated desktop pools<br>Assignment method of the machine. \n* AUTOMATIC: Automatic assignment of a user the first time they access the machine.\n* MANUAL: Manual assignment of a user to the machine\n* MULTI_USER: Multiple users assignment to the machine","example":"Persistent","enum":["AUTOMATIC","MANUAL","MULTI_USER"]},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider. Supported Filters: 'Equals'.","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"capacity_provider_name":{"type":"string","description":"Name of the Capacity Provider that manages the machines of the desktop pool.","example":"prism.example"},"capacity_provider_resource_settings":{"$ref":"#/components/schemas/CapacityProviderResourceSettingsV2"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services. This can be false only when cloud_assigned is false.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server."}},"customization_settings":{"$ref":"#/components/schemas/CustomizationSettingsV2"},"default_display_protocol":{"type":"string","description":"The default display protocol for the desktop pool. For a managed desktop pool, this will default to PCOIP.For an unmanaged desktop pool, this will default to RDP.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"desktop_session_settings":{"$ref":"#/components/schemas/DesktopSessionSettings"},"disk_type":{"type":"string","description":"Disk type of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* FULL_CLONE: The Desktop Pool uses full clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.","example":"FULL_CLONE","enum":["FULL_CLONE","LINKED_CLONE"]},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_entitlement_name":{"type":"string","description":"Total Number of Application Sessions on the Desktop.\n"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"num_machines":{"type":"integer","description":"Number of machines associated with the desktop","format":"int32","example":2},"num_sessions":{"type":"integer","description":"Total Number of Sessions on the Desktop.\n","format":"int32"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool.","example":false},"persistence":{"type":"string","description":"Persistence of the Desktop Pool.\n* PERSISTENCE: Persistence\n* NON_PERSISTENCE: Non persistense","example":"Persistent","enum":["PERSISTENCE","NON_PERSISTENCE"]},"power_policy":{"type":"string","description":"Power policy for the machines in the desktop pool after logoff. This setting is only relevant for managed machines.Default value is TAKE_NO_POWER_ACTION.\nThis property can be used for sorting.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\n* SCHEDULED: Desktops power operations are scheduled.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION","SCHEDULED"]},"power_schedules":{"type":"array","description":"The Schedules for the machines. This can only be set when the power_policy is set to SCHEDULED","items":{"$ref":"#/components/schemas/PowerSchedule"}},"provisioning_settings":{"$ref":"#/components/schemas/ProvisioningSettings"},"provisioning_status_data":{"$ref":"#/components/schemas/ProvisioningStatusDataV2"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect."},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.","example":"PRISM"},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"uem_server_id":{"type":"string","description":"UEM Server Id.\nSupported Filters: Equals.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"uem_server_label":{"type":"string","description":"UEM Server Label.\nSupported Filters: Equals, StartsWithFilter and ContainsFilter.","example":"uem-server-1"},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","description":"Count of user or group entitlements present for the desktop pool.\nThis property can be used for sorting.","format":"int32","example":1}},"description":"Information required to desktop pool."},"CPDesktopPoolInfoV3":{"required":["customization_settings"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true.\nThis property can be used for sorting.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nSupported Filters: Equals.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"application_count":{"type":"integer","description":"Number of applications associated with the desktop","format":"int32","example":2},"assignment_method":{"type":"string","description":"Applicable To: Dedicated desktop pools<br>Assignment method of the machine. \n* AUTOMATIC: Automatic assignment of a user the first time they access the machine.\n* MANUAL: Manual assignment of a user to the machine\n* MULTI_USER: Multiple users assignment to the machine","example":"Persistent","enum":["AUTOMATIC","MANUAL","MULTI_USER"]},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider. Supported Filters: 'Equals'.","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"capacity_provider_name":{"type":"string","description":"Name of the Capacity Provider that manages the machines of the desktop pool.","example":"prism.example"},"capacity_provider_resource_settings":{"$ref":"#/components/schemas/CapacityProviderResourceSettingsV2"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services. This can be false only when cloud_assigned is false.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server."}},"customization_settings":{"$ref":"#/components/schemas/CustomizationSettingsV2"},"default_display_protocol":{"type":"string","description":"The default display protocol for the desktop pool. For a managed desktop pool, this will default to PCOIP.For an unmanaged desktop pool, this will default to RDP.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"desktop_session_settings":{"$ref":"#/components/schemas/DesktopSessionSettings"},"disk_type":{"type":"string","description":"Disk type of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* FULL_CLONE: The Desktop Pool uses full clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.","example":"FULL_CLONE","enum":["FULL_CLONE","LINKED_CLONE"]},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled for desktop pool","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_entitlement_name":{"type":"string","description":"Total Number of Application Sessions on the Desktop.\n"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"num_machines":{"type":"integer","description":"Number of machines associated with the desktop","format":"int32","example":2},"num_sessions":{"type":"integer","description":"Total Number of Sessions on the Desktop.\n","format":"int32"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool.","example":false},"persistence":{"type":"string","description":"Persistence of the Desktop Pool.\n* PERSISTENCE: Persistence\n* NON_PERSISTENCE: Non persistense","example":"Persistent","enum":["PERSISTENCE","NON_PERSISTENCE"]},"power_policy":{"type":"string","description":"Power policy for the machines in the desktop pool after logoff. This setting is only relevant for managed machines.Default value is TAKE_NO_POWER_ACTION.\nThis property can be used for sorting.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\n* SCHEDULED: Desktops power operations are scheduled.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION","SCHEDULED"]},"power_schedules":{"type":"array","description":"The Schedules for the machines. This can only be set when the power_policy is set to SCHEDULED","items":{"$ref":"#/components/schemas/PowerSchedule"}},"provisioning_settings":{"$ref":"#/components/schemas/ProvisioningSettings"},"provisioning_status_data":{"$ref":"#/components/schemas/ProvisioningStatusDataV2"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect."},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.","example":"PRISM"},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"uem_server_id":{"type":"string","description":"UEM Server Id.\nSupported Filters: Equals.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"uem_server_label":{"type":"string","description":"UEM Server Label.\nSupported Filters: Equals, StartsWithFilter and ContainsFilter.","example":"uem-server-1"},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","description":"Count of user or group entitlements present for the desktop pool.\nThis property can be used for sorting.","format":"int32","example":1}},"description":"Information related to desktop pool."},"CPDesktopPoolPushImageSpec":{"required":["logoff_policy"],"type":"object","properties":{"capacity_provider_resource_settings":{"$ref":"#/components/schemas/DesktopCapacityProviderResourceSettingsPushImageSpec"},"customization_settings":{"$ref":"#/components/schemas/DesktopCustomizationSettingsPushImageSpec"},"logoff_policy":{"type":"string","description":"Determines when to perform the operation on machines which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"WAIT_FOR_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"machine_ids":{"uniqueItems":true,"type":"array","description":"Set of machines from the desktop pool on which the new image is to be applied. This can be set when selective_push_image is set to true.","example":["816d44cb-b486-3c97-adcb-cf3806d53657","414927f3-1a3b-3e4c-81b3-d39602f634dc"],"items":{"type":"string","description":"Set of machines from the desktop pool on which the new image is to be applied. This can be set when selective_push_image is set to true.","example":"[\"816d44cb-b486-3c97-adcb-cf3806d53657\",\"414927f3-1a3b-3e4c-81b3-d39602f634dc\"]"}},"selective_push_image":{"type":"boolean","description":"Indicates whether selective push image is to be applied. If set to true, the new image will be applied to specified machine_ids in the desktop pool. The image published with this option will be held as a pending image, unless it is promoted or cancelled. The default value is false.","example":true},"start_time":{"type":"integer","description":"When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time.","format":"int64","example":1587081283000},"stop_on_first_error":{"type":"boolean","description":"Indicates that the operation should stop on first error. Default: true","example":true}},"description":"Specification for the push image operation."},"CPDesktopPoolUpdateSpec":{"required":["persistence"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true. This should be false for the AWS-CORE desktop pools.","example":true},"assignment_method":{"type":"string","description":"Applicable To: Dedicated desktop pools<br>Assignment method of the machine. \n* AUTOMATIC: Automatic assignment of a user the first time they access the machine.\n* MANUAL: Manual assignment of a user to the machine\n* MULTI_USER: Multiple users assignment to the machine","example":"AUTOMATIC","enum":["AUTOMATIC","MANUAL","MULTI_USER"]},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.This property will not be set if the desktop pool does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopCustomizationSettingsUpdateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"desktop_session_settings":{"$ref":"#/components/schemas/DesktopSessionSettingsUpdateSpec"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool. Default value is false.","example":false},"persistence":{"type":"string","description":"Persistence of the Desktop Pool.\n* PERSISTENCE: Persistence\n* NON_PERSISTENCE: Non persistense","example":"Persistent","enum":["PERSISTENCE","NON_PERSISTENCE"]},"power_policy":{"type":"string","description":"Applicable to managed machines with default value as ALWAYS_POWERED_ON. Power policy for the machines in the desktop pool.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\n* SCHEDULED: Desktops power operations are scheduled.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION","SCHEDULED"]},"provisioning_settings":{"$ref":"#/components/schemas/DesktopProvisioningSettingsUpdateSpec"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}}},"description":"Desktop Pool object to be updated."},"CPDesktopPoolUpdateSpecV2":{"required":["cloud_assigned","cloud_managed","persistence"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Indicates whether multiple sessions are allowed per user for this pool. This is required for RDS desktop pool. For other desktop pools, allow_multiple_sessions_per_user in session_settings will be applicable.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true. This should be false for the AWS-CORE desktop pools.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nDefault value - BOTH.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"assignment_method":{"type":"string","description":"Applicable To: Dedicated desktop pools<br>Assignment method of the machine. \n* AUTOMATIC: Automatic assignment of a user the first time they access the machine.\n* MANUAL: Manual assignment of a user to the machine\n* MULTI_USER: Multiple users assignment to the machine","example":"AUTOMATIC","enum":["AUTOMATIC","MANUAL","MULTI_USER"]},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.This property will not be set if the desktop pool does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop pool is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is true.This can be changed to false only if there are no entitlements.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop pool is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>This cannot be set to true, if any of the conditions are satisfied:<br>1. user is provided.<br>2. enabled is false.<br>3. session_type is not DESKTOP.<br>4. global_entitlement is set.<br>5. user_assignment is DEDICATED.<br>6. automatic_user_assignment is false.<br>7. Local entitlements are configured.<br>8. Any of the machines in the pool have users assigned.<br>9. cs_restriction_tags is not set.<br>10. type is MANUAL.<br>","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopCustomizationSettingsUpdateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"desktop_session_settings":{"$ref":"#/components/schemas/DesktopSessionSettingsUpdateSpec"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool. Default value is false.","example":false},"persistence":{"type":"string","description":"Persistence of the Desktop Pool.\n* PERSISTENCE: Persistence\n* NON_PERSISTENCE: Non persistense","example":"Persistent","enum":["PERSISTENCE","NON_PERSISTENCE"]},"power_policy":{"type":"string","description":"Applicable to managed machines with default value as ALWAYS_POWERED_ON. Power policy for the machines in the desktop pool.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\n* SCHEDULED: Desktops power operations are scheduled.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION","SCHEDULED"]},"provisioning_settings":{"$ref":"#/components/schemas/DesktopProvisioningSettingsUpdateSpec"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect.\nDefault value - false."},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"uem_server_id":{"type":"string","description":"UEM Server Id.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"}},"description":"Desktop Pool object to be updated."},"CPDesktopPoolUpdateSpecV3":{"required":["cloud_assigned","cloud_managed","persistence"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Indicates whether multiple sessions are allowed per user for this pool. This is required for RDS desktop pool. For other desktop pools, allow_multiple_sessions_per_user in session_settings will be applicable.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true. This should be false for the AWS-CORE desktop pools.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nDefault value - BOTH.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"assignment_method":{"type":"string","description":"Applicable To: Dedicated desktop pools<br>Assignment method of the machine. \n* AUTOMATIC: Automatic assignment of a user the first time they access the machine.\n* MANUAL: Manual assignment of a user to the machine\n* MULTI_USER: Multiple users assignment to the machine","example":"AUTOMATIC","enum":["AUTOMATIC","MANUAL","MULTI_USER"]},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.This property will not be set if the desktop pool does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop pool is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is true.This can be changed to false only if there are no entitlements.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop pool is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>This cannot be set to true, if any of the conditions are satisfied:<br>1. user is provided.<br>2. enabled is false.<br>3. session_type is not DESKTOP.<br>4. global_entitlement is set.<br>5. user_assignment is DEDICATED.<br>6. automatic_user_assignment is false.<br>7. Local entitlements are configured.<br>8. Any of the machines in the pool have users assigned.<br>9. cs_restriction_tags is not set.<br>10. type is MANUAL.<br>","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopCustomizationSettingsUpdateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"desktop_session_settings":{"$ref":"#/components/schemas/DesktopSessionSettingsUpdateSpec"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled for desktop pool","example":true},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool. Default value is false.","example":false},"persistence":{"type":"string","description":"Persistence of the Desktop Pool.\n* PERSISTENCE: Persistence\n* NON_PERSISTENCE: Non persistense","example":"Persistent","enum":["PERSISTENCE","NON_PERSISTENCE"]},"power_policy":{"type":"string","description":"Applicable to managed machines with default value as ALWAYS_POWERED_ON. Power policy for the machines in the desktop pool.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\n* SCHEDULED: Desktops power operations are scheduled.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION","SCHEDULED"]},"provisioning_settings":{"$ref":"#/components/schemas/DesktopProvisioningSettingsUpdateSpec"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect.\nDefault value - false."},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"uem_server_id":{"type":"string","description":"UEM Server Id.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"}},"description":"Desktop Pool object to be updated."},"CPFarmAutomatedSettingsCreateSpec":{"required":["capacity_provider_id","customization_settings","provisioning_settings"],"type":"object","properties":{"capacity_provider_id":{"type":"string","description":"ID of the capacity provider","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"capacity_provider_resource_settings":{"$ref":"#/components/schemas/CPFarmCapacityProviderResourceSettingsCreateSpec"},"customization_settings":{"$ref":"#/components/schemas/CPFarmCustomizationSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/CPFarmProvisioningSettingsCreateSpec"}},"description":"Settings for Automated farm. This is required if type is set to AUTOMATED."},"CPFarmAutomatedSettingsUpdateSpec":{"required":["customization_settings","provisioning_settings"],"type":"object","properties":{"customization_settings":{"$ref":"#/components/schemas/CPFarmCustomizationSettingsUpdateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/CPFarmProvisioningSettingsUpdateSpec"}},"description":"Settings for Automated farm. This is required if type is set to AUTOMATED."},"CPFarmCapacityProviderResourceSettings":{"type":"object","properties":{"datacenter_id":{"type":"string","description":"ID of the datacenter","example":"datacenter-1"},"datacenter_identifier":{"type":"string","description":"Datacenter identifier/name","example":"datacenter-name"},"datastore":{"type":"array","description":"List of datastore used to store the RDS Servers","items":{"type":"string","description":"List of datastore used to store the RDS Servers"}},"directory_id":{"type":"string","description":"Indicates AWS core directory ID","example":"d-94673ede63"},"directory_name":{"type":"string","description":"Name of the AWS core directory","example":"hznonaws.com"},"folder_id":{"type":"string","description":"Folder to deploy the RDS Server","example":"group-1"},"folder_identifier":{"type":"string","description":"Folder identifier, can be name or path","example":"folder-1"},"im_stream_id":{"type":"string","description":"Image management stream used in the farm.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_stream_name":{"type":"string","description":"Name of the image management stream used in the farm","example":"stream-name"},"im_tag_id":{"type":"string","description":"Image management tag used in the farm.<br>Supported Filters: 'Equals'.","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_name":{"type":"string","description":"Name of the image management tag","example":"tag-name"},"image_id":{"type":"string","description":"Golden image id","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_identifier":{"type":"string","description":"Golden image identifier","example":"vm-name"},"image_snapshot_id":{"type":"string","description":"Golden image snapshot id","example":"df45b3a5-e7d0-5ad6-a1e6-79328dd1hg51"},"image_snapshot_identifier":{"type":"string","description":"Golden image snapshot identifier","example":"snapshot-1"},"image_source_id":{"type":"string","description":"ID of the source image that is associated with this golden image","example":"wsi-7b1ymfqqk"},"image_source_identifier":{"type":"string","description":"Identifier of the source image that is associated with this golden image id","example":"hzn-image"},"networks":{"type":"array","description":"Network settings","items":{"$ref":"#/components/schemas/NetworkSettings"}},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks for RDS server. This is set when use_separate_datastores_replica_and_os_disks is true"},"resource_group_id":{"type":"string","description":"ID of the resource group","example":"res-23"},"resource_group_identifier":{"type":"string","description":"Resource group identifier","example":"res-name"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the RDS Servers","example":"645b3a5-e7d0-8ad6-a1e3-98168dd1ed51"},"resource_pool_identifier":{"type":"string","description":"Resource pool identifier","example":"e545f3a5-e7d0-5ad6-a1e6-98168dd1ed51"},"running_mode":{"type":"string","description":"Running mode for the RDS servers in the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALWAYS_ON: Billed monthly. Instant access to an always running WorkSpace.","example":"ALWAYS_ON","enum":["ALWAYS_ON"]},"use_parent_image_network":{"type":"boolean","description":"Indicates whether to use parent network or different network","example":false},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Indicates whether to use separate datastores for replica and OS disks","example":false},"use_view_storage_accelerator":{"type":"boolean","description":"Indicates whether to use view storage accelerator","example":false}},"description":"Capacity provider resource settings"},"CPFarmCapacityProviderResourceSettingsCreateSpec":{"type":"object","properties":{"clone_datastore_id":{"type":"string","description":"Datastore to store the machines","example":"datastore-1"},"clone_disk_datastore_policy_id":{"type":"string","description":"Datastore to store policy id for the clone disks.","example":"policy-1"},"enable_cbrc":{"type":"boolean","description":"Indicates whether to use CBRC. <br> Default value is false.","example":false},"folder_id":{"type":"string","description":"Folder where the machines are deployed to.","example":"group-v1"},"image_id":{"type":"string","description":"This property can be set only when type is set to AUTOMATED.","example":"0a950b74-5175-4a4a-b73e-bb323562ba34"},"image_snapshot_id":{"type":"string","description":"This property can be set only when type is set to AUTOMATED.","example":"80ba9ed8-f8b7-43c8-ae3c-4c14bc5b230e"},"network_attributes":{"type":"array","description":"Network settings for the automated farm","example":[{"networkId":"c9896e51-48a2-4d82-ae9e-a0246981b473"},{"networkId":"a1234567-89ab-cdef-0123-456789abcdef"}],"items":{"$ref":"#/components/schemas/CPFarmNetworkSettingsCreateSpec"}},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks. <br> This property is required if use_separate_datastores_replica_and_os_disks is set to true. <br>","example":"datastore-1"},"replica_disk_datastore_policy_id":{"type":"string","description":"Datastore to store policy id foe the replicate disks. <br> This property is required if use_separate_datastores_replica_and_os_disks is set to true. <br>","example":"policy-2"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the machines.","example":"resgroup-1"},"use_parent_image_network":{"type":"boolean","description":"Applicable To: Automated farm with default value as false.<br>Indicates whether to use parent network or different network","example":false},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Indicates whether to use separate datastores for replica and OS disks. <br> Default value is false.","example":false}},"description":"Applicable To: Automated farm. <br>Capacity provider resource settings for Automated farm."},"CPFarmCapacityProviderResourceSettingsMaintenanceSpec":{"type":"object","properties":{"folder_id":{"type":"string","description":"Folder where the machines are deployed to.","example":"group-v1"},"image_id":{"type":"string","description":"This property can be set only when type is set to AUTOMATED.","example":"0a950b74-5175-4a4a-b73e-bb323562ba34"},"image_snapshot_id":{"type":"string","description":"This property can be set only when type is set to AUTOMATED.","example":"80ba9ed8-f8b7-43c8-ae3c-4c14bc5b230e"},"network_attributes":{"type":"array","description":"Indicates the network attributes like network_id, cidr. ","example":"network_id:c9896e51-48a2-4d82-ae9e-a0246981b473 cidr:10.212.10.12\u0014","items":{"$ref":"#/components/schemas/CPFarmNetworkSettingsMaintenanceSpec"}},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the machines.","example":"resgroup-1"},"use_parent_image_network":{"type":"boolean","description":"Applicable To: Automated farm with default value as false.<br>Indicates whether to use parent network or different network","example":false}},"description":"Applicable To: Automated farm. <br>Capacity provider resource settings for Automated farm."},"CPFarmCreateSpec":{"required":["access_group_id","disk_type","max_session_type","name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/CPFarmAutomatedSettingsCreateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"disk_type":{"type":"string","description":"Disk type of the Farm Pool.\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Desktop Pool or Farm uses linked clone technology for provisioning the machines or RDS hosts. Applicable for AUTOMATED type desktop pools or Farms.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE"]},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm. If the display name is left blank, it defaults to name.","example":"ManualFarm"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering. Default value is true.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/CPFarmRDSHLoadBalancerSettingsCreateSpec"},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the farm. This property must contain only alphanumerics, underscores, and dashes.","example":"ManualFarm"},"rds_server_ids":{"uniqueItems":true,"type":"array","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":["5134796a-322g-5fe5-343f-4daa5d25ebfe","2a43f96c-102b-4ed3-953f-35deg43d43b0ge"],"items":{"type":"string","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":"[\"5134796a-322g-5fe5-343f-4daa5d25ebfe\",\"2a43f96c-102b-4ed3-953f-35deg43d43b0ge\"]"}},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. Default value is 0.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/CPFarmSessionSettingsCreateSpec"},"type":{"type":"string","description":"Type of the farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. Default value is false.","example":false}},"description":"Farm object to be created."},"CPFarmCreateSpecV2":{"required":["access_group_id","disk_type","entra_sso_enabled","max_session_type","name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/CPFarmAutomatedSettingsCreateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"disk_type":{"type":"string","description":"Disk type of the Farm Pool.\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Desktop Pool or Farm uses linked clone technology for provisioning the machines or RDS hosts. Applicable for AUTOMATED type desktop pools or Farms.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE"]},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm. If the display name is left blank, it defaults to name.","example":"ManualFarm"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering. Default value is true.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled for the farm","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/CPFarmRDSHLoadBalancerSettingsCreateSpec"},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the farm. This property must contain only alphanumerics, underscores, and dashes.","example":"ManualFarm"},"rds_server_ids":{"uniqueItems":true,"type":"array","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":["5134796a-322g-5fe5-343f-4daa5d25ebfe","2a43f96c-102b-4ed3-953f-35deg43d43b0ge"],"items":{"type":"string","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":"[\"5134796a-322g-5fe5-343f-4daa5d25ebfe\",\"2a43f96c-102b-4ed3-953f-35deg43d43b0ge\"]"}},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. Default value is 0.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/CPFarmSessionSettingsCreateSpec"},"type":{"type":"string","description":"Type of the farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. Default value is false.","example":false}},"description":"Farm object to be created."},"CPFarmCustomizationSettings":{"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Instant Clone Engine Active Directory container for clone prep.\nThis property can be used for sorting.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Automated farms. <br>The AD Site, associated with the Domain Administrator, which will be used for automated farm provisioning.","example":"Default-First-Site-Name"},"compute_profile_id":{"type":"string","description":"Indicates the compute profile.<br>Supported Filters: 'Equals'.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"compute_profile_name":{"type":"string","description":"Indicates the name of compute profile","example":"computeProfile-name"},"customization_spec_name":{"type":"string","description":"Customization specification name. This will be set if customization_type is set to SYS_PREP ","example":"Custom-Spec"},"customization_type":{"type":"string","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script.\n* CLONE_PREP: Applicable To: Instant clone automated Farms.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.","example":"CLONE_PREP","enum":["SYS_PREP","CLONE_PREP"]},"domain_account_id":{"type":"string","description":"Administrator which will add the machines to its domain","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"domain_name":{"type":"string","description":"Indicates the name of the domain","example":"hze.com"},"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"},"priming_computer_account":{"type":"string","description":"Publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.","example":"primingComputerAccount-1"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names.\nThis property can be used for sorting.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"Customization specification used when Sysprep customization is requested. This will be set if customization_type is set to SYS_PREP ","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Customization settings for the automated farm"},"CPFarmCustomizationSettingsCreateSpec":{"required":["ad_container_rdn","customization_type","domain_account_id"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Full clone farms.<br>This is required for full clone farms. <br>Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Automated farms.<br>Name of the AD Site.","example":"Default-First-Site-Name"},"compute_profile_id":{"type":"string","description":"Compute profile to used.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"customization_type":{"type":"string","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script.\n* CLONE_PREP: Applicable To: Instant clone automated Farms.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.","example":"SYS_PREP","enum":["SYS_PREP","CLONE_PREP"]},"domain_account_id":{"type":"string","description":"Applicable To :Automated farms.<br> This is required for automated farms.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on  machines before they are powered off. Provide the path to the script on the parent machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"},"priming_computer_account":{"type":"string","description":"Publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.","example":"primingComputerAccount-1"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. Default value is false.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Customization settings for the automated farm."},"CPFarmCustomizationSettingsMaintenanceSpec":{"required":["ad_container_rdn","customization_type","domain_account_id"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Full clone farms.<br>This is required for full clone farms. <br>Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Automated farms.<br>Name of the AD Site.","example":"Default-First-Site-Name"},"compute_profile_id":{"type":"string","description":"Compute profile to used.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"customization_type":{"type":"string","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script.\n* CLONE_PREP: Applicable To: Instant clone automated Farms.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.","example":"SYS_PREP","enum":["SYS_PREP","CLONE_PREP"]},"domain_account_id":{"type":"string","description":"Applicable To :Automated farms.<br> This is required for automated farms.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"priming_computer_account":{"type":"string","description":"Publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.","example":"primingComputerAccount-1"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. Default value is false.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Customization settings for the automated farm."},"CPFarmCustomizationSettingsUpdateSpec":{"required":["ad_container_rdn","customization_type","domain_account_id","reuse_pre_existing_accounts"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Full clone farms.<br>This is required for full clone farms. <br>Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Automated farms.<br>Name of the AD Site.","example":"Default-First-Site-Name"},"compute_profile_id":{"type":"string","description":"Compute profile to used.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"customization_type":{"type":"string","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script.\n* CLONE_PREP: Applicable To: Instant clone automated Farms.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.","example":"SYS_PREP","enum":["SYS_PREP","CLONE_PREP"]},"domain_account_id":{"type":"string","description":"Applicable To :Automated farms.<br> This is required for automated farms.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on  machines before they are powered off. Provide the path to the script on the parent machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Customization settings for the automated farm."},"CPFarmInfo":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"access_group_name":{"type":"string","description":"Name of the access group","example":"access-group"},"additional_details":{"type":"object","additionalProperties":{"type":"object","description":"Additional details of the farm"},"description":"Additional details of the farm"},"app_volumes_manager_guid":{"type":"string","description":"Associated app volumes manager id for the farm","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"application_count":{"type":"integer","description":"Count of Applications that belong to the Farm","format":"int32","example":10},"automated_farm_settings":{"$ref":"#/components/schemas/CPAutomatedFarmSettings"},"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the Farm was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"delete_in_progress":{"type":"boolean","description":"Indicates whether the farm is in the process of being deleted.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the farm. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Farm Description"},"desktop_pool_id":{"type":"string","description":"ID of RDS desktop pool associated with the farm.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_name":{"type":"string","description":"RDS Desktop display name","example":"test"},"disk_type":{"type":"string","description":"Disk type of the farm\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Desktop Pool or Farm uses linked clone technology for provisioning the machines or RDS hosts. Applicable for AUTOMATED type desktop pools or Farms.","example":"LINKED_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE"]},"display_name":{"type":"string","description":"Display name of the farm. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing farm. <br>Supported Filters: 'Equals'.","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4"},"load_balancer_settings":{"$ref":"#/components/schemas/CPRDSHLoadBalancerSettings"},"max_number_of_rds_servers":{"type":"integer","description":"Maximum number of RDS Servers in the farm.\nThis property can be used for sorting.","format":"int32","example":5},"max_session_type":{"type":"string","description":"RDS Server type for max sessions\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"UNLIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","description":"Maximum number of sessions allowed for Farm. This is set when max_session_type is LIMITED.","format":"int32","example":50},"max_sessions_per_rds_server":{"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.","format":"int32","example":50},"name":{"type":"string","description":"Name of the farm. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"num_rds_servers":{"type":"integer","description":"Number of RDS servers in the farm.\nThis property can be used for sorting.","format":"int32","example":10},"server_error_threshold":{"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. \nThis property can be used for sorting.","format":"int32","example":0},"session_collaboration_enabled":{"type":"boolean","description":"Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users.\nThis property can be used for sorting.","example":false},"session_settings":{"$ref":"#/components/schemas/CPFarmSessionSettings"},"source":{"type":"string","description":"Source of the machine in this farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* AWS_CORE: The Farm uses AWS core as source for provisioning the machines.\n* PRISM: The Farm uses capacity provider as source for provisioning the RDS servers.","example":"PRISM","enum":["INSTANT_CLONE","LINKED_CLONE","AWS_CORE","PRISM"]},"type":{"type":"string","description":"Type of the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL"]},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the Farm was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not.\nThis property can be used for sorting.","example":false}},"description":"Information related to Farm.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"CPFarmInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"access_group_name":{"type":"string","description":"Name of the access group","example":"access-group"},"additional_details":{"type":"object","additionalProperties":{"type":"object","description":"Additional details of the farm"},"description":"Additional details of the farm"},"app_volumes_manager_guid":{"type":"string","description":"Associated app volumes manager id for the farm","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"application_count":{"type":"integer","description":"Count of Applications that belong to the Farm","format":"int32","example":10},"automated_farm_settings":{"$ref":"#/components/schemas/CPAutomatedFarmSettings"},"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the Farm was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"delete_in_progress":{"type":"boolean","description":"Indicates whether the farm is in the process of being deleted.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the farm. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Farm Description"},"desktop_pool_id":{"type":"string","description":"ID of RDS desktop pool associated with the farm.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_name":{"type":"string","description":"RDS Desktop display name","example":"test"},"disk_type":{"type":"string","description":"Disk type of the farm\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Desktop Pool or Farm uses linked clone technology for provisioning the machines or RDS hosts. Applicable for AUTOMATED type desktop pools or Farms.","example":"LINKED_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE"]},"display_name":{"type":"string","description":"Display name of the farm. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled for the farm","example":true},"id":{"type":"string","description":"Unique ID representing farm. <br>Supported Filters: 'Equals'.","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4"},"load_balancer_settings":{"$ref":"#/components/schemas/CPRDSHLoadBalancerSettings"},"max_number_of_rds_servers":{"type":"integer","description":"Maximum number of RDS Servers in the farm.\nThis property can be used for sorting.","format":"int32","example":5},"max_session_type":{"type":"string","description":"RDS Server type for max sessions\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"UNLIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","description":"Maximum number of sessions allowed for Farm. This is set when max_session_type is LIMITED.","format":"int32","example":50},"max_sessions_per_rds_server":{"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.","format":"int32","example":50},"name":{"type":"string","description":"Name of the farm. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"num_rds_servers":{"type":"integer","description":"Number of RDS servers in the farm.\nThis property can be used for sorting.","format":"int32","example":10},"server_error_threshold":{"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. \nThis property can be used for sorting.","format":"int32","example":0},"session_collaboration_enabled":{"type":"boolean","description":"Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users.\nThis property can be used for sorting.","example":false},"session_settings":{"$ref":"#/components/schemas/CPFarmSessionSettings"},"source":{"type":"string","description":"Source of the machine in this farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* AWS_CORE: The Farm uses AWS core as source for provisioning the machines.\n* PRISM: The Farm uses capacity provider as source for provisioning the RDS servers.","example":"PRISM","enum":["INSTANT_CLONE","LINKED_CLONE","AWS_CORE","PRISM"]},"type":{"type":"string","description":"Type of the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL"]},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the Farm was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not.\nThis property can be used for sorting.","example":false}},"description":"Information related to Farm.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"CPFarmMaintenanceSpec":{"required":["logoff_policy","maintenance_mode"],"type":"object","properties":{"capacity_provider_resource_settings":{"$ref":"#/components/schemas/CPFarmCapacityProviderResourceSettingsMaintenanceSpec"},"customization_settings":{"$ref":"#/components/schemas/CPFarmCustomizationSettingsMaintenanceSpec"},"logoff_policy":{"type":"string","description":"Determines when to perform the operation on machines which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"WAIT_FOR_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"maintenance_mode":{"type":"string","description":"The mode of schedule maintenance for Instant Clone Farm.\n* IMMEDIATE: All server VMs will be refreshed once, immediately or at user scheduled time.\n* RECURRING: All server VMs will be periodically refreshed based on FarmInstantCloneRecurringMaintenancePeriod and StartTime","example":"IMMEDIATE","enum":["IMMEDIATE","RECURRING"]},"next_scheduled_time":{"type":"integer","description":"Time when next scheduled maintenance would happen. If maintenance_mode is set to IMMEDIATE and next_scheduled_time is not set, maintenance will begin immediately. If maintenance_mode is set to RECURRING and next_scheduled_time is not set, it will be calculated based on current recurring maintenance configuration. If the value is in the past, maintenance will begin immediately. Measured as epoch time.","format":"int64","example":1237081283000},"rds_server_ids":{"uniqueItems":true,"type":"array","description":"Set of RDS servers from the farm on which the new image is to be applied. This can be set when selective_schedule_maintenance is set to true.","example":["816d44cb-b486-3c97-adcb-cf3806d53657","414927f3-1a3b-3e4c-81b3-d39602f634dc"],"items":{"type":"string","description":"Set of RDS servers from the farm on which the new image is to be applied. This can be set when selective_schedule_maintenance is set to true.","example":"[\"816d44cb-b486-3c97-adcb-cf3806d53657\",\"414927f3-1a3b-3e4c-81b3-d39602f634dc\"]"}},"recurring_maintenance_settings":{"$ref":"#/components/schemas/CPFarmRecurringMaintenanceSettingsSpec"},"selective_schedule_maintenance":{"type":"boolean","description":"Indicates whether selective scheduled maintenance is to be applied. If set to true, the new image will be applied to specified rds_server_ids in the farm. The image published with this option will be held as a pending image, unless it is promoted or cancelled. The default value is false.","example":true},"stop_on_first_error":{"type":"boolean","description":"Indicates that the operation should stop on first error. Default: true","example":true}},"description":"The specification to schedule maintenance."},"CPFarmNetworkSettingsCreateSpec":{"type":"object","properties":{"network_id":{"type":"string","description":"NetworkId of the network","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"}},"description":"Network settings for the automated farm","example":[{"networkId":"c9896e51-48a2-4d82-ae9e-a0246981b473"},{"networkId":"a1234567-89ab-cdef-0123-456789abcdef"}]},"CPFarmNetworkSettingsMaintenanceSpec":{"type":"object","properties":{"network_id":{"type":"string","description":"NetworkId of the network","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"}},"description":"Network settings for the automated farm","example":"network_id:c9896e51-48a2-4d82-ae9e-a0246981b473 cidr:10.212.10.12\u0014"},"CPFarmProvisioningSettings":{"type":"object","properties":{"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"min_ready_vms":{"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for maintenance operations for the automated farm.\nThis property can be used for sorting.","format":"int32","example":0},"naming_method":{"type":"string","description":"Applicable To: Automated desktop pool.<br>Naming method for the desktop pool. This is required for Automated desktop pools.\nThis property can be used for sorting.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"PATTERN","enum":["SPECIFIED","PATTERN"]},"pattern_naming_settings":{"$ref":"#/components/schemas/CPFarmRDSServerPatternNamingSettings"},"specified_naming_settings":{"$ref":"#/components/schemas/CPFarmSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error.\nThis property can be used for sorting.","example":true}},"description":"Provisioning settings for the automated farm"},"CPFarmProvisioningSettingsCreateSpec":{"type":"object","properties":{"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately. Default value is true.","example":true},"naming_method":{"type":"string","description":"Specifies the naming scheme for the RDS Servers in the automated farm.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"PATTERN","enum":["SPECIFIED","PATTERN"]},"pattern_naming_settings":{"$ref":"#/components/schemas/CPFarmRDSServersPatternNamingSettingsCreateSpec"},"specified_naming_settings":{"$ref":"#/components/schemas/CPFarmRDSServersSpecificNamingSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error. Default value is true.","example":true}},"description":"Applicable To: Automated farm. <br>Capacity provider provisioning settings for Automated farm."},"CPFarmProvisioningSettingsUpdateSpec":{"required":["enable_provisioning","stop_provisioning_on_error"],"type":"object","properties":{"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately.","example":true},"pattern_naming_settings":{"$ref":"#/components/schemas/CPFarmRDSServersPatternNamingSettingsUpdateSpec"},"specified_naming_settings":{"$ref":"#/components/schemas/CPFarmRDSServersSpecificNamingSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error. ","example":true}},"description":"Applicable To: Automated farm. <br>Capacity provider provisioning settings for Automated farm."},"CPFarmProvisioningStatusData":{"type":"object","properties":{"additional_settings":{"type":"object","additionalProperties":{"type":"object","description":"Additional settings of provisioning status data, like pending compute profile settings"},"description":"Additional settings of provisioning status data, like pending compute profile settings"},"last_provisioning_error":{"type":"string","description":"Error message detailing the last provisioning error on this farm while stop_provisioning_on_error is enabled","example":"Initial publish failed"},"last_provisioning_error_time":{"type":"integer","description":"Time the last provisioning error occurred on this farm while stop_provisioning_on_error is enabled. Measured as epoch time.","format":"int64","example":1587081283000},"operation":{"type":"string","description":"The operation that farm is undergoing\n* NONE: There is no current operation on the farm.\n* INITIAL_PUBLISH: The farm has just been created and is undergoing initial publishing.\n* RECURRING_SCHEDULED_MAINTENANCE: Recurring maintenance operation is scheduled on the farm.\n* SCHEDULED_MAINTENANCE: Maintenance operation is scheduled on the farm.\n* CANCEL_SCHEDULED_MAINTENANCE: The recurring maintenance operation on the farm is being cancelled.\n* INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the farm.\n* FINAL_UNPUBLISH: A farm has been deleted and is undergoing final unpublishing.","example":"INITIAL_PUBLISH","enum":["NONE","INITIAL_PUBLISH","RECURRING_SCHEDULED_MAINTENANCE","SCHEDULED_MAINTENANCE","CANCEL_SCHEDULED_MAINTENANCE","INFRASTRUCTURE_CHANGE","FINAL_UNPUBLISH"]},"operation_time":{"type":"integer","description":"Time of the operation. Measured as epoch time","format":"int64","example":1587081283000},"pending_im_stream_id":{"type":"string","description":"Pending image management stream for instant clone farms.<br>Supported Filters: 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"pending_im_tag_id":{"type":"string","description":"Pending image management tag for instant clone farms.<br>Supported Filters: 'Equals'.","example":"e9896e51-48a2-4d82-ae9e-a0246981b484"},"pending_image_error":{"type":"string","description":"Error message if the pending operation is failed","example":"Publish failed"},"pending_image_id":{"type":"string","description":"Pending parent image id the farm is undergoing","example":"e9896e51-48a2-4d82-ae9e-a0246981b484"},"pending_image_identifier":{"type":"string","description":"Golden image identifier","example":"vm-name"},"pending_image_progress":{"type":"integer","description":"This represents the pending image publish progress in percentage for an instant clone farm.\nThis property can be used for sorting.","format":"int32","example":10},"pending_image_snapshot_id":{"type":"string","description":"Pending parent snapshot id the farm is undergoing","example":"e9896e51-48a2-4d82-ae9e-a0246981b484"},"pending_image_snapshot_identifier":{"type":"string","description":"Golden image snapshot identifier","example":"snapshot-1"},"pending_image_state":{"type":"string","description":"This represents the state of the pending image of thisfarms. This will be null when there is no pending image for the farm.\nThis property can be used for sorting.\n* FAILED: This is the state of the pending image if creation of clone operation has failed or timed out.\n* PENDING_PUBLISH: This is the initial transient state of the pending image before clone creation operation has started.\n* PUBLISHING: This is the transient state of the pending image when creation of clone operation is going on.\n* READY: This is the state of the pending image after successful publish of the pending image and before that image has been upgraded to the current image. This is normally seen after successful publish for a push image which has been scheduled to trigger at a later time.\n* READY_HELD: This is the state of the pending image after performing a selective resync operation, in which the image may be applied to some VMs in the desktop pool/farm.\n* UNPUBLISHING: This is the transient state of the pending image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"FAILED","enum":["FAILED","PENDING_PUBLISH","PUBLISHING","READY","READY_HELD","UNPUBLISHING"]},"schedule_maintenance_settings":{"$ref":"#/components/schemas/ScheduleMaintenanceSettings"}},"description":"Provisioning status data for the automated farm"},"CPFarmRDSHLoadBalancerSettingsCreateSpec":{"type":"object","properties":{"connecting_session_threshold":{"maximum":150,"minimum":0,"type":"integer","description":"Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions. By default, this threshold is disabled and does not deny session logins. Default value is 0.","format":"int32","example":10},"cpu_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":10},"disk_queue_length_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average number of both read and write requests that were queued for the selected disk during the sample interval. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":15},"disk_read_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":10},"disk_write_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":15},"include_session_count":{"type":"boolean","description":"Indicates whether to include session count for load balancing. Default value is true when use_custom_script_for_load_balancing is false.","example":true},"load_index_lb_enabled":{"type":"boolean","description":"Indicates if load index based load balancing is enabled. Default value is true."},"load_index_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions. By default, this threshold is disabled and does not deny session logins. Default value is 0.","format":"int32","example":20},"memory_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":10}},"description":"RDSH load balancer settings for the farm."},"CPFarmRDSHLoadBalancerSettingsUpdateSpec":{"required":["connecting_session_threshold","cpu_threshold","disk_queue_length_threshold","disk_read_latency_threshold","disk_write_latency_threshold","include_session_count","load_index_lb_enabled","load_index_threshold","memory_threshold"],"type":"object","properties":{"connecting_session_threshold":{"maximum":150,"minimum":0,"type":"integer","description":"Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions.","format":"int32","example":10},"cpu_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10},"disk_queue_length_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average number of both read and write requests that were queued for the selected disk during the sample interval. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":15},"disk_read_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10},"disk_write_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":15},"include_session_count":{"type":"boolean","description":"Indicates whether to include session count for load balancing.","example":true},"load_index_lb_enabled":{"type":"boolean","description":"Indicates if load index based load balancing is enabled.","example":true},"load_index_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions.","format":"int32","example":20},"memory_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10}},"description":"RDSH load balancer settings for the farm."},"CPFarmRDSServerPatternNamingSettings":{"type":"object","properties":{"naming_pattern":{"type":"string","description":"RDS Servers will be named according to the specified naming pattern. By default, Horizon appends a unique number to the specified pattern to provide a unique name for each RDS Server. To place this unique number elsewhere in the pattern, use '{n}'. (For example: rds-{n}-sales.) The unique number can also be made a fixed length. (For example: rds-{n:fixed=3}-sales will name RDS Servers from rds-001-sales to rds-999-sales).\nRDS Server names are constrained to a maximum size of 15 characters including the unique number. Therefore, care must be taken when choosing a pattern. If the maximum farm size is 9 RDS servers, the pattern must be at most 14 characters. For 99 RDS servers, 13 characters, for 999 RDS servers, 12 characters. For 9999 RDS servers, 11 characters. If using a fixed size token, use a maximum of 14 characters for \"n=1\", 13 characters for \"n=2\", 12 characters for \"n=3\", and 11 characters for \"n=4\". If {n} is specified with no size, a size of 2 is automatically used and if no {} is specified, {n=2} is automatically appended to the end of the pattern. If the numeric placement token not present, then maximum length is 14 characters.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":"vm-{n}-sales"}},"description":"RDS server naming pattern settings for the farm"},"CPFarmRDSServersPatternNamingSettingsCreateSpec":{"required":["naming_pattern"],"type":"object","properties":{"max_number_of_rds_servers":{"minimum":1,"type":"integer","description":"Maximum number of RDS Servers in the farm. Default value is 1.","format":"int32","example":5},"min_ready_vms":{"minimum":0,"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm. Default value is 0.","format":"int32","example":0},"naming_pattern":{"type":"string","description":"Machines will be named according to the specified naming pattern.<br> By default, view manager appends a unique number to the specified pattern to provide a unique name for each virtual machine. To place this unique number elsewhere in the pattern, use '{n}'. (For example: vm-{n}-sales.) The unique number can also be made a fixed length. (For example: vm-{n:fixed=3}-sales will name VMs from vm-001-sales to vm-999-sales). <br>Machine names are constrained to a maximum size of 15 characters including the unique number. Therefore, care must be taken when choosing a pattern. If the maximum farm size is 9 machines, the pattern must be at most 14 characters. For 99 machines, 13 characters, for 999 machines, 12 characters. For 9999 machines, 11 characters. If using a fixed size token, use a maximum of 14 characters for \"n=1\", 13 characters for \"n=2\", 12 characters for \"n=3\", and 11 characters for \"n=4\".<br>If {n} is specified with no size, a size of 2 is automatically used and if no {} is specified, {n=2} is automatically appended to the end of the pattern.","example":"vm-{n}-sales"}},"description":"RDS server naming Pattern settings for the farm"},"CPFarmRDSServersPatternNamingSettingsUpdateSpec":{"required":["max_number_of_rds_servers","min_ready_vms","naming_pattern"],"type":"object","properties":{"max_number_of_rds_servers":{"minimum":1,"type":"integer","description":"Maximum number of RDS Servers in the farm.","format":"int32","example":5},"min_ready_vms":{"minimum":0,"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm. ","format":"int32","example":0},"naming_pattern":{"type":"string","description":"Machines will be named according to the specified naming pattern.<br> By default, view manager appends a unique number to the specified pattern to provide a unique name for each virtual machine. To place this unique number elsewhere in the pattern, use '{n}'. (For example: vm-{n}-sales.) The unique number can also be made a fixed length. (For example: vm-{n:fixed=3}-sales will name VMs from vm-001-sales to vm-999-sales). <br>Machine names are constrained to a maximum size of 15 characters including the unique number. Therefore, care must be taken when choosing a pattern. If the maximum desktop size is 9 machines, the pattern must be at most 14 characters. For 99 machines, 13 characters, for 999 machines, 12 characters. For 9999 machines, 11 characters. If using a fixed size token, use a maximum of 14 characters for \"n=1\", 13 characters for \"n=2\", 12 characters for \"n=3\", and 11 characters for \"n=4\".<br>If {n} is specified with no size, a size of 2 is automatically used and if no {} is specified, {n=2} is automatically appended to the end of the pattern.","example":"vm-{n}-sales"}},"description":"RDS server naming Pattern settings for the farm"},"CPFarmRDSServersSpecificNamingSettingsCreateSpec":{"type":"object","properties":{"num_unassigned_machines_kept_powered_on":{"minimum":1,"type":"integer","description":"Number of unassigned machines kept powered on. This property must be lesser than or equal to the number of specified names.<br> Default value is 1.","format":"int32","example":1},"specified_names":{"type":"array","description":"Specified names for the machines.","items":{"$ref":"#/components/schemas/MachineSpecifiedName"}},"start_machines_in_maintenance_mode":{"type":"boolean","description":"Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited manually. <br> Default value is false.","example":false}},"description":"RDS server specific naming settings for the farm"},"CPFarmRDSServersSpecificNamingSettingsUpdateSpec":{"required":["num_unassigned_machines_kept_powered_on"],"type":"object","properties":{"num_unassigned_machines_kept_powered_on":{"minimum":1,"type":"integer","description":"Number of unassigned machines kept powered on. This property must be lesser than or equal to the number of specified names.","format":"int32","example":1},"specified_names":{"type":"array","description":"Specified names for the machines.","items":{"$ref":"#/components/schemas/MachineSpecifiedName"}},"start_machines_in_maintenance_mode":{"type":"boolean","description":"Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited manually.","example":false}},"description":"RDS server specific naming settings for the farm"},"CPFarmRecurringMaintenanceSettingsSpec":{"required":["maintenance_period","start_time"],"type":"object","properties":{"maintenance_period":{"type":"string","description":"This represents the frequency at which to perform recurring maintenance.\n* DAILY: Daily recurring maintenance\n* WEEKLY: Weekly recurring maintenance\n* MONTHLY: Monthly recurring maintenance","example":"MONTHLY","enum":["DAILY","WEEKLY","MONTHLY"]},"maintenance_period_frequency":{"maximum":100,"minimum":1,"type":"integer","description":"Indicates how frequently to repeat maintenance, expressed as multiple of the maintenance period. e.g. Every 2 weeks. Default value is 1.","format":"int32","example":10},"start_index":{"maximum":31,"minimum":1,"type":"integer","description":"Start index for weekly or monthly maintenance.This required if maintenance_period is set to either WEEKLY or MONTHLY. Weekly: 1-7 (Sun-Sat), Monthly: 1-31","format":"int32","example":2},"start_time":{"type":"string","description":"Start time configured for the recurring maintenance. This should be in the form hh:mm in 24 hours format.","example":"10:00"}},"description":"Settings for recurring maintenance operation for the farm. This is Required only if maintenance_mode is set to RECURRING"},"CPFarmSessionSettings":{"type":"object","properties":{"disconnected_session_timeout_minutes":{"type":"integer","description":"Disconnected sessions timeout (in minutes). An empty disconnected session is logged off after the timeout. This is set when the disconnect_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session.\nThis property can be used for sorting.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. This is set when the empty_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy.\nThis property can be used for sorting.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.\nThis property can be used for sorting.","example":false},"pre_launch_session_timeout_minutes":{"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout.This is set when the pre_launch_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Application pre-launch session timeout policy. \nThis property can be used for sorting.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"session_timeout_policy":{"type":"string","description":"Specifies the session timeout policy for the applications published from the Farm. This policy indicates whether the launched application session is a forever application session or not.\nThis property can be used for sorting.\n* DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.\n* NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.","example":"DEFAULT","enum":["DEFAULT","NEVER"]}},"description":"Session settings related to the Farm"},"CPFarmSessionSettingsCreateSpec":{"type":"object","properties":{"disconnected_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Disconnected sessions timeout (in minutes). An empty disconnected session is logged off after the timeout. This is required if the disconnect_session_timeout_policy is set to AFTER.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER. \n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. Default value is 1. This is required if the empty_session_timeout_policy is set to AFTER.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy. Default value is AFTER\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. Default value is false if emptySessionTimeoutPolicy is set to AFTER or IMMEDIATE.","example":false},"pre_launch_session_timeout_minutes":{"minimum":10,"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. Default value is 10. This is required if pre_launch_session_timeout_policy is set to AFTER.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Application pre-launch session timeout policy. Default value is AFTER\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"session_collaboration_enabled":{"type":"boolean","description":"Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users. Default value is false.","example":false},"session_timeout_policy":{"type":"string","description":"Specifies the session timeout policy for the applications published from the Farm. This policy indicates whether the launched application session is a forever application session or not. Default value is DEFAULT.\n* DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.\n* NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.","example":"DEFAULT","enum":["DEFAULT","NEVER"]}},"description":"Session settings related to the Farm."},"CPFarmSessionSettingsUpdateSpec":{"required":["disconnected_session_timeout_policy","empty_session_timeout_policy","pre_launch_session_timeout_policy","session_collaboration_enabled","session_timeout_policy"],"type":"object","properties":{"disconnected_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Disconnected sessions timeout (in minutes). An empty disconnected session is logged off after the timeout. This is required if the disconnect_session_timeout_policy is set to AFTER.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. Default value is 1. This is required if the empty_session_timeout_policy is set to AFTER.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.","example":false},"pre_launch_session_timeout_minutes":{"minimum":10,"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. ","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Application pre-launch session timeout policy.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"session_collaboration_enabled":{"type":"boolean","description":"Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users.","example":false},"session_timeout_policy":{"type":"string","description":"Specifies the session timeout policy for the applications published from the Farm. This policy indicates whether the launched application session is a forever application session or not.\n* DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.\n* NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.","example":"DEFAULT","enum":["DEFAULT","NEVER"]}},"description":"Session settings related to the Farm."},"CPFarmSpecifiedNamingSettings":{"type":"object","properties":{"num_unassigned_rds_server_kept_powered_on":{"type":"integer","description":"Number of unassigned RDS servers kept powered on.\nThis property can be used for sorting.","format":"int32","example":1},"start_rds_server_in_maintenance_mode":{"type":"boolean","description":"Allows RDS server to be customized manually before users can log in and access them.\nThis property can be used for sorting.","example":false}},"description":"RDS server specified naming settings for the farm"},"CPFarmUpdateSpec":{"required":["access_group_id","enabled","load_balancer_settings","max_session_type","session_settings","use_custom_script_for_load_balancing"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/CPFarmAutomatedSettingsUpdateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/CPFarmRDSHLoadBalancerSettingsUpdateSpec"},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"session_settings":{"$ref":"#/components/schemas/CPFarmSessionSettingsUpdateSpec"},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not.","example":false}},"description":"Farm object to be updated."},"CPFarmUpdateSpecV2":{"required":["access_group_id","enabled","load_balancer_settings","max_session_type","session_settings","use_custom_script_for_load_balancing"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/CPFarmAutomatedSettingsUpdateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled for the farm","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/CPFarmRDSHLoadBalancerSettingsUpdateSpec"},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"session_settings":{"$ref":"#/components/schemas/CPFarmSessionSettingsUpdateSpec"},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not.","example":false}},"description":"Farm object to be updated."},"CPRDSHLoadBalancerSettings":{"type":"object","properties":{"connecting_session_threshold":{"type":"integer","description":"Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions.","format":"int32","example":10},"cpu_threshold":{"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":10},"disk_queue_length_threshold":{"type":"integer","description":"Represents the threshold of average number of both read and write requests that were queued for the selected disk during the sample interval. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":15},"disk_read_latency_threshold":{"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10},"disk_write_latency_threshold":{"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":15},"include_session_count":{"type":"boolean","description":"Indicates whether to include session count for load balancing","example":true},"load_index_lb_enabled":{"type":"boolean","description":"Indicates if load index based load balancing is enabled."},"load_index_threshold":{"type":"integer","description":"Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions","format":"int32","example":20},"memory_threshold":{"type":"integer","description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing","format":"int32","example":10}},"description":"RDSH load balancer settings for the farm"},"CapacityProviderCreateSpec":{"required":["display_name"],"type":"object","properties":{"display_name":{"type":"string","description":"Display name of the capacity provider","example":"Capacity Provider"},"region":{"type":"string","description":"AWS core region. This is required if the type is set to AWS_CORE","example":"us-west-2"},"type":{"type":"string","description":"Provider type of the capacity provider\n* AWS_CORE: AWS core capacity provider.","example":"AWS_CORE","enum":["AWS_CORE"]}},"description":"Capacity provider object to be created."},"CapacityProviderCreateSpecV2":{"required":["display_name"],"type":"object","properties":{"display_name":{"type":"string","description":"Display name of the capacity provider","example":"Capacity Provider"},"has_provider_credentials":{"type":"boolean","description":"Enabled when capacity provider has credentials associated with it (IAM Keys, etc.)","example":false},"provider_id":{"type":"array","description":"Provider ID for credential based access","example":"AKIAIOSFODNN7EXAMPLE","items":{"type":"string","description":"Provider ID for credential based access","example":"AKIAIOSFODNN7EXAMPLE"}},"provider_key":{"type":"array","description":"Provider Key for credential based access","example":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY","items":{"type":"string","description":"Provider Key for credential based access","example":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"}},"region":{"type":"string","description":"AWS core region. This is required if the type is set to AWS_CORE","example":"us-west-2"},"type":{"type":"string","description":"Provider type of the capacity provider\n* AWS_CORE: AWS core capacity provider.","example":"AWS_CORE","enum":["AWS_CORE"]}},"description":"Capacity provider object to be created."},"CapacityProviderInfo":{"type":"object","properties":{"display_name":{"type":"string","description":"Indicated the display name of the capacity provider","example":"Capacity Provider"},"id":{"type":"string","description":"Unique ID representing the capacity provider.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"region":{"type":"string","description":"Indicates the AWS core region. This is applicable if the type is AWS_CORE.","example":"us-west-2"},"type":{"type":"string","description":"Type of the capacity provider.\n* AWS_CORE: AWS core capacity provider.","example":"AWS_CORE","enum":["AWS_CORE"]}},"description":"Information related to capacity provider."},"CapacityProviderInfoV2":{"type":"object","properties":{"display_name":{"type":"string","description":"Indicated the display name of the capacity provider","example":"Capacity Provider"},"has_provider_credentials":{"type":"boolean","description":"Enabled when capacity provider has credentials associated with it (IAM Keys, etc.)","example":false},"id":{"type":"string","description":"Unique ID representing the capacity provider.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"region":{"type":"string","description":"Indicates the AWS core region. This is applicable if the type is AWS_CORE.","example":"us-west-2"},"type":{"type":"string","description":"Type of the capacity provider.\n* AWS_CORE: AWS core capacity provider.","example":"AWS_CORE","enum":["AWS_CORE"]}},"description":"Information related to capacity provider."},"CapacityProviderResourceSettings":{"type":"object","properties":{"clone_datastore_id":{"type":"string","description":"Datastore to store the machines.","example":"datastore-1"},"clone_disk_datastore_policy_id":{"type":"string","description":"Indicates the clone disk datastore policy","example":"policy-1"},"directory_id":{"type":"string","description":"Indicates active directory ID","example":"d-94673ede63"},"enable_cbrc":{"type":"boolean","description":"Indicates whether to use CBRC.\nThis property can be used for sorting.","example":false},"folder_id":{"type":"string","description":"Folder where the machines are deployed to.","example":"group-v1"},"image_id":{"type":"string","description":"This property can be set only when type is set to AUTOMATED.","example":"0a950b74-5175-4a4a-b73e-bb323562ba34"},"image_snapshot_id":{"type":"string","description":"Indicates the parent image snapshot","example":"80ba9ed8-f8b7-43c8-ae3c-4c14bc5b230e"},"network_attributes":{"type":"object","additionalProperties":{"type":"string","description":"Indicates the network attributes like network id","example":"network_id:c9896e51-48a2-4d82-ae9e-a0246981b473"},"description":"Indicates the network attributes like network id","example":"network_id:c9896e51-48a2-4d82-ae9e-a0246981b473"},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks for linked clone machines.","example":"datastore-1"},"replica_disk_datastore_policy_id":{"type":"string","description":"Indicates the replica disk datastore policy","example":"policy-2"},"resource_pool_id":{"type":"string","description":"Resource pool where the machines are deployed to.","example":"resgroup-1"},"use_parent_image_network":{"type":"boolean","description":"Indicates whether to use parent network or different network","example":false},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Indicates whether to use separate datastores for replica and OS disks. <br> Default value is false.","example":false}},"description":"Applicable To: Automated desktop pool. <br>Capacity provider resource settings for Automated desktop pool."},"CapacityProviderResourceSettingsV2":{"type":"object","properties":{"clone_datastore_id":{"type":"string","description":"Datastore to store the machines.","example":"datastore-1"},"clone_disk_datastore_policy_id":{"type":"string","description":"Indicates the clone disk datastore policy","example":"policy-1"},"directory_id":{"type":"string","description":"Indicates active directory ID","example":"d-94673ede63"},"enable_cbrc":{"type":"boolean","description":"Indicates whether to use CBRC.\nThis property can be used for sorting.","example":false},"folder_id":{"type":"string","description":"Folder where the machines are deployed to.","example":"group-v1"},"image_id":{"type":"string","description":"This property can be set only when type is set to AUTOMATED.","example":"0a950b74-5175-4a4a-b73e-bb323562ba34"},"image_identifier":{"type":"string","description":"Golden image identifier","example":"vm-name"},"image_snapshot_id":{"type":"string","description":"Indicates the parent image snapshot","example":"80ba9ed8-f8b7-43c8-ae3c-4c14bc5b230e"},"image_snapshot_identifier":{"type":"string","description":"Golden image snapshot identifier","example":"snapshot-1"},"network_attributes":{"type":"object","additionalProperties":{"type":"string","description":"Indicates the network attributes like network id","example":"network_id:c9896e51-48a2-4d82-ae9e-a0246981b473"},"description":"Indicates the network attributes like network id","example":"network_id:c9896e51-48a2-4d82-ae9e-a0246981b473"},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks for linked clone machines.","example":"datastore-1"},"replica_disk_datastore_policy_id":{"type":"string","description":"Indicates the replica disk datastore policy","example":"policy-2"},"resource_pool_id":{"type":"string","description":"Resource pool where the machines are deployed to.","example":"resgroup-1"},"resource_pool_identifier":{"type":"string","description":"Resource pool identifier","example":"e545f3a5-e7d0-5ad6-a1e6-98168dd1ed51"},"use_parent_image_network":{"type":"boolean","description":"Indicates whether to use parent network or different network","example":false},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Indicates whether to use separate datastores for replica and OS disks. <br> Default value is false.","example":false}},"description":"Applicable To: Automated desktop pool. <br>Capacity provider resource settings for Automated desktop pool."},"CapacityProviderUpdateSpecV2":{"required":["display_name"],"type":"object","properties":{"display_name":{"type":"string","description":"Display name of the capacity provider","example":"Capacity Provider"},"has_provider_credentials":{"type":"boolean","description":"Enabled when capacity provider has credentials associated with it (IAM Keys, etc.)","example":false},"provider_id":{"type":"array","description":"Provider ID for credential based access","example":"AKIAIOSFODNN7EXAMPLE","items":{"type":"string","description":"Provider ID for credential based access","example":"AKIAIOSFODNN7EXAMPLE"}},"provider_key":{"type":"array","description":"Provider Key for credential based access","example":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY","items":{"type":"string","description":"Provider Key for credential based access","example":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"}}},"description":"Capacity Provider object to be updated."},"CertificateData":{"type":"object","properties":{"allow_admin_override":{"type":"boolean","description":"Indicates if admin override is allowed.","example":true},"certificate":{"type":"string","description":"The certificate in string form.","example":"<certificate>"},"certificate_encoding":{"type":"string","description":"The encoding of the certificate.","example":"DER_BASE64_PEM"},"invalid_reasons":{"type":"array","description":"The reason(s) why the certificate could not be validated.","example":["NOT_TRUSTED","CANT_CHECK_REVOKED"],"items":{"type":"string","description":"The reason(s) why the certificate could not be validated.","example":"[\"NOT_TRUSTED\",\"CANT_CHECK_REVOKED\"]"}},"ssl_cert_thumbprint":{"type":"string","description":"A digest of the certificate.","example":"<thumbprint>"},"ssl_cert_thumbprint_algorithm":{"type":"string","description":"Algorithm used to compute the thumbprint.","example":"SHA-1"},"valid":{"type":"boolean","description":"Indicates if certificate is valid.","example":true}},"description":"Certificate information of the remote server."},"CertificateIdentificationSpec":{"required":["certificate_usage","id"],"type":"object","properties":{"certificate_usage":{"type":"string","description":"Indicates how the certificate would be used.\n* MACHINE: vdm certificates\n* CLUSTER: vdm.ec certificates\n* CLUSTER_ENCRYPTION: vdm.enc certificates\n* EXTERNAL: vdm.ext certificates\n* SAML_SIGNING: saml.sig certificates\n* SAML_ENCRYPTION: saml.enc certificates","example":"MACHINE","enum":["MACHINE","CLUSTER","CLUSTER_ENCRYPTION","EXTERNAL","SAML_SIGNING","SAML_ENCRYPTION"]},"id":{"type":"string","description":"Indicates the certificate Id.","example":"a76b1ce3-5c12-ce90-449d-61a02f4e54b6"}},"description":"Identifies the certificates of connection server."},"CertificateInfo":{"type":"object","properties":{"certificate_usage":{"type":"string","description":"Indicates how the certificate would be used.\n\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* MACHINE: vdm certificates\n* CLUSTER: vdm.ec certificates\n* CLUSTER_ENCRYPTION: vdm.enc certificates\n* EXTERNAL: vdm.ext certificates\n* SAML_SIGNING: saml.sig certificates\n* SAML_ENCRYPTION: saml.enc certificates","example":"MACHINE","enum":["MACHINE","CLUSTER","CLUSTER_ENCRYPTION","EXTERNAL","SAML_SIGNING","SAML_ENCRYPTION"]},"dnssubject_alternative_names":{"type":"array","items":{"type":"string"}},"in_use":{"type":"boolean","description":"Indicates whether certificate is currently used by server or not.\n\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"invalid_reasons":{"type":"array","description":"Indicates the reason for invalid certificate.","example":["NAME_MISMATCH","NOT_TRUSTED"],"items":{"type":"string","description":"Indicates the reason for invalid certificate.","example":"[\"NAME_MISMATCH\",\"NOT_TRUSTED\"]"}},"is_valid":{"type":"boolean","description":"Indicates whether certificate is valid or not.\n\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"issuer_name":{"type":"string","description":"Issuer name of certificate.","example":"CN=Horizon-server.example.local, OU=Omnissa Horizon View default certificate, O=Omnissa, Inc."},"serial_number":{"type":"string","description":"Serial number of certificate.","example":"8e8fc36503833556"},"sha1_thumbprint":{"type":"string","description":"SHA1 thumbprint of certificate.","example":"0F:E0:80:6E:7E:0F:BA:EE:0E:BC:0E:A3:8D:FA:19:D8:BD:C0:5E:DF"},"signature_algorithm":{"type":"string","description":"Signature algorithm of certificate.","example":"SHA384withRSA"},"subject_name":{"type":"string","description":"Subject name of certificate.","example":"CN=Horizon-server.example.local, OU=Omnissa Horizon View default certificate, O=Omnissa, Inc."},"valid_from":{"type":"string","description":"Certificate valid from. Numeric version of ISO 8601 format.\n\nSupported Filters: 'StartsWithFilter', 'ContainsFilter'.\nThis property can be used for sorting.","example":"20221010113220"},"valid_until":{"type":"string","description":"Certificate valid until. Numeric version of ISO 8601 format.\n\nSupported Filters: 'StartsWithFilter', 'ContainsFilter'.\nThis property can be used for sorting.","example":"20250112113220"}},"description":"Certificate information of connection server.<br>Supported Filters : 'And', 'Or' and 'Equals', 'StartsWithFilter' and 'ContainsFilter'.<br>See the field description to know the filter types it supports."},"CertificateInfoV2":{"type":"object","properties":{"certificate_usage":{"type":"string","description":"Indicates how the certificate would be used.\n\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* MACHINE: vdm certificates\n* CLUSTER: vdm.ec certificates\n* CLUSTER_ENCRYPTION: vdm.enc certificates\n* EXTERNAL: vdm.ext certificates\n* SAML_SIGNING: saml.sig certificates\n* SAML_ENCRYPTION: saml.enc certificates","example":"MACHINE","enum":["MACHINE","CLUSTER","CLUSTER_ENCRYPTION","EXTERNAL","SAML_SIGNING","SAML_ENCRYPTION"]},"deleted":{"type":"boolean"},"dnssubject_alternative_names":{"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Id.","example":"a76b1ce3-5c12-ce90-449d-61a02f4e54b6"},"in_use":{"type":"boolean","description":"Indicates whether certificate is currently used by server or not.\n\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"invalid_reasons":{"type":"array","description":"Indicates the reason for invalid certificate.","example":["NAME_MISMATCH","NOT_TRUSTED"],"items":{"type":"string","description":"Indicates the reason for invalid certificate.","example":"[\"NAME_MISMATCH\",\"NOT_TRUSTED\"]"}},"isDeleted":{"type":"boolean","writeOnly":true},"is_valid":{"type":"boolean","description":"Indicates whether certificate is valid or not.\n\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"issuer_name":{"type":"string","description":"Issuer name of certificate.","example":"CN=Horizon-server.example.local, OU=Omnissa Horizon View default certificate, O=Omnissa, Inc."},"serial_number":{"type":"string","description":"Serial number of certificate.","example":"8e8fc36503833556"},"sha1_thumbprint":{"type":"string","description":"SHA1 thumbprint of certificate.","example":"0F:E0:80:6E:7E:0F:BA:EE:0E:BC:0E:A3:8D:FA:19:D8:BD:C0:5E:DF"},"signature_algorithm":{"type":"string","description":"Signature algorithm of certificate.","example":"SHA384withRSA"},"subject_name":{"type":"string","description":"Subject name of certificate.","example":"CN=Horizon-server.example.local, OU=Omnissa Horizon View default certificate, O=Omnissa, Inc."},"valid_from":{"type":"string","description":"Certificate valid from. Numeric version of ISO 8601 format.\n\nSupported Filters: 'StartsWithFilter', 'ContainsFilter'.\nThis property can be used for sorting.","example":"20221010113220"},"valid_until":{"type":"string","description":"Certificate valid until. Numeric version of ISO 8601 format.\n\nSupported Filters: 'StartsWithFilter', 'ContainsFilter'.\nThis property can be used for sorting.","example":"20250112113220"}},"description":"Certificate information of connection server.<br>Supported Filters : 'And', 'Or' and 'Equals', 'StartsWithFilter' and 'ContainsFilter'.<br>See the field description to know the filter types it supports."},"CertificateMonitorInfo":{"type":"object","properties":{"valid":{"type":"boolean","description":"Indicates if the certificate is valid.","example":true},"valid_from":{"type":"integer","description":"Start time of the certificate validity in milliseconds. Measured as epoch time.","format":"int64","example":1561939200000},"valid_to":{"type":"integer","description":"Expiration time of the certificate validity in milliseconds. Measured as epoch time.","format":"int64","example":1561939200000}},"description":"Monitoring data about server's certificate."},"CertificateMonitorInfoV2":{"type":"object","properties":{"certificate_type":{"type":"string","description":"Type of the connection server certificate.\n* MACHINE: vdm certificates\n* CLUSTER: vdm.ec certificates\n* CLUSTER_ENCRYPTION: vdm.enc certificates","example":"MACHINE","enum":["MACHINE","CLUSTER","CLUSTER_ENCRYPTION"]},"connection_server_certificate":{"type":"string","description":"Connection server certificate in PEM format.","example":"string"},"ignore_secure_gateway_cert_status":{"type":"boolean","description":"If true, indicates that the certificate health of the Secure Gateway instances should be ignored when showing the overall health status of a connection server. ","example":true},"invalidReason":{"type":"string","writeOnly":true},"invalid_reasons":{"type":"string"},"is_certificate_managed":{"type":"boolean","description":" If true, it indicates that the given certificate renews automatically. ","example":true},"valid":{"type":"boolean","description":"Indicates if the certificate is valid.","example":true},"valid_from":{"type":"integer","description":"Start time of the certificate validity in milliseconds. Measured as epoch time.","format":"int64","example":1561939200000},"valid_to":{"type":"integer","description":"Expiration time of the certificate validity in milliseconds. Measured as epoch time.","format":"int64","example":1561939200000}},"description":"Monitoring data about server's certificate."},"CertificateOverrideData":{"type":"object","properties":{"certificate":{"type":"string","description":"Virtual Center certificate"},"type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]}},"description":"Certificate details and type information, which can be used to override thumbprint details."},"CertificateOverrideDataCreateSpec":{"type":"object","properties":{"certificate":{"type":"string","description":"Virtual Center certificate"},"type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]}},"description":"Certificate details and type information, which can be used to override thumbprint details."},"CertificateOverrideDataUpdateSpec":{"type":"object","properties":{"certificate":{"type":"string","description":"Virtual Center certificate"},"type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]}},"description":"Certificate details and type information, which can be used to override thumbprint details."},"CertificateProperties":{"type":"object","properties":{"key_length":{"type":"integer","description":"Certificate generation SSO Key length.","format":"int32","example":2048},"validity":{"type":"integer","description":"Certificate generation SSO key validity period in days.","format":"int32","example":365}},"description":"Certificate properties."},"CertificateServerDetails":{"type":"object","properties":{"name":{"type":"string","description":"Certificate Server name.","example":"SSOConnector"},"status":{"type":"string","description":"Certificate Server status.\n* OK: The state of the certificate server is OK as reported by the enrollment servers.\n* WARN: At least one enrollment server reports a warning on this certificate server.\n* ERROR: At least one enrollment server reports an error on this certificate server.","example":"OK","enum":["OK","WARN","ERROR"]}},"description":"Details of each certificate server."},"CertificateServerDetailsV2":{"type":"object","properties":{"name":{"type":"string","description":"Certificate Server name.","example":"SSOConnector"},"primary_enrollment_server_state_reasons":{"type":"array","description":"Reasons for the state from the primary enrollment server.","example":"SUPPORTED_NOT_OPTIMAL","items":{"type":"string","description":"* CONNECTED_DEGRADED: Warn: The enrollment server has connected to the certificate server, but the certificate server is in a degraded state.\n* DISCONNECTED: Error: The enrollment server is not connected to the certificate server.\n* SERVICE_UNAVAILABLE: Error: The enrollment server can connect to the certificate server, but the service is unavailable.\n* NOT_FOUND: Error: The certificate server does not exist on the enrollment server domain.\n* CERTIFICATE_NOT_YET_VALID: Error: The certificate is not yet valid.\n* CERTIFICATE_UNKNOWN: Error: The certificate status is unknown.\n* CERTIFICATE_INVALID: Error: The certificate is corrupt or unable to be used. A certificate server with a certificate with this status cannot be used in connector creation.\n* CERTIFICATE_EXPIRED: Error: The certificate has expired. A certificate server with a certificate with this status cannot be used in connector creation.\n* CERTIFICATE_NOT_TRUSTED: Error: The certificate is not in the NTAuth (Enterprise) store. A certificate server with a certificate with this status cannot be used in connector creation.\n* CERTIFICATE_TEMPLATE_NOT_PUBLISHED: Error: The certificate template is not published on this CA.","example":"SUPPORTED_NOT_OPTIMAL","enum":["CONNECTED_DEGRADED","DISCONNECTED","SERVICE_UNAVAILABLE","NOT_FOUND","CERTIFICATE_NOT_YET_VALID","CERTIFICATE_UNKNOWN","CERTIFICATE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_NOT_TRUSTED","CERTIFICATE_TEMPLATE_NOT_PUBLISHED"]}},"secondary_enrollment_server_state_reasons":{"type":"array","description":"Reasons for the state from the secondary enrollment server.","example":"NO_CAPABILITY","items":{"type":"string","description":"* CONNECTED_DEGRADED: Warn: The enrollment server has connected to the certificate server, but the certificate server is in a degraded state.\n* DISCONNECTED: Error: The enrollment server is not connected to the certificate server.\n* SERVICE_UNAVAILABLE: Error: The enrollment server can connect to the certificate server, but the service is unavailable.\n* NOT_FOUND: Error: The certificate server does not exist on the enrollment server domain.\n* CERTIFICATE_NOT_YET_VALID: Error: The certificate is not yet valid.\n* CERTIFICATE_UNKNOWN: Error: The certificate status is unknown.\n* CERTIFICATE_INVALID: Error: The certificate is corrupt or unable to be used. A certificate server with a certificate with this status cannot be used in connector creation.\n* CERTIFICATE_EXPIRED: Error: The certificate has expired. A certificate server with a certificate with this status cannot be used in connector creation.\n* CERTIFICATE_NOT_TRUSTED: Error: The certificate is not in the NTAuth (Enterprise) store. A certificate server with a certificate with this status cannot be used in connector creation.\n* CERTIFICATE_TEMPLATE_NOT_PUBLISHED: Error: The certificate template is not published on this CA.","example":"NO_CAPABILITY","enum":["CONNECTED_DEGRADED","DISCONNECTED","SERVICE_UNAVAILABLE","NOT_FOUND","CERTIFICATE_NOT_YET_VALID","CERTIFICATE_UNKNOWN","CERTIFICATE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_NOT_TRUSTED","CERTIFICATE_TEMPLATE_NOT_PUBLISHED"]}},"status":{"type":"string","description":"Certificate Server status.\n* OK: The state of the certificate server is OK as reported by the enrollment servers.\n* WARN: At least one enrollment server reports a warning on this certificate server.\n* ERROR: At least one enrollment server reports an error on this certificate server.","example":"OK","enum":["OK","WARN","ERROR"]}},"description":"Details of each certificate server."},"CertificateSpec":{"required":["certificate_chain","certificate_usage","format"],"type":"object","properties":{"certificate_chain":{"type":"string","format":"byte"},"certificate_password":{"type":"array","description":"Password for pfx certificate type.","example":"password","items":{"type":"string","description":"Password for pfx certificate type.","example":"password"}},"certificate_usage":{"type":"string","description":"Indicates the type of certificate based on usage.\n* MACHINE: vdm certificates\n* CLUSTER: vdm.ec certificates\n* CLUSTER_ENCRYPTION: vdm.enc certificates\n* EXTERNAL: vdm.ext certificates\n* SAML_SIGNING: saml.sig certificates\n* SAML_ENCRYPTION: saml.enc certificates","example":"MACHINE","enum":["MACHINE","CLUSTER","CLUSTER_ENCRYPTION","EXTERNAL","SAML_SIGNING","SAML_ENCRYPTION"]},"format":{"type":"string","description":"Certificate Type.\n","example":"pem","enum":["pem","pfx"]}},"description":"Certificate Spec."},"CertificateThumbprint":{"required":["ssl_cert_thumbprint","ssl_cert_thumbprint_algorithm"],"type":"object","properties":{"ssl_cert_thumbprint":{"type":"string","description":"A digest of the certificate.","example":"8f:92:9d:3b:a7:85:55:88:60:cd:e1:c8:1e:70:9a:8b:37:6d:a6:e6"},"ssl_cert_thumbprint_algorithm":{"type":"string","description":"Algorithm used to compute the thumbprint.\n* SHA_1: SHA-1 hashing algorithm.\n* SHA_256: SHA-256 hashing algorithm.","example":"SHA_1","enum":["SHA_1","SHA_256"]}},"description":"Information about the SSL Certificate thumbprints"},"CertificateThumbprintSpec":{"type":"object","properties":{"certificate":{"type":"string","description":"Virtual Center certificate"},"type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]}},"description":"Certificate details and type information, which can be used to override thumbprint details."},"ClientData":{"type":"object","properties":{"address":{"type":"string","description":"IP address of the client machine for the session. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"127.0.0.1"},"location_id":{"type":"string","description":"Client location for the session. \nThis property need not be set.<br>Supported Filters : 'Equals'.","example":"6bda20e66cda315084edc8b5c67f9cf1e3b0f4559ba990b1004a"},"name":{"type":"string","description":"Client machine hostname for the session. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"EXAMPLE-CLIENT1"},"type":{"type":"string","description":"Client type for the session. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* WINDOWS: Client type is Windows client.\n* MAC: Client type is Mac client.\n* HTMLACCESS: Client type is Web client.\n* LINUX: Client type is Linux client.\n* IOS: Client type is iOS client.\n* ANDROID: Client type is Android client.\n* OTHER: Client type is other.","example":"WINDOWS","enum":["WINDOWS","MAC","HTMLACCESS","LINUX","IOS","ANDROID","OTHER"]},"version":{"type":"string","description":"Client version for the session. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"5.4.0"}},"description":"Client data associated with the session."},"ClientKeyDerivationSpec":{"required":["identifier","nonce","public_key","supported_schemes"],"type":"object","properties":{"identifier":{"type":"string","format":"byte"},"nonce":{"type":"string","format":"byte"},"public_key":{"type":"string","format":"byte"},"supported_schemes":{"uniqueItems":true,"type":"array","description":"List of client supported schemes for key derivation.","example":["SCHEME-AES2"],"items":{"type":"string","description":"* SCHEME_AES1: Diffie Hellman algo used by low power clients.\n* SCHEME_AES2: Diffie Hellman algo used by high power clients.\n* SCHEME_EC_AES1: Elliptic-curve Diffie Hellman algo used by low power clients.\n* SCHEME_EC_AES2: Elliptic-curve Diffie Hellman algo used by high power clients.","example":"[\"SCHEME-AES2\"]","enum":["SCHEME-AES1","SCHEME-AES2","SCHEME-EC-AES1","SCHEME-EC-AES2"]},"enum":["SCHEME-AES1","SCHEME-AES2","SCHEME-EC-AES1","SCHEME-EC-AES2"]}},"description":"Client key derivation spec."},"ClientPolicyInfo":{"type":"object","properties":{"enforcement_state":{"type":"string","description":"Enforcement State configured in server\n* REQUIRED: Enforcement state is REQUIRED.\n* PREFERRED: Enforcement state is PREFERRED.\n* FREE: Enforcement state is FREE.\n* UNKNOWN: Enforcement state is UNKNOWN.","example":"REQUIRED","enum":["REQUIRED","PREFERRED","FREE","UNKNOWN"]},"policy":{"type":"string","description":"Name of the client policy\n* CERTIFICATE_VALIDATION: Client Policy is CERTIFICATE_VALIDATION.\n* UNKNOWN: Client Policy is UNKNOWN.","example":"CERTIFICATE_VALIDATION","enum":["CERTIFICATE_VALIDATION","UNKNOWN"]},"policy_values":{"type":"array","description":"List of policy values","example":["ENFORCE"],"items":{"type":"string","description":"List of policy values","example":"[\"ENFORCE\"]"}}},"description":"Information related to client policy"},"ClientPolicyInfoV2":{"type":"object","properties":{"enforcement_state":{"type":"string","description":"Enforcement State configured in server\n* REQUIRED: Enforcement state is REQUIRED.\n* PREFERRED: Enforcement state is PREFERRED.\n* FREE: Enforcement state is FREE.\n* UNKNOWN: Enforcement state is UNKNOWN.","example":"REQUIRED","enum":["REQUIRED","PREFERRED","FREE","UNKNOWN"]},"log_event":{"type":"boolean","description":"Flag for event logging","example":false},"policy":{"type":"string","description":"Name of the client policy\n* CERTIFICATE_VALIDATION: Client Policy is CERTIFICATE_VALIDATION.\n* UNKNOWN: Client Policy is UNKNOWN.","example":"CERTIFICATE_VALIDATION","enum":["CERTIFICATE_VALIDATION","UNKNOWN"]},"policy_values":{"type":"array","description":"List of policy values","example":["ENFORCE"],"items":{"type":"string","description":"List of policy values","example":"[\"ENFORCE\"]"}}},"description":"Information related to client policy"},"ClientPolicyUpdateSpec":{"required":["enforcement_state","policy"],"type":"object","properties":{"enforcement_state":{"type":"string","description":"Enforcement State configured in server\n* REQUIRED: Enforcement state is REQUIRED.\n* PREFERRED: Enforcement state is PREFERRED.\n* FREE: Enforcement state is FREE.\n* UNKNOWN: Enforcement state is UNKNOWN.","example":"REQUIRED","enum":["REQUIRED","PREFERRED","FREE","UNKNOWN"]},"policy":{"type":"string","description":"Name of the client policy\n* CERTIFICATE_VALIDATION: Client Policy is CERTIFICATE_VALIDATION.\n* UNKNOWN: Client Policy is UNKNOWN.","example":"CERTIFICATE_VALIDATION","enum":["CERTIFICATE_VALIDATION","UNKNOWN"]},"policy_values":{"type":"array","description":"List of policy values","example":["ENFORCE"],"items":{"type":"string","description":"List of policy values","example":"[\"ENFORCE\"]"}}},"description":"Information required to update single client policy."},"ClientPolicyUpdateSpecV2":{"required":["enforcement_state","policy"],"type":"object","properties":{"enforcement_state":{"type":"string","description":"Enforcement State configured in server\n* REQUIRED: Enforcement state is REQUIRED.\n* PREFERRED: Enforcement state is PREFERRED.\n* FREE: Enforcement state is FREE.\n* UNKNOWN: Enforcement state is UNKNOWN.","example":"REQUIRED","enum":["REQUIRED","PREFERRED","FREE","UNKNOWN"]},"log_event":{"type":"boolean","description":"Flag for event logging","example":false},"policy":{"type":"string","description":"Name of the client policy\n* CERTIFICATE_VALIDATION: Client Policy is CERTIFICATE_VALIDATION.\n* UNKNOWN: Client Policy is UNKNOWN.","example":"CERTIFICATE_VALIDATION","enum":["CERTIFICATE_VALIDATION","UNKNOWN"]},"policy_values":{"type":"array","description":"List of policy values","example":["ENFORCE"],"items":{"type":"string","description":"List of policy values","example":"[\"ENFORCE\"]"}}},"description":"Information required to update single client policy (V2)."},"ClientProperties":{"type":"object","properties":{"cipher_suites":{"type":"array","description":"List of cipher suites of client.","example":["TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384"],"items":{"type":"string","description":"List of cipher suites of client.","example":"[\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256\",\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384\"]"}},"named_groups":{"type":"array","description":"List of named groups of client.","example":["SECP384_R1","FFDHE_2048"],"items":{"type":"string","description":"List of named groups of client.","example":"[\"SECP384_R1\",\"FFDHE_2048\"]"}},"signature_algorithms":{"type":"array","description":"List of signature algorithms of client.","example":["RSA_PSS_RSAE_SHA512","RSA_PKCS1_SHA512","ECDSA_SECP521R1_SHA512"],"items":{"type":"string","description":"List of signature algorithms of client.","example":"[\"RSA_PSS_RSAE_SHA512\",\"RSA_PKCS1_SHA512\",\"ECDSA_SECP521R1_SHA512\"]"}},"thumbprint_algorithms":{"type":"array","description":"List of thumbprint algorithms of client.","example":["SHA_512","SHA_384"],"items":{"type":"string","description":"List of thumbprint algorithms of client.","example":"[\"SHA_512\",\"SHA_384\"]"}}},"description":"Client properties of Security configuration."},"ClientSettingsInfo":{"type":"object","properties":{"client_policies":{"type":"array","description":"Information related to client policy","items":{"$ref":"#/components/schemas/ClientPolicyInfo"}}},"description":"Information related to client settings."},"ClientSettingsInfoV2":{"type":"object","properties":{"client_policies":{"type":"array","description":"Information related to client policy","items":{"$ref":"#/components/schemas/ClientPolicyInfoV2"}}},"description":"Information related to client settings."},"ClientSettingsUpdateSpec":{"required":["client_policies"],"type":"object","properties":{"client_policies":{"type":"array","description":"Information required to update client settings.","items":{"$ref":"#/components/schemas/ClientPolicyUpdateSpec"}}},"description":"Client Settings object to be updated."},"ClientSettingsUpdateSpecV2":{"required":["client_policies"],"type":"object","properties":{"client_policies":{"type":"array","description":"Information required to update client settings.","items":{"$ref":"#/components/schemas/ClientPolicyUpdateSpecV2"}}},"description":"Client Settings object to be updated."},"ComputeProfileCreateSpec":{"required":["name","num_cores_per_socket","num_cpus","ram_in_gb"],"type":"object","properties":{"add_vtpm":{"type":"boolean","description":"Indicates whether to add vtpm in the compute profile to be configured on clones. By default this value will be false","example":true},"gpu_profile":{"type":"string","description":"Indicates the gpu profile.","example":"gpuprofile-1"},"name":{"type":"string","description":"Indicates the compute profile name.","example":"Computeprofile-1"},"num_cores_per_socket":{"minimum":1,"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones.\nIf set, both num_cpus and ram_mb need to be set. ","format":"int32","example":1},"num_cpus":{"minimum":1,"type":"integer","description":"Indicates the number of CPUs in the compute profile to be configured on clones.\nIf set, this must be a multiple of num_cores_per_socket.","format":"int32","example":4},"ram_in_gb":{"minimum":1,"type":"integer","description":"Specifies the RAM in GB within the compute profile to be set on clones.","format":"int32","example":2}},"description":"Compute profile specification"},"ComputeProfileInfo":{"type":"object","properties":{"add_vtpm":{"type":"boolean","description":"Indicates whether to add vtpm in the compute profile to be configured on clones.","example":true},"compute_profile_usage_count":{"type":"integer","description":"Indicates the total count of desktops and farms utilizing the compute profile.","format":"int32","example":3},"gpu_profile":{"type":"string","description":"Indicates the gpu profile.","example":"gpuprofile-1"},"id":{"type":"string","description":"ID of the Compute Profile.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"name":{"type":"string","description":"Indicates the compute profile name.","example":"Computeprofile-1"},"num_cores_per_socket":{"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile configured on clones.","format":"int32","example":1},"num_cpus":{"type":"integer","description":"Indicates the number of CPUs in the compute profile configured on clones.","format":"int32","example":4},"ram_in_gb":{"type":"integer","description":"Specifies the RAM in GB within the compute profile to be set on clones.","format":"int32","example":4}},"description":"Information related to compute profile settings."},"ComputeProfileUpdateSpec":{"required":["num_cores_per_socket","num_cpus","ram_in_gb"],"type":"object","properties":{"add_vtpm":{"type":"boolean","description":"Indicates whether to add vtpm in the compute profile to be configured on clones. By default this value will be false","example":true},"gpu_profile":{"type":"string","description":"Indicates the gpu profile.","example":"gpuprofile-1"},"num_cores_per_socket":{"minimum":1,"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones.\nIf set, both num_cpus and ram_mb need to be set. ","format":"int32","example":1},"num_cpus":{"minimum":1,"type":"integer","description":"Indicates the number of CPUs in the compute profile to be configured on clones.\nIf set, this must be a multiple of num_cores_per_socket.","format":"int32","example":4},"ram_in_gb":{"minimum":1,"type":"integer","description":"Specifies the RAM in GB within the compute profile to be set on clones","format":"int32","example":4}},"description":"Compute Profile whose settings need to be updated."},"ConnectionServerGSSAPIInfo":{"type":"object","properties":{"allow_receiving_ntlm":{"type":"boolean","description":"Indicates whether connection server supports NTLM or not.","example":false},"gss_apiauthenticator_id":{"type":"string","description":"ID of the GSS API authenticator to use.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"gss_apienabled":{"type":"boolean","description":"Indicates whether GSSAPI authentication is enabled.","example":false}},"description":"Information related to connection server GSS API configuration."},"ConnectionServerGSSAPISpec":{"required":["gss_apienabled"],"type":"object","properties":{"gss_apienabled":{"type":"boolean","description":"Indicates whether GSSAPI authentication is enabled.","example":false}},"description":"Information related to connection server GSS API configuration."},"ConnectionServerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique Id of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"jwt_info":{"$ref":"#/components/schemas/ConnectionServerJWTInfo"}},"description":"Information related to Connection Server."},"ConnectionServerInfoV2":{"type":"object","properties":{"auxillary_external_pcoip_ipv4_address":{"type":"string","description":"This is set only if external_pcoip_url is set and contains a host part that represents an IPv6 address or DNS name.\r\nAs legacy clients may not support IPv6 or DNS names for external PCoIP URLs, this IPv4 address, if set, will be presented to them as an alternative. The same port will be used and should not be specified.\r\nIf bypass_pcoip_gateway is set to true, this property will not be set.","example":"127.0.0.1:4172"},"bypass_app_blast_gateway":{"type":"boolean","description":"Indicates whether a bypassing blast secure gateway is enabled for this connection server instance.\r\nIf this is set to true, web browsers make direct connections to Horizon machines bypassing connection server.","example":false},"bypass_pcoip_gateway":{"type":"boolean","description":"Indicates whether the PCoIP traffic bypasses the secure gateway.","example":true},"bypass_tunnel":{"type":"boolean","description":"Indicates whether a secure tunnel on this connection server instance is enabled.\r\nIf this is set to false, a secure tunnel on this Connection Server instance is enabled and horizon clents can connect to desktop pools through the secure tunnel,\r\nwhich carries RDP and other data over HTTPS. PCoIP and HTML Access connections use separate secure gateways.","example":false},"cluster_name":{"type":"string","description":"Cluster name.","example":"Cluster-CS1"},"direct_htmlabsg":{"type":"boolean","description":"Indicates whether only HTML clients use blast secure gateway for this connection server instance.\r\nThis property will not be set if bypass_appblast_gateway is set to false.","example":false},"disclose_service_principal_name":{"type":"boolean","description":"Indicates whether the connection server's service principal name will be sent to the client prior to the user authentication.When set to true Connection Server discloses its service principal name to the client.","example":false},"enable_smart_card_user_name_hint":{"type":"boolean","description":"Indicates whether username hints for smart card is enabled.","example":false},"enabled":{"type":"boolean","description":"Indicate whether the connection server is enabled. A disabled connection server will not accept connection requests from Horizon Clients.","example":true},"external_appblast_url":{"type":"string","description":"The Blast External URL enables browser access to Horizon machines through this connection server instance.\r\nTo enable Blast, you must install HTML Access.\r\nThe Blast External URL must not be load balanced.\r\nIf bypass_appblast_gateway is set to true, this property will not be set.","example":"https://cs1.example.com:8443"},"external_pcoip_url":{"type":"string","description":"Horizon Clients use the PCoIP External URL to establish a PCoIP connection through this Connection Server instance.\r\nThe PCoIP External URL must not be load balanced.\r\nIf bypass_pcoip_gateway is set to true, this property will not be set.","example":"127.0.0.1:4172"},"external_url":{"type":"string","description":"Horizon Clients use the External URL to establish a secure tunnel to this Connection Server instance.\r\nIf a server name is specified, it must be resolvable by each Horizon Client.\r\nThe External URL must not be load balanced.\r\nIf bypass_tunnel is set to true, this property will not be set.","example":"https://cs1.example.com:443"},"fips_mode_enabled":{"type":"boolean","description":"Indicates whether this server has FIPS mode enabled.","example":false},"fqhn":{"type":"string","description":"Fully qualified host name.","example":"cs1.example.com"},"gss_apiinfo":{"$ref":"#/components/schemas/ConnectionServerGSSAPIInfo"},"has_blast_gateway_support":{"type":"boolean","description":"Indicates whether Blast gateway is supported or not.","example":true},"has_pcoip_gateway_support":{"type":"boolean","description":"Indicates whether PCoIP gateway is supported or not.","example":true},"host_redirection":{"type":"boolean","description":"Indicates whether connection server supports HTTP host redirection.","example":false},"id":{"type":"string","description":"Unique Id of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"ip_mode":{"type":"string","description":"Indicates the Connection Server IP environment.\n* IPv4: The ip mode is IPv4.\n* IPv6: The ip mode is IPv6.","example":"IPv4","enum":["IPv4","IPv6"]},"jwt_info":{"$ref":"#/components/schemas/ConnectionServerJWTInfo"},"ldap_backup_info":{"$ref":"#/components/schemas/ConnectionServerLdapBackupInfo"},"load_balancer_hosts":{"type":"array","description":"List of load balancer host names or IP address.","example":["10.217.68.253","10.217.68.254"],"items":{"type":"string","description":"List of load balancer host names or IP address.","example":"[\"10.217.68.253\",\"10.217.68.254\"]"}},"local_connection_server":{"type":"boolean","description":"Indicates whether this is the local connection server that handled the connection server service request.","example":true},"logoff_when_remove_smart_card":{"type":"boolean","description":"Indicates whether user is logged off on removal of Smart Card.","example":false},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this Connection Server.","example":false},"msg_security_public_key":{"type":"string","description":"The JMS message security public key.","example":"MIHwMIGoBgcqhkjOOAQBMIGcAkEA/KaCzo4Syrom78z3EQ5SbbB4sF7ey80etKII864WF64B81uRpH5t9jQTxeEu0Imbz\r\nRMqzVDZkVG9xD7nN1kuFwIVAJYu3cw2nLqOuyYO5rahJtk0bjjFAkBnhHGyepz0TukaScUUfbGpqvJE8FpDTWSGkx0tFCcbn\r\njUDC3H9c9oXkGmzLik1Yw4cIGI1TQ2iCmxBblC+eUykA0MAAkBTVayCjCDm9x1oPkzxvlRrn2ZJWJPnEAMvxnyBOA8rJ/uD0BkQ/iSV/Q3HoR5Mkwc/mMeMuo9VpLK0wgb0BUZ9"},"name":{"type":"string","description":"Name of the Connection Server.","example":"cs1.example.com"},"radius_info":{"$ref":"#/components/schemas/ConnectionServerRADIUSInfo"},"router_ssl_thumbprints":{"type":"array","description":"The JMS router SSL thumbprints","example":["d9:46:70:13:d1:1c:37:47:ba:c7:5f:9b:55:fc:e7:48:9b:1e:4b:ef:6c:62:bf:e7:0b:43:69:31:29:c0:b9:fa#SHA_256","74:84:31:a5:86:ce:b8:f6:f7:f4:8b:d5:de:b6:a9:f9:be:ce:62:06:7a:01:d8:f9:d1:19:ce:9b:2d:bf:e2:2c#SHA_256"],"items":{"type":"string","description":"The JMS router SSL thumbprints","example":"[\"d9:46:70:13:d1:1c:37:47:ba:c7:5f:9b:55:fc:e7:48:9b:1e:4b:ef:6c:62:bf:e7:0b:43:69:31:29:c0:b9:fa#SHA_256\",\"74:84:31:a5:86:ce:b8:f6:f7:f4:8b:d5:de:b6:a9:f9:be:ce:62:06:7a:01:d8:f9:d1:19:ce:9b:2d:bf:e2:2c#SHA_256\"]"}},"rsa_secure_id_info":{"$ref":"#/components/schemas/ConnectionServerRSASecureIdInfo"},"saml_info":{"$ref":"#/components/schemas/ConnectionServerSAMLInfo"},"server_url":{"type":"string","description":"General URL for the connection server.","example":"https://cs1.example.com:443"},"smart_card_support":{"type":"string","description":"Smart Card support option.\n* OPTIONAL: Indicates that the SmartCard usage is optional.\n* REQUIRED: Indicates that the SmartCard usage is necessary.\n* OFF: Indicates that the SmartCard usage is not allowed.","example":"OPTIONAL","enum":["OPTIONAL","REQUIRED","OFF"]},"smart_card_support_for_admin":{"type":"string","description":"Indicates Smart card authentication configuration for administrators to login.\n* OPTIONAL: Indicates that the SmartCard usage is optional.\n* REQUIRED: Indicates that the SmartCard usage is necessary.\n* OFF: Indicates that the SmartCard usage is not allowed.","example":"OFF","enum":["OPTIONAL","REQUIRED","OFF"]},"tags":{"type":"array","description":"Tags to restrict accessibility to desktop pools through this server.","example":["tag1","tag2"],"items":{"type":"string","description":"Tags to restrict accessibility to desktop pools through this server.","example":"[\"tag1\",\"tag2\"]"}},"unauthenticated_access_info":{"$ref":"#/components/schemas/ConnectionServerUnauthenticatedAccessInfo"},"version":{"type":"string","description":"Version attribute to indicate functionalities supported by current connection server.","example":"8.6.0-19754208"}},"description":"Information related to Connection server."},"ConnectionServerInfoV3":{"type":"object","properties":{"auxillary_external_pcoip_ipv4_address":{"type":"string","description":"This is set only if external_pcoip_url is set and contains a host part that represents an IPv6 address or DNS name.\r\nAs legacy clients may not support IPv6 or DNS names for external PCoIP URLs, this IPv4 address, if set, will be presented to them as an alternative. The same port will be used and should not be specified.\r\nIf bypass_pcoip_gateway is set to true, this property will not be set.","example":"127.0.0.1:4172"},"bypass_app_blast_gateway":{"type":"boolean","description":"Indicates whether a bypassing blast secure gateway is enabled for this connection server instance.\r\nIf this is set to true, web browsers make direct connections to Horizon machines bypassing connection server.","example":false},"bypass_pcoip_gateway":{"type":"boolean","description":"Indicates whether the PCoIP traffic bypasses the secure gateway.","example":true},"bypass_tunnel":{"type":"boolean","description":"Indicates whether a secure tunnel on this connection server instance is enabled.\r\nIf this is set to false, a secure tunnel on this Connection Server instance is enabled and horizon clents can connect to desktop pools through the secure tunnel,\r\nwhich carries RDP and other data over HTTPS. PCoIP and HTML Access connections use separate secure gateways.","example":false},"cluster_name":{"type":"string","description":"Cluster name.","example":"Cluster-CS1"},"direct_htmlabsg":{"type":"boolean","description":"Indicates whether only HTML clients use blast secure gateway for this connection server instance.\r\nThis property will not be set if bypass_appblast_gateway is set to false.","example":false},"disclose_service_principal_name":{"type":"boolean","description":"Indicates whether the connection server's service principal name will be sent to the client prior to the user authentication.When set to true Connection Server discloses its service principal name to the client.","example":false},"enable_smart_card_user_name_hint":{"type":"boolean","description":"Indicates whether username hints for smart card is enabled.","example":false},"enabled":{"type":"boolean","description":"Indicate whether the connection server is enabled. A disabled connection server will not accept connection requests from Horizon Clients.","example":true},"external_appblast_url":{"type":"string","description":"The Blast External URL enables browser access to Horizon machines through this connection server instance.\r\nTo enable Blast, you must install HTML Access.\r\nThe Blast External URL must not be load balanced.\r\nIf bypass_appblast_gateway is set to true, this property will not be set.","example":"https://cs1.example.com:8443"},"external_pcoip_url":{"type":"string","description":"Horizon Clients use the PCoIP External URL to establish a PCoIP connection through this Connection Server instance.\r\nThe PCoIP External URL must not be load balanced.\r\nIf bypass_pcoip_gateway is set to true, this property will not be set.","example":"127.0.0.1:4172"},"external_url":{"type":"string","description":"Horizon Clients use the External URL to establish a secure tunnel to this Connection Server instance.\r\nIf a server name is specified, it must be resolvable by each Horizon Client.\r\nThe External URL must not be load balanced.\r\nIf bypass_tunnel is set to true, this property will not be set.","example":"https://cs1.example.com:443"},"fips_mode_enabled":{"type":"boolean","description":"Indicates whether this server has FIPS mode enabled.","example":false},"fqhn":{"type":"string","description":"Fully qualified host name.","example":"cs1.example.com"},"gss_apiinfo":{"$ref":"#/components/schemas/ConnectionServerGSSAPIInfo"},"has_blast_gateway_support":{"type":"boolean","description":"Indicates whether Blast gateway is supported or not.","example":true},"has_pcoip_gateway_support":{"type":"boolean","description":"Indicates whether PCoIP gateway is supported or not.","example":true},"host_redirection":{"type":"boolean","description":"Indicates whether connection server supports HTTP host redirection.","example":false},"id":{"type":"string","description":"Unique Id of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"ip_mode":{"type":"string","description":"Indicates the Connection Server IP environment.\n* IPv4: The ip mode is IPv4.\n* IPv6: The ip mode is IPv6.","example":"IPv4","enum":["IPv4","IPv6"]},"jwt_info":{"$ref":"#/components/schemas/ConnectionServerJWTInfo"},"ldap_backup_info":{"$ref":"#/components/schemas/ConnectionServerLdapBackupInfo"},"load_balancer_hosts":{"type":"array","description":"List of load balancer host names or IP address.","example":["10.217.68.253","10.217.68.254"],"items":{"type":"string","description":"List of load balancer host names or IP address.","example":"[\"10.217.68.253\",\"10.217.68.254\"]"}},"local_connection_server":{"type":"boolean","description":"Indicates whether this is the local connection server that handled the connection server service request.","example":true},"logoff_when_remove_smart_card":{"type":"boolean","description":"Indicates whether user is logged off on removal of Smart Card.","example":false},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this Connection Server.","example":false},"msg_security_public_key":{"type":"string","description":"The JMS message security public key.","example":"MIHwMIGoBgcqhkjOOAQBMIGcAkEA/KaCzo4Syrom78z3EQ5SbbB4sF7ey80etKII864WF64B81uRpH5t9jQTxeEu0Imbz\r\nRMqzVDZkVG9xD7nN1kuFwIVAJYu3cw2nLqOuyYO5rahJtk0bjjFAkBnhHGyepz0TukaScUUfbGpqvJE8FpDTWSGkx0tFCcbn\r\njUDC3H9c9oXkGmzLik1Yw4cIGI1TQ2iCmxBblC+eUykA0MAAkBTVayCjCDm9x1oPkzxvlRrn2ZJWJPnEAMvxnyBOA8rJ/uD0BkQ/iSV/Q3HoR5Mkwc/mMeMuo9VpLK0wgb0BUZ9"},"name":{"type":"string","description":"Name of the Connection Server.","example":"cs1.example.com"},"radius_info":{"$ref":"#/components/schemas/ConnectionServerRADIUSInfo"},"router_ssl_thumbprints":{"type":"array","description":"The JMS router SSL thumbprints","example":["d9:46:70:13:d1:1c:37:47:ba:c7:5f:9b:55:fc:e7:48:9b:1e:4b:ef:6c:62:bf:e7:0b:43:69:31:29:c0:b9:fa#SHA_256","74:84:31:a5:86:ce:b8:f6:f7:f4:8b:d5:de:b6:a9:f9:be:ce:62:06:7a:01:d8:f9:d1:19:ce:9b:2d:bf:e2:2c#SHA_256"],"items":{"type":"string","description":"The JMS router SSL thumbprints","example":"[\"d9:46:70:13:d1:1c:37:47:ba:c7:5f:9b:55:fc:e7:48:9b:1e:4b:ef:6c:62:bf:e7:0b:43:69:31:29:c0:b9:fa#SHA_256\",\"74:84:31:a5:86:ce:b8:f6:f7:f4:8b:d5:de:b6:a9:f9:be:ce:62:06:7a:01:d8:f9:d1:19:ce:9b:2d:bf:e2:2c#SHA_256\"]"}},"rsa_secure_id_info":{"$ref":"#/components/schemas/ConnectionServerRSASecureIdInfo"},"saml_info":{"$ref":"#/components/schemas/ConnectionServerSAMLInfoV2"},"server_url":{"type":"string","description":"General URL for the connection server.","example":"https://cs1.example.com:443"},"smart_card_support":{"type":"string","description":"Smart Card support option.\n* OPTIONAL: Indicates that the SmartCard usage is optional.\n* REQUIRED: Indicates that the SmartCard usage is necessary.\n* OFF: Indicates that the SmartCard usage is not allowed.","example":"OPTIONAL","enum":["OPTIONAL","REQUIRED","OFF"]},"smart_card_support_for_admin":{"type":"string","description":"Indicates Smart card authentication configuration for administrators to login.\n* OPTIONAL: Indicates that the SmartCard usage is optional.\n* REQUIRED: Indicates that the SmartCard usage is necessary.\n* OFF: Indicates that the SmartCard usage is not allowed.","example":"OFF","enum":["OPTIONAL","REQUIRED","OFF"]},"tags":{"type":"array","description":"Tags to restrict accessibility to desktop pools through this server.","example":["tag1","tag2"],"items":{"type":"string","description":"Tags to restrict accessibility to desktop pools through this server.","example":"[\"tag1\",\"tag2\"]"}},"unauthenticated_access_info":{"$ref":"#/components/schemas/ConnectionServerUnauthenticatedAccessInfo"},"version":{"type":"string","description":"Version attribute to indicate functionalities supported by current connection server.","example":"8.6.0-19754208"}}},"ConnectionServerJWTInfo":{"type":"object","properties":{"jwt_authenticator_ids":{"uniqueItems":true,"type":"array","description":"List of configured JWT authenticators for this Connection Server.","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9","d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"items":{"type":"string","description":"List of configured JWT authenticators for this Connection Server.","example":"[\"42e47f15-aad0-221a-b231-ea4a3a134ec9\",\"d0325b13-2bf1-4fa4-b027-e780004f2d1e\"]"}},"jwt_support":{"type":"string","description":"JWT support option.\n* DISABLED: Indicates that the JWT support is disabled.\n* MULTI_ENABLED: Indicates that the JWT multi-auth support is enabled.\n* MULTI_REQUIRED: Indicates that the JWT multi-auth support is mandatory.","example":"DISABLED","enum":["DISABLED","MULTI_ENABLED","MULTI_REQUIRED"]}},"description":"Information related to connection server JWT authentication settings."},"ConnectionServerJWTSpec":{"type":"object","properties":{"jwt_authenticator_ids":{"uniqueItems":true,"type":"array","description":"List of JWT authenticators to be configured for this Connection Server.","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9","d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"items":{"type":"string","description":"List of JWT authenticators to be configured for this Connection Server.","example":"[\"42e47f15-aad0-221a-b231-ea4a3a134ec9\",\"d0325b13-2bf1-4fa4-b027-e780004f2d1e\"]"}},"jwt_support":{"type":"string","description":"JWT support option. Possible values are \"DISABLED\", \"MULTI_ENABLED\", \"MULTI_REQUIRED\". If not present,default is \"DISABLED\".\n* DISABLED: Indicates that the JWT support is disabled.\n* MULTI_ENABLED: Indicates that the JWT multi-auth support is enabled.\n* MULTI_REQUIRED: Indicates that the JWT multi-auth support is mandatory.","example":"DISABLED","enum":["DISABLED","MULTI_ENABLED","MULTI_REQUIRED"]}},"description":"Settings related to Connection Server JWT authentication"},"ConnectionServerLdapBackupInfo":{"type":"object","properties":{"backup_in_progress":{"type":"boolean"},"frequency_time":{"type":"string","description":"Ldap Backup Frequency.\n* HOUR_1: Backup every 1 hour.\n* HOUR_6: Backup every 6 hours.\n* HOUR_12: Backup every 12 hours.\n* DAY_1: Backup every 1 day.\n* DAY_2: Backup every 2 days.\n* WEEK_1: Backup every 1 week.\n* WEEK_2: Backup every 2 weeks.\n* HOUR_0: Never Backup.","example":"DAY_1","enum":["HOUR_1","HOUR_6","HOUR_12","DAY_1","DAY_2","WEEK_1","WEEK_2","HOUR_0"]},"last_ldap_backup_status":{"type":"string","description":"Last Ldap Backup Status.\n* OK: Indicates that the status is OK.\n* DISK_FULL: Indicates that Disk is full for LDAP to be backed up.\n* UNABLE_TO_CREATE_DIR: Indicates that unable to create directory.\n* VIEW_COMPOSER_BACKUP_FAILED: Indicates that view composer backup failed..\n* ERROR_UNKNOWN: Indicates that the error is unknown.","example":"OK","enum":["OK","DISK_FULL","UNABLE_TO_CREATE_DIR","VIEW_COMPOSER_BACKUP_FAILED","ERROR_UNKNOWN"]},"last_ldap_backup_time":{"type":"integer","description":"Last Ldap Backup Time.","format":"int64","example":1652079610000},"ldap_backup_folder":{"type":"string","description":"Location of the backup folder.","example":"C:\\ProgramData\\Omnissa\\Horizon\\backups"},"max_number":{"type":"integer","description":"Maximum number of backups.","format":"int32","example":10},"time_offset":{"type":"integer","description":"Ldap backup time offset in minutes","format":"int32","example":0}},"description":"Information related to connection server LDAP backup."},"ConnectionServerLdapBackupSpec":{"required":["frequency_time","ldap_backup_folder","max_number","time_offset"],"type":"object","properties":{"frequency_time":{"type":"string","description":"Ldap Backup Frequency.\n* HOUR_1: Backup every 1 hour.\n* HOUR_6: Backup every 6 hours.\n* HOUR_12: Backup every 12 hours.\n* DAY_1: Backup every 1 day.\n* DAY_2: Backup every 2 days.\n* WEEK_1: Backup every 1 week.\n* WEEK_2: Backup every 2 weeks.\n* HOUR_0: Never Backup.","example":"DAY_1","enum":["HOUR_1","HOUR_6","HOUR_12","DAY_1","DAY_2","WEEK_1","WEEK_2","HOUR_0"]},"ldap_backup_folder":{"type":"string","description":"Location of the backup folder.","example":"C:\\ProgramData\\Omnissa\\Horizon\\backups"},"max_number":{"type":"integer","description":"Maximum number of backups.","format":"int32","example":10},"time_offset":{"maximum":59,"minimum":0,"type":"integer","description":"Ldap backup time offset in minutes","format":"int32","example":0}},"description":"Information related to connection server LDAP backup."},"ConnectionServerLdapSchemaMasterInfo":{"type":"object","properties":{"ldap_type":{"type":"string","description":"LDAP Type.\n* LOCAL_LDAP: Local LDAP.\n* GLOBAL_LDAP: Global LDAP.","example":"LOCAL_LDAP","enum":["LOCAL_LDAP","GLOBAL_LDAP"]},"owner":{"type":"string","description":"Current Schema Master owner hostname or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Current Schema Master status.\n* AVAILABLE: Schema master is available.\n* NOT_REACHABLE: Schema master is not reachable.","example":"AVAILABLE","enum":["AVAILABLE","NOT_REACHABLE"]}},"description":"Monitoring information related to Connection Server LDAP Schema Master."},"ConnectionServerMonitorCSReplication":{"type":"object","properties":{"server_name":{"type":"string","description":"Connection Server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"LDAP replication status.\n* OK: The connection to the Connection Server is working properly.\n* ERROR: There is a problem with LDAP replication to the Connection Server.","example":"OK","enum":["OK","ERROR"]}},"description":"Replication status with respect to Peer Connection Servers in the same cluster."},"ConnectionServerMonitorCSReplicationV2":{"type":"object","properties":{"message":{"type":"string","description":"Status message.","example":"status"},"server_name":{"type":"string","description":"Connection Server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"LDAP replication status.\n* OK: The connection to the Connection Server is working properly.\n* ERROR: There is a problem with LDAP replication to the Connection Server.","example":"OK","enum":["OK","ERROR"]}},"description":"Replication status with respect to Peer Connection Servers in the same cluster."},"ConnectionServerMonitorDetails":{"type":"object","properties":{"build":{"type":"string","description":"Connection Server build number.","example":"12345678.0.1"},"version":{"type":"string","description":"Connection Server version number.","example":"7.9.0"}},"description":"Details of the Connection Server."},"ConnectionServerMonitorInfo":{"required":["id"],"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/CertificateMonitorInfo"},"connection_count":{"minimum":0,"type":"integer","description":"Number of connections to this Connection Server.","format":"int32","example":1234},"cs_replications":{"type":"array","description":"Connection Server replication status with respect to the Peer Connection Servers in the same cluster.","items":{"$ref":"#/components/schemas/ConnectionServerMonitorCSReplication"}},"default_certificate":{"type":"boolean","description":"Indicates whether server has the default certificate.","example":false},"details":{"$ref":"#/components/schemas/ConnectionServerMonitorDetails"},"id":{"type":"string","description":"Unique ID of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"name":{"type":"string","description":"Connection Server host name or IP address.","example":"cs1.example.com"},"services":{"type":"array","description":"Connection Server related Windows services information.","items":{"$ref":"#/components/schemas/ConnectionServerMonitorServiceStatus"}},"session_protocol_data":{"type":"array","description":"PCoIP, RDP or BLAST protocol sessions details when clients connect directly to the connection server.","items":{"$ref":"#/components/schemas/ConnectionServerSessionProtocolData"}},"session_threshold":{"type":"integer","description":"The maximum number of connections allowed for the connection server through the Horizon client. If all of the secure gateways (HTTP(S)/PCOIP/BLAST) are enabled, this field denotes the maximum number of connections allowed for the connection server.If none of the secure gateways(HTTP(S)/PCOIP/BLAST) are enabled, sessionThreshold value will not be set.","format":"int32","example":2000},"status":{"type":"string","description":"Status of the Connection Server.\n* OK: The Connection Server is working properly.\n* ERROR: Error occurred when connecting to Connection Server.\n* NOT_RESPONDING: The Connection Server is not responding.\n* UNKNOWN: Status of Connection Server is unknown.\n* RESTART_REQUIRED: Connection Server needs a Restart.","example":"OK","enum":["OK","ERROR","NOT_RESPONDING","UNKNOWN","RESTART_REQUIRED"]},"tunnel_connection_count":{"minimum":0,"type":"integer","description":"Number of connections tunneled through this Connection Server.","format":"int32","example":1234}},"description":"Monitoring information related to Connection Server."},"ConnectionServerMonitorInfoV2":{"required":["id"],"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/CertificateMonitorInfo"},"connection_count":{"minimum":0,"type":"integer","description":"Number of connections to this Connection Server.","format":"int32","example":1234},"cs_replications":{"type":"array","description":"Connection Server replication status with respect to the Peer Connection Servers in the same cluster.","items":{"$ref":"#/components/schemas/ConnectionServerMonitorCSReplication"}},"default_certificate":{"type":"boolean","description":"Indicates whether server has the default certificate.","example":false},"details":{"$ref":"#/components/schemas/ConnectionServerMonitorDetails"},"id":{"type":"string","description":"Unique ID of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Connection Server host name or IP address.","example":"cs1.example.com"},"services":{"type":"array","description":"Connection Server related Windows services information.","items":{"$ref":"#/components/schemas/ConnectionServerMonitorServiceStatus"}},"session_protocol_data":{"type":"array","description":"PCoIP, RDP or BLAST protocol sessions details when clients connect directly to the connection server.","items":{"$ref":"#/components/schemas/ConnectionServerSessionProtocolData"}},"session_threshold":{"type":"integer","description":"The maximum number of connections allowed for the connection server through the Horizon client. If all of the secure gateways (HTTP(S)/PCOIP/BLAST) are enabled, this field denotes the maximum number of connections allowed for the connection server.If none of the secure gateways(HTTP(S)/PCOIP/BLAST) are enabled, sessionThreshold value will not be set.","format":"int32","example":2000},"status":{"type":"string","description":"Status of the Connection Server.\n* OK: The Connection Server is working properly.\n* ERROR: Error occurred when connecting to Connection Server.\n* NOT_RESPONDING: The Connection Server is not responding.\n* UNKNOWN: Status of Connection Server is unknown.\n* RESTART_REQUIRED: Connection Server needs a Restart.","example":"OK","enum":["OK","ERROR","NOT_RESPONDING","UNKNOWN","RESTART_REQUIRED"]},"tunnel_connection_count":{"minimum":0,"type":"integer","description":"Number of connections tunneled through this Connection Server.","format":"int32","example":1234}},"description":"Monitoring information related to Connection Server."},"ConnectionServerMonitorInfoV3":{"required":["id"],"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/CertificateMonitorInfo"},"connection_count":{"minimum":0,"type":"integer","description":"Number of connections to this Connection Server.","format":"int32","example":1234},"cs_replications":{"type":"array","description":"Connection Server replication status with respect to the Peer Connection Servers in the same cluster.","items":{"$ref":"#/components/schemas/ConnectionServerMonitorCSReplication"}},"default_certificate":{"type":"boolean","description":"Indicates whether server has the default certificate.","example":false},"details":{"$ref":"#/components/schemas/ConnectionServerMonitorDetails"},"id":{"type":"string","description":"Unique ID of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Connection Server host name or IP address.","example":"cs1.example.com"},"services":{"type":"array","description":"Connection Server related Windows services information.","items":{"$ref":"#/components/schemas/ConnectionServerMonitorServiceStatus"}},"session_protocol_data":{"type":"array","description":"PCoIP, RDP or BLAST protocol sessions details when clients connect directly to the connection server.","items":{"$ref":"#/components/schemas/ConnectionServerSessionProtocolData"}},"session_threshold":{"type":"integer","description":"The maximum number of connections allowed for the connection server through the Horizon client. If all of the secure gateways (HTTP(S)/PCOIP/BLAST) are enabled, this field denotes the maximum number of connections allowed for the connection server.If none of the secure gateways(HTTP(S)/PCOIP/BLAST) are enabled, sessionThreshold value will not be set.","format":"int32","example":2000},"status":{"type":"string","description":"Status of the Connection Server.\n* OK: The Connection Server is working properly.\n* ERROR: Error occurred when connecting to Connection Server.\n* NOT_RESPONDING: The Connection Server is not responding.\n* UNKNOWN: Status of Connection Server is unknown.\n* RESTART_REQUIRED: Connection Server needs a Restart.","example":"OK","enum":["OK","ERROR","NOT_RESPONDING","UNKNOWN","RESTART_REQUIRED"]},"tunnel_connection_count":{"minimum":0,"type":"integer","description":"Number of connections tunneled through this Connection Server.","format":"int32","example":1234},"unrecognized_pcoip_requests_count":{"type":"integer","description":"Number of unrecognized PCoIP secure gateway requests.","format":"int32","example":3},"unrecognized_tunnel_requests_count":{"type":"integer","description":"Number of unrecognized tunnel requests.","format":"int32","example":4},"unrecognized_xmlapi_requests_count":{"type":"integer","description":"Number of unrecognized XML API requests.","format":"int32","example":5}},"description":"Monitoring information related to Connection Server."},"ConnectionServerMonitorInfoV4":{"required":["id"],"type":"object","properties":{"avg_disk_sec_per_read":{"type":"integer","description":"Average time, in seconds, of a read of data from the disk.","format":"int32","example":0},"avg_disk_sec_per_write":{"type":"integer","description":"Average time, in seconds, of a write of data to the disk.","format":"int32","example":0},"broker_free_memory":{"type":"integer","description":"Total physical memory available, in MB.","format":"int32","example":4644},"broker_total_memory":{"type":"integer","description":"Total physical memory installed, in MB.","format":"int32","example":8387},"bypass_app_blast_gateway":{"type":"boolean","description":"Indicates whether a bypassing blast secure gateway is enabled for this connection server instance.\r\nIf this is set to true, web browsers make direct connections to Horizon machines bypassing connection server.","example":false},"bypass_pcoip_gateway":{"type":"boolean","description":"Indicates whether the PCoIP traffic bypasses the secure gateway.","example":true},"bypass_tunnel":{"type":"boolean","description":"Indicates whether a secure tunnel on this connection server instance is enabled.\r\nIf this is set to false, a secure tunnel on this Connection Server instance is enabled and horizon clents can connect to desktop pools through the secure tunnel,\r\nwhich carries RDP and other data over HTTPS. PCoIP and HTML Access connections use separate secure gateways.","example":false},"certificate":{"$ref":"#/components/schemas/CertificateMonitorInfoV2"},"connection_count":{"minimum":0,"type":"integer","description":"Number of connections to this Connection Server.","format":"int32","example":1234},"connection_count_high":{"minimum":0,"type":"integer","description":"The high water mark of connections to this connection server.","format":"int32","example":6},"cpu_usage_percentage":{"type":"integer","description":"Percentage of the CPU being used.","format":"int32","example":60},"cs_replications_v2":{"type":"array","description":"Connection Server replication status with respect to the Peer Connection Servers in the same cluster.","items":{"$ref":"#/components/schemas/ConnectionServerMonitorCSReplicationV2"}},"default_certificate":{"type":"boolean","description":"Indicates whether server has the default certificate.","example":false},"default_unauthenticated_access_user":{"type":"string","description":"Default username for unauthenticated access.","example":"testUser"},"details":{"$ref":"#/components/schemas/ConnectionServerMonitorDetails"},"disk_iops":{"type":"integer","description":"Rate of read and write operations on the disk.","format":"int32","example":0},"disk_queue_length":{"type":"integer","description":"Number of requests outstanding on the disk.","format":"int32","example":0},"encryption_certificate":{"$ref":"#/components/schemas/CertificateMonitorInfoV2"},"guest_support":{"$ref":"#/components/schemas/VMToolsInfo"},"id":{"type":"string","description":"Unique ID of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"memory_pages_input_per_sec":{"type":"integer","description":"Rate at which pages are read from disk to resolve hard page faults.","format":"int32","example":0},"memory_pages_output_per_sec":{"type":"integer","description":"Rate at which pages are written to disk to free up space in physical memory.A high rate of pages output might indicate a memory shortage.","format":"int32","example":0},"memory_usage_percentage":{"type":"integer","description":"Percentage of the memory being used.","format":"int32","example":60},"name":{"type":"string","description":"Connection Server host name or IP address.","example":"cs1.example.com"},"num_bsg_sessions":{"minimum":0,"type":"integer","description":"The number of Blast Secure Gateway sessions.","format":"int32","example":2},"num_psg_sessions":{"minimum":0,"type":"integer","description":"The number of PCoIP Secure Gateway sessions.","format":"int32","example":2},"num_rdp_gatewayed_sessions":{"minimum":0,"type":"integer","description":"The number of Secure Gateway sessions with the RDP.","format":"int32","example":2},"os_version":{"type":"string","description":"OS version of Connection server VM.","example":"Windows Server 2019 Standard"},"proc_queue_length":{"type":"integer","description":"Number of threads in the processor queue.This counter shows ready threads only, not threads that are running.","format":"int32","example":0},"services":{"type":"array","description":"Connection Server related Windows services information.","items":{"$ref":"#/components/schemas/ConnectionServerMonitorServiceStatus"}},"session_protocol_data":{"type":"array","description":"PCoIP, RDP or BLAST protocol sessions details when clients connect directly to the connection server.","items":{"$ref":"#/components/schemas/ConnectionServerSessionProtocolData"}},"session_threshold":{"type":"integer","description":"The maximum number of connections allowed for the connection server through the Horizon client. If all of the secure gateways (HTTP(S)/PCOIP/BLAST) are enabled, this field denotes the maximum number of connections allowed for the connection server.If none of the secure gateways(HTTP(S)/PCOIP/BLAST) are enabled, sessionThreshold value will not be set.","format":"int32","example":2000},"signing_certificate":{"$ref":"#/components/schemas/CertificateMonitorInfoV2"},"status":{"type":"string","description":"Status of the Connection Server.\n* OK: The Connection Server is working properly.\n* ERROR: Error occurred when connecting to Connection Server.\n* NOT_RESPONDING: The Connection Server is not responding.\n* UNKNOWN: Status of Connection Server is unknown.\n* RESTART_REQUIRED: Connection Server needs a Restart.","example":"OK","enum":["OK","ERROR","NOT_RESPONDING","UNKNOWN","RESTART_REQUIRED"]},"tunnel_connection_count":{"minimum":0,"type":"integer","description":"Number of connections tunneled through this Connection Server.","format":"int32","example":1234},"unauthenticated_access":{"type":"boolean","description":"Whether unauthenticated access is enabled.","example":false},"unrecognized_blast_requests_count":{"type":"integer","description":"Number of unrecognized Blast Secure Gateway requests.","format":"int32","example":3},"unrecognized_pcoip_requests_count":{"type":"integer","description":"Number of unrecognized PCoIP secure gateway requests.","format":"int32","example":3},"unrecognized_tunnel_requests_count":{"type":"integer","description":"Number of unrecognized tunnel requests.","format":"int32","example":4},"unrecognized_xmlapi_requests_count":{"type":"integer","description":"Number of unrecognized XML API requests.","format":"int32","example":5}},"description":"Monitoring information related to Connection Server."},"ConnectionServerMonitorServiceStatus":{"type":"object","properties":{"service_name":{"type":"string","description":"Service name of the Connection Server.\n* PCOIP_SECURE_GATEWAY: PCoIP Secure Gateway service.\n* BLAST_SECURE_GATEWAY: BLAST Secure Gateway service.\n* SECURITY_GATEWAY_COMPONENT: Security Gateway Component service.\n* CRL_PREFETCH: CRL prefetch service","example":"BLAST_SECURE_GATEWAY","enum":["PCOIP_SECURE_GATEWAY","BLAST_SECURE_GATEWAY","SECURITY_GATEWAY_COMPONENT","CRL_PREFETCH"]},"status":{"type":"string","description":"Status of the service.\n* UP: The Windows service is UP and running.\n* DOWN: The Windows service is not UP.\n* NOT_IN_USE: The Windows service is disabled.\n* UNKNOWN: The Windows service state is Unknown.","example":"UP","enum":["UP","DOWN","NOT_IN_USE","UNKNOWN"]}},"description":"Status of Connection Server related Windows service."},"ConnectionServerRADIUSInfo":{"type":"object","properties":{"radius_authenticator_id":{"type":"string","description":"The RADIUS Authenticator to use.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"radius_enabled":{"type":"boolean","description":"Flag to specify if RADIUS authentication is enabled.","example":false},"radius_name_mapping":{"type":"boolean","description":"Flag to specify if RADIUS name mapping is enabled.","example":false},"radius_sso":{"type":"boolean","description":"Flag to specify if RADIUS Windows Single Sign-On is enabled.","example":false}},"description":"Information related to connection server RADIUS authentication settings."},"ConnectionServerRADIUSSpec":{"required":["radius_enabled"],"type":"object","properties":{"radius_authenticator_id":{"type":"string","description":"The RADIUS Authenticator to use.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"radius_enabled":{"type":"boolean","description":"Indicates whether RADIUS authentication is enabled.","example":false},"radius_name_mapping":{"type":"boolean","description":"Indicates whether RADIUS name mapping is enabled.","example":false},"radius_sso":{"type":"boolean","description":"Indicates whether RADIUS Windows Single Sign-On is enabled.","example":false}},"description":"Information related to connection server RADIUS authentication settings."},"ConnectionServerRSASecureIdInfo":{"type":"object","properties":{"clear_node_secret":{"type":"boolean","description":"When set to TRUE the SecureID node secret is cleared","example":false},"name_mapping":{"type":"boolean","description":"Indicates how SecureID names map to AD usernames. It is false for not mapped.","example":false},"secure_id_enabled":{"type":"boolean","description":"Indicates whether SecureID authentication is required.","example":false},"security_file_uploaded":{"type":"boolean","description":"If SecureID sdconf.rec file is already uploaded. The client can never download the file.","example":false}},"description":"Information related to Connection server RSA SecureId authentication settings."},"ConnectionServerRSASecureIdSpec":{"required":["secure_id_enabled"],"type":"object","properties":{"clear_node_secret":{"type":"boolean","description":"When set to TRUE the SecureID node secret is cleared","example":false},"name_mapping":{"type":"boolean","description":"Indicates how SecureID names map to AD usernames. It is false for not mapped.","example":false},"secure_id_enabled":{"type":"boolean","description":"Indicates whether SecureID authentication is required.","example":false},"security_file_data":{"type":"string","format":"byte"}},"description":"Information related to Connection server RSA SecureId authentication settings."},"ConnectionServerSAMLInfo":{"type":"object","properties":{"saml_authenticator_ids":{"type":"array","description":"List of SamlAuthenticators to use.","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9","d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"items":{"type":"string","description":"List of SamlAuthenticators to use.","example":"[\"42e47f15-aad0-221a-b231-ea4a3a134ec9\",\"d0325b13-2bf1-4fa4-b027-e780004f2d1e\"]"}},"saml_support":{"type":"string","description":"SAML support option.\n* DISABLED: Indicates that the SAML support is disabled.\n* MULTI_ENABLED: Indicates that the SAML multi auth support is enabled.\n* MULTI_REQUIRED: Indicates that the SAML multi auth support is mandatory.","example":"DISABLED","enum":["DISABLED","MULTI_ENABLED","MULTI_REQUIRED"]},"workspace_one_block_old_clients":{"type":"boolean","description":"Block old clients that don't support Workspace ONE mode.","example":false},"workspace_one_host_name":{"type":"string","description":"The hostname of the Workspace ONE Server.","example":"workspaceone.com"},"workspace_one_mode_enabled":{"type":"boolean","description":"Indicates whether Workspace ONE mode is enabled.","example":false}},"description":"Information related to connection server SAML authentication settings."},"ConnectionServerSAMLInfoV2":{"type":"object","properties":{"saml_auth_redirect_authenticator_id":{"type":"string","description":"This will be used to indicate which particular Authenticator user should redirect in case of Service Provider Initiated Saml Auth. ","example":"8e2b4136-829c-11eb-8dcd-0242ac130003"},"saml_authenticator_ids":{"type":"array","description":"List of SamlAuthenticators to use.","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9","d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"items":{"type":"string","description":"List of SamlAuthenticators to use.","example":"[\"42e47f15-aad0-221a-b231-ea4a3a134ec9\",\"d0325b13-2bf1-4fa4-b027-e780004f2d1e\"]"}},"saml_support":{"type":"string","description":"SAML support option.\n* DISABLED: Indicates that the SAML support is disabled.\n* MULTI_ENABLED: Indicates that the SAML multi auth support is enabled.\n* MULTI_REQUIRED: Indicates that the SAML multi auth support is mandatory.","example":"DISABLED","enum":["DISABLED","MULTI_ENABLED","MULTI_REQUIRED"]}},"description":"Information related to connection server SAML authentication settings which Support all the IDP including WorkspaceOne."},"ConnectionServerSAMLSpec":{"required":["saml_support"],"type":"object","properties":{"saml_authenticator_ids":{"uniqueItems":true,"type":"array","description":"List of SamlAuthenticators to use.","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9","d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"items":{"type":"string","description":"List of SamlAuthenticators to use.","example":"[\"42e47f15-aad0-221a-b231-ea4a3a134ec9\",\"d0325b13-2bf1-4fa4-b027-e780004f2d1e\"]"}},"saml_support":{"type":"string","description":"Indicates SAML support option configuration for the end user\n* DISABLED: Indicates that the SAML support is disabled.\n* MULTI_ENABLED: Indicates that the SAML multi auth support is enabled.\n* MULTI_REQUIRED: Indicates that the SAML multi auth support is mandatory.","example":"DISABLED","enum":["DISABLED","MULTI_ENABLED","MULTI_REQUIRED"]},"workspace_one_block_old_clients":{"type":"boolean","description":"Indicates whether old clients that don't support Workspace ONE mode are blocked.","example":false},"workspace_one_host_name":{"type":"string","description":"The hostname of the Workspace ONE Server.","example":"workspaceone.com"},"workspace_one_mode_enabled":{"type":"boolean","description":"Indicates whether Workspace ONE mode is enabled.","example":false}},"description":"Information related to connection server SAML authentication settings."},"ConnectionServerSAMLSpecV2":{"required":["saml_support"],"type":"object","properties":{"saml_auth_redirect_authenticator_id":{"type":"string","description":"This is required field when SAML mode is set to REQUIRED. This will be used to indicate which particular Authenticator user should redirect in case of Service Provider Initiated Saml Auth. ","example":"8e2b4136-829c-11eb-8dcd-0242ac130003"},"saml_authenticator_ids":{"uniqueItems":true,"type":"array","description":"List of SamlAuthenticators to use.","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9","d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"items":{"type":"string","description":"List of SamlAuthenticators to use.","example":"[\"42e47f15-aad0-221a-b231-ea4a3a134ec9\",\"d0325b13-2bf1-4fa4-b027-e780004f2d1e\"]"}},"saml_support":{"type":"string","description":"Indicates SAML support option configuration for the end user\n* DISABLED: Indicates that the SAML support is disabled.\n* MULTI_ENABLED: Indicates that the SAML multi auth support is enabled.\n* MULTI_REQUIRED: Indicates that the SAML multi auth support is mandatory.","example":"DISABLED","enum":["DISABLED","MULTI_ENABLED","MULTI_REQUIRED"]}},"description":"Information related to connection server SAML authentication settings."},"ConnectionServerSessionProtocolData":{"type":"object","properties":{"session_count":{"type":"integer","description":"Number of active sessions launched using the protocol.","format":"int32","example":341},"session_protocol":{"type":"string","description":"Protocol used in launching the session.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"BLAST","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]}},"description":"Details of connected session count for each session protocol."},"ConnectionServerStatus":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the connection server to which this status pertains.","example":"c617fd51-e118-4cae-970c-54a7144aaadc"},"message":{"type":"string","description":"The CPA error message for the connection server if any, is populated, or a success message.","example":"OK"},"message_code":{"type":"string","description":"Message code of the message.\n* LMV_OP_OK: Pod Federation operation is successful.\n* LMV_OP_ERROR: Pod Federation operation failed.\n* LMV_OP_ERROR_UNKNOWN: Pod Federation operation failed with unknown error.\n* LMV_OP_CANNOT_APPLY_DATA: Pod Federation operation could not apply data.\n* LMV_OP_CANNOT_APPLY_SCHEMA: Pod Federation operation could not apply schema.\n* LMV_OP_FILESYSTEM_ERROR: Pod Federation operation encountered file system error.\n* LMV_OP_NO_TIME_SYNC: Pod Federation operation encountered time synchronization error.\n* LMV_OP_NO_PERMISSION: No permission to perform Pod Federation operation.\n* LMV_OP_REPLICATION_ERROR: Pod Federation operation encountered replication error.\n* LMV_OP_UNREACHABLE_SERVER: The server is unreachable to perform Pod Federation operation.","example":"LMV_OP_OK","enum":["LMV_OP_OK","LMV_OP_ERROR","LMV_OP_ERROR_UNKNOWN","LMV_OP_CANNOT_APPLY_DATA","LMV_OP_CANNOT_APPLY_SCHEMA","LMV_OP_FILESYSTEM_ERROR","LMV_OP_NO_TIME_SYNC","LMV_OP_NO_PERMISSION","LMV_OP_REPLICATION_ERROR","LMV_OP_UNREACHABLE_SERVER"]},"name":{"type":"string","description":"Name of the connection server.","example":"CS1"},"pending_percentage":{"type":"integer","description":" Value between 0 and 100 representing CPA operation completion percentage when connection server status is pending.","format":"int32","example":80},"status":{"type":"string","description":"CPA status of the connection server.\n* ENABLED: CPA is enabled.\n* DISABLED: CPA is disabled.\n* PENDING: CPA is undergoing an operation related to initialization, uninitialization, joining, or unjoining.\n* ENABLE_ERROR: The connection server has failed to reach the ENABLED status in a timely manner. This may also indicate the current connection server was recently installed.\n* DISABLE_ERROR: The connection server has failed to reach the DISABLED status in a timely manner.","example":"ENABLED","enum":["ENABLED","DISABLED","PENDING","ENABLE_ERROR","DISABLE_ERROR"]}},"description":"CPA status for a connection server."},"ConnectionServerUnauthenticatedAccessInfo":{"type":"object","properties":{"block_unsupported_clients":{"type":"boolean","description":"Block older clients which don't support client puzzles\r\nto prevent DOS attack on RDSH servers for Unauthenticated Access.","example":false},"client_puzzle_difficulty":{"type":"integer","description":"Client puzzle difficulty for DoS attack prevention for Unauthenticated Access.\r\nHigher difficulty might increase login time and affect user experience.","format":"int32","example":21},"default_unauth_user_id":{"type":"string","description":"Default user for unauthenticated access in this connection server.","example":"11bd230b-87ce-3306-a943-810affe7b68a"},"enabled":{"type":"boolean","description":"Indicates whether unauthenticated access is enabled in this connection server.","example":false},"user_idle_timeout":{"type":"integer","description":"Unauthenticated Access user idle session timeout in minutes.","format":"int32","example":10}},"description":"Information related to connection server unauthenticated access settings."},"ConnectionServerUnauthenticatedAccessSpec":{"required":["enabled"],"type":"object","properties":{"block_unsupported_clients":{"type":"boolean","description":"Block older clients which don't support client puzzles\r\nto prevent DOS attack on RDSH servers for Unauthenticated Access.","example":false},"client_puzzle_difficulty":{"maximum":31,"minimum":14,"type":"integer","description":"Client puzzle difficulty for DoS attack prevention for Unauthenticated Access.\r\nHigher difficulty might increase login time and affect user experience. This property has a default value of 21","format":"int32","example":21},"default_unauth_user_id":{"type":"string","description":"Default user for unauthenticated access in this connection server.","example":"11bd230b-87ce-3306-a943-810affe7b68a"},"enabled":{"type":"boolean","description":"Indicates whether unauthenticated access is enabled in this connection server.","example":false},"user_idle_timeout":{"maximum":1440,"minimum":1,"type":"integer","description":"Unauthenticated Access user idle session timeout in minutes.","format":"int32","example":10}},"description":"Information related to connection server unauthenticated access settings."},"ConnectionServerUpdateSpec":{"required":["jwt_info"],"type":"object","properties":{"jwt_info":{"$ref":"#/components/schemas/ConnectionServerJWTSpec"}},"description":"Connection Server object whose settings need to be updated."},"ConnectionServerUpdateSpecV2":{"required":["bypass_app_blast_gateway","bypass_pcoip_gateway","bypass_tunnel","disclose_service_principal_name","enabled","gss_apiinfo","host_redirection","jwt_info","ldap_backup_info","radius_info","rsa_secure_id_info","saml_info","smart_card_support","smart_card_support_for_admin","unauthenticated_access_info"],"type":"object","properties":{"auxillary_external_pcoip_ipv4_address":{"type":"string","description":"This can be set only if external_pcoip_url is set and contains a host part that represents an IPv6 address or DNS name.\r\nAs legacy clients may not support IPv6 or DNS names for external PCoIP URLs, this IPv4 address, if set, will be presented to them as an alternative. The same port will be used and should not be specified.\r\nIf bypass_pcoip_gateway is set to true, this property will be ignored.","example":"127.0.0.1:4172"},"bypass_app_blast_gateway":{"type":"boolean","description":"Indicates whether a bypassing blast secure gateway is enabled for this connection server instance.\r\nIf this is set to true, web browsers make direct connections to Horizon machines bypassing connection server.","example":false},"bypass_pcoip_gateway":{"type":"boolean","description":"Indicates whether the PCoIP traffic bypasses the secure gateway.","example":true},"bypass_tunnel":{"type":"boolean","description":"Indicates whether a secure tunnel on this connection server instance is enabled.\r\nIf this is set to false, a secure tunnel on this Connection Server instance is enabled and horizon clents can connect to desktop pools through the secure tunnel,\r\nwhich carries RDP and other data over HTTPS. PCoIP and HTML Access connections use separate secure gateways.","example":false},"direct_htmlabsg":{"type":"boolean","description":"Indicates whether only HTML clients use blast secure gateway for this connection server instance.\r\nThis property will not be set if bypass_appblast_gateway is set to false.","example":false},"disclose_service_principal_name":{"type":"boolean","description":"Indicates whether the connection server's service principal name will be sent to the client prior to the user authentication.When set to true Connection Server discloses its service principal name to the client.","example":false},"enable_smart_card_user_name_hint":{"type":"boolean","description":"Indicates whether username hints for smart card is enabled.","example":false},"enabled":{"type":"boolean","description":"Indicate whether the connection server is enabled. A disabled connection server will not accept connection requests from Horizon Clients.","example":true},"external_appblast_url":{"type":"string","description":"The Blast External URL enables browser access to Horizon machines through this connection server instance.\r\nTo enable Blast, you must install HTML Access.\r\nThe Blast External URL must not be load balanced.\r\nIf bypass_appblast_gateway is set to true, this property will be ignored.","example":"https://cs1.example.com:8443"},"external_pcoip_url":{"type":"string","description":"Horizon Clients use the PCoIP External URL to establish a PCoIP connection through this Connection Server instance.\r\nThe PCoIP External URL must not be load balanced.\r\nIf bypass_pcoip_gateway is set to true, this property will be ignored.","example":"127.0.0.1:4172"},"external_url":{"type":"string","description":"Horizon Clients use the External URL to establish a secure tunnel to this Connection Server instance.\r\nIf a server name is specified, it must be resolvable by each Horizon Client.\r\nThe External URL must not be load balanced.\r\nIf bypass_tunnel is set to true, this property will be ignored.","example":"https://cs1.example.com:443"},"gss_apiinfo":{"$ref":"#/components/schemas/ConnectionServerGSSAPISpec"},"host_redirection":{"type":"boolean","description":"Indicates whether connection server supports HTTP host redirection.","example":false},"jwt_info":{"$ref":"#/components/schemas/ConnectionServerJWTSpec"},"ldap_backup_info":{"$ref":"#/components/schemas/ConnectionServerLdapBackupSpec"},"logoff_when_remove_smart_card":{"type":"boolean","description":"Indicates whether user is logged off on removal of Smart Card.","example":false},"radius_info":{"$ref":"#/components/schemas/ConnectionServerRADIUSSpec"},"rsa_secure_id_info":{"$ref":"#/components/schemas/ConnectionServerRSASecureIdSpec"},"saml_info":{"$ref":"#/components/schemas/ConnectionServerSAMLSpec"},"smart_card_support":{"type":"string","description":"Indicates whether the smart card is supported for client or not\n* OPTIONAL: Indicates that the SmartCard usage is optional.\n* REQUIRED: Indicates that the SmartCard usage is necessary.\n* OFF: Indicates that the SmartCard usage is not allowed.","example":"OFF","enum":["OPTIONAL","REQUIRED","OFF"]},"smart_card_support_for_admin":{"type":"string","description":"Indicates Smart card authentication configuration for administrators to login.\n* OPTIONAL: Indicates that the SmartCard usage is optional.\n* REQUIRED: Indicates that the SmartCard usage is necessary.\n* OFF: Indicates that the SmartCard usage is not allowed.","example":"OPTIONAL","enum":["OPTIONAL","REQUIRED","OFF"]},"tags":{"uniqueItems":true,"type":"array","description":"Tags to restrict accessibility to desktop pools through this server.","example":["tag1","tag2"],"items":{"type":"string","description":"Tags to restrict accessibility to desktop pools through this server.","example":"[\"tag1\",\"tag2\"]"}},"unauthenticated_access_info":{"$ref":"#/components/schemas/ConnectionServerUnauthenticatedAccessSpec"}},"description":"Connection Server object whose settings need to be updated."},"ConnectionServerUpdateSpecV3":{"required":["bypass_app_blast_gateway","bypass_pcoip_gateway","bypass_tunnel","disclose_service_principal_name","enabled","gss_apiinfo","host_redirection","jwt_info","ldap_backup_info","radius_info","rsa_secure_id_info","saml_info","smart_card_support","smart_card_support_for_admin","unauthenticated_access_info"],"type":"object","properties":{"auxillary_external_pcoip_ipv4_address":{"type":"string","description":"This can be set only if external_pcoip_url is set and contains a host part that represents an IPv6 address or DNS name.\r\nAs legacy clients may not support IPv6 or DNS names for external PCoIP URLs, this IPv4 address, if set, will be presented to them as an alternative. The same port will be used and should not be specified.\r\nIf bypass_pcoip_gateway is set to true, this property will be ignored.","example":"127.0.0.1:4172"},"bypass_app_blast_gateway":{"type":"boolean","description":"Indicates whether a bypassing blast secure gateway is enabled for this connection server instance.\r\nIf this is set to true, web browsers make direct connections to Horizon machines bypassing connection server.","example":false},"bypass_pcoip_gateway":{"type":"boolean","description":"Indicates whether the PCoIP traffic bypasses the secure gateway.","example":true},"bypass_tunnel":{"type":"boolean","description":"Indicates whether a secure tunnel on this connection server instance is enabled.\r\nIf this is set to false, a secure tunnel on this Connection Server instance is enabled and horizon clents can connect to desktop pools through the secure tunnel,\r\nwhich carries RDP and other data over HTTPS. PCoIP and HTML Access connections use separate secure gateways.","example":false},"direct_htmlabsg":{"type":"boolean","description":"Indicates whether only HTML clients use blast secure gateway for this connection server instance.\r\nThis property will not be set if bypass_appblast_gateway is set to false.","example":false},"disclose_service_principal_name":{"type":"boolean","description":"Indicates whether the connection server's service principal name will be sent to the client prior to the user authentication.When set to true Connection Server discloses its service principal name to the client.","example":false},"enable_smart_card_user_name_hint":{"type":"boolean","description":"Indicates whether username hints for smart card is enabled.","example":false},"enabled":{"type":"boolean","description":"Indicate whether the connection server is enabled. A disabled connection server will not accept connection requests from Horizon Clients.","example":true},"external_appblast_url":{"type":"string","description":"The Blast External URL enables browser access to Horizon machines through this connection server instance.\r\nTo enable Blast, you must install HTML Access.\r\nThe Blast External URL must not be load balanced.\r\nIf bypass_appblast_gateway is set to true, this property will be ignored.","example":"https://cs1.example.com:8443"},"external_pcoip_url":{"type":"string","description":"Horizon Clients use the PCoIP External URL to establish a PCoIP connection through this Connection Server instance.\r\nThe PCoIP External URL must not be load balanced.\r\nIf bypass_pcoip_gateway is set to true, this property will be ignored.","example":"127.0.0.1:4172"},"external_url":{"type":"string","description":"Horizon Clients use the External URL to establish a secure tunnel to this Connection Server instance.\r\nIf a server name is specified, it must be resolvable by each Horizon Client.\r\nThe External URL must not be load balanced.\r\nIf bypass_tunnel is set to true, this property will be ignored.","example":"https://cs1.example.com:443"},"gss_apiinfo":{"$ref":"#/components/schemas/ConnectionServerGSSAPISpec"},"host_redirection":{"type":"boolean","description":"Indicates whether connection server supports HTTP host redirection.","example":false},"jwt_info":{"$ref":"#/components/schemas/ConnectionServerJWTSpec"},"ldap_backup_info":{"$ref":"#/components/schemas/ConnectionServerLdapBackupSpec"},"load_balancer_hosts":{"type":"array","description":"List of load balancer host names or IP address.","example":["10.217.68.253","10.217.68.254"],"items":{"type":"string","description":"List of load balancer host names or IP address.","example":"[\"10.217.68.253\",\"10.217.68.254\"]"}},"logoff_when_remove_smart_card":{"type":"boolean","description":"Indicates whether user is logged off on removal of Smart Card.","example":false},"radius_info":{"$ref":"#/components/schemas/ConnectionServerRADIUSSpec"},"rsa_secure_id_info":{"$ref":"#/components/schemas/ConnectionServerRSASecureIdSpec"},"saml_info":{"$ref":"#/components/schemas/ConnectionServerSAMLSpecV2"},"smart_card_support":{"type":"string","description":"Indicates whether the smart card is supported for client or not\n* OPTIONAL: Indicates that the SmartCard usage is optional.\n* REQUIRED: Indicates that the SmartCard usage is necessary.\n* OFF: Indicates that the SmartCard usage is not allowed.","example":"OFF","enum":["OPTIONAL","REQUIRED","OFF"]},"smart_card_support_for_admin":{"type":"string","description":"Indicates Smart card authentication configuration for administrators to login.\n* OPTIONAL: Indicates that the SmartCard usage is optional.\n* REQUIRED: Indicates that the SmartCard usage is necessary.\n* OFF: Indicates that the SmartCard usage is not allowed.","example":"OPTIONAL","enum":["OPTIONAL","REQUIRED","OFF"]},"tags":{"uniqueItems":true,"type":"array","description":"Tags to restrict accessibility to desktop pools through this server.","example":["tag1","tag2"],"items":{"type":"string","description":"Tags to restrict accessibility to desktop pools through this server.","example":"[\"tag1\",\"tag2\"]"}},"unauthenticated_access_info":{"$ref":"#/components/schemas/ConnectionServerUnauthenticatedAccessSpec"}},"description":"Connection Server object whose settings need to be updated."},"ContainsFilter":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseFilter"},{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"object"}}}],"required":["name","type","value"]},"CsrGenerateResponseInfo":{"type":"object","properties":{"csr":{"type":"string","description":"Generated CSR.","example":"MIIC8DCCAdgCAQAwfDF6MHgGA1UEAxNxqRkDxR4gWqAoe26YU1S4...XRdFpQPhpkDRQ13yeO+oq"}},"description":"Response for generate CSR operation."},"CsrSpec":{"required":["certificate_usage","subject_name"],"type":"object","properties":{"certificate_usage":{"type":"string","description":"Indicates the type of certificate based on usage.\n* MACHINE: vdm certificates\n* CLUSTER: vdm.ec certificates\n* CLUSTER_ENCRYPTION: vdm.enc certificates\n* EXTERNAL: vdm.ext certificates\n* SAML_SIGNING: saml.sig certificates\n* SAML_ENCRYPTION: saml.enc certificates","example":"MACHINE","enum":["MACHINE","CLUSTER","CLUSTER_ENCRYPTION","EXTERNAL","SAML_SIGNING","SAML_ENCRYPTION"]},"dns_subject_alternative_names":{"uniqueItems":true,"type":"array","description":"Subject alternative DNS names. If the 'certificateUsage' is set to 'CLUSTER', the cluster GUID can be provided in this field. If the cluster GUID is not provided in 'dnsSubjectAlternativeNames', the CSR generation process will automatically append it, along with the value provided in dnsSubjectAlternativeNames","example":["server.example.com","www.omnissa.com"],"items":{"type":"string","description":"Subject alternative DNS names. If the 'certificateUsage' is set to 'CLUSTER', the cluster GUID can be provided in this field. If the cluster GUID is not provided in 'dnsSubjectAlternativeNames', the CSR generation process will automatically append it, along with the value provided in dnsSubjectAlternativeNames","example":"[\"server.example.com\",\"www.omnissa.com\"]"}},"subject_name":{"type":"string","description":"Subject name. If the 'certificateUsage' is set to 'CLUSTER', the cluster GUID can be provided in this field. If the cluster GUID is not provided in the subject name, the CSR generation process will automatically append the cluster GUID to the 'dnsSubjectAlternativeNames' field, ensuring that the generated CSR is specific to the cluster and does not conflict with other clusters.","example":"CN=Horizon-server.example.local, OU=Omnissa Horizon View default certificate, O=Omnissa, S=California, C=CALIFORNIA"}},"description":"CSR Spec."},"CustomizationSettings":{"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Full Clone Active Directory container for ClonePrep and SysPrep respectively.\nThis property can be used for sorting.","example":"CN=Computers"},"ad_site_name":{"type":"string","description":"Indicatest the name of the AD Site.","example":"Default-First-Site-Name"},"compute_profile_id":{"type":"string","description":"Indicates the compute profile.<br>Supported Filters: 'Equals'.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"compute_profile_name":{"type":"string","description":"Indicates the name of compute profile","example":"computeProfile-name"},"custom_spec_name":{"type":"string","description":"Indicates the name of custom spec","example":"custom-spec-1"},"customization_type":{"type":"string","description":"Type of customization to use.\nThis property can be used for sorting.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"SYS_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"domain_account_id":{"type":"string","description":"Applicable To :Full clone desktop pools.<br> This is required for full clone desktop pools.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"domain_name":{"type":"string","description":"Indicates the name of the domain","example":"hze.com"},"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on  machines before they are powered off. Provide the path to the script on the parent machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. <br>\nThis property can be used for sorting.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"Customization specification to use when Sysprep customization is requested.<br>Supported Filters: 'Equals'.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Indicates the customization settings of the Automated desktop pool."},"CustomizationSettingsV2":{"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Full Clone Active Directory container for ClonePrep and SysPrep respectively.\nThis property can be used for sorting.","example":"CN=Computers"},"ad_site_name":{"type":"string","description":"Indicatest the name of the AD Site.","example":"Default-First-Site-Name"},"compute_profile_id":{"type":"string","description":"Indicates the compute profile.<br>Supported Filters: 'Equals'.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"compute_profile_name":{"type":"string","description":"Indicates the name of compute profile","example":"computeProfile-name"},"custom_spec_name":{"type":"string","description":"Indicates the name of custom spec","example":"custom-spec-1"},"customization_type":{"type":"string","description":"Type of customization to use.\nThis property can be used for sorting.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"SYS_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"domain_account_id":{"type":"string","description":"Applicable To :Full clone desktop pools.<br> This is required for full clone desktop pools.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"domain_name":{"type":"string","description":"Indicates the name of the domain","example":"hze.com"},"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on  machines before they are powered off. Provide the path to the script on the parent machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"},"priming_computer_account":{"type":"string","description":"Publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.","example":"primingComputerAccount-1"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. <br>\nThis property can be used for sorting.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"Customization specification to use when Sysprep customization is requested.<br>Supported Filters: 'Equals'.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Indicates the customization settings of the Automated desktop pool."},"CustomizationSpecInfo":{"type":"object","properties":{"description":{"type":"string","description":"Customization specification description.","example":"windows customization specification"},"guest_os":{"type":"string","description":"Guest Operating system.\n* UNKNOWN: Unknown\n* WINDOWS: Windows\n* LINUX: Linux\n* MAC: Mac","example":"Windows","enum":["UNKNOWN","WINDOWS","LINUX","MAC"]},"id":{"type":"string","description":"Unique ID representing the customization specification.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this customization specification from being used in desktop pool creation.","items":{"type":"string","description":"* DHCP_NOT_CONFIGURED: When the customization specification does not have DHCP configured.\n* UNSUPPORTED_OS: When the customization specification contains unsupported operating system. Currently the supported operating systems are Windows and Linux.","enum":["DHCP_NOT_CONFIGURED","UNSUPPORTED_OS"]}},"name":{"type":"string","description":"Name of the customization specification.","example":"windows specification"}},"description":"Information related to customization specification created in vCenter."},"CustomizationSpecificationCreateSpec":{"required":["auto_logon","auto_logon_attempts","name","owner_name","owner_org","password","time_zone"],"type":"object","properties":{"auto_logon":{"type":"boolean","description":"Indicates whether the autoLogon is enabled or not.","example":true},"auto_logon_attempts":{"maximum":500,"minimum":0,"type":"integer","description":"Number of auto logon attempts.","format":"int32","example":1,"default":0},"commands":{"type":"array","description":"Commands to run the first time a user logs on.","example":["C:\\setup.ps1"],"items":{"type":"string","description":"Commands to run the first time a user logs on.","example":"[\"C:\\\\setup.ps1\"]"}},"description":{"type":"string","description":"Description of the Customization Specification Spec.","example":"Prism Spec"},"name":{"type":"string","description":"Name of the Customization Specification Spec.","example":"Prism Prod SpecName"},"owner_name":{"type":"string","description":"Owner name of the Customization Specification Spec.","example":"Omnissa"},"owner_org":{"type":"string","description":"Owner org of the Customization Specification Spec.","example":"Omnissa LLC"},"password":{"type":"array","description":"Local admin's password of the Customization Specification Spec.","example":"<password>","items":{"type":"string","description":"Local admin's password of the Customization Specification Spec.","example":"<password>"}},"time_zone":{"type":"string","description":"Indicates the timezone of the Customization Specification Spec.","example":"Pacific Standard Time"}},"description":"Creates the customization specification"},"CustomizationSpecificationInfo":{"type":"object","properties":{"auto_logon":{"type":"boolean","description":"Indicates whether the autoLogo is enabled or not.","example":true},"auto_logon_attempts":{"type":"integer","description":"Number of auto logon attempts.","format":"int32","example":1},"commands":{"type":"array","description":"Commands to run the first time a user logs on.","example":"C:/setup.ps1","items":{"type":"string","description":"Commands to run the first time a user logs on.","example":"C:/setup.ps1"}},"custom_spec_usage_count":{"type":"integer","description":"Usage count of the Customization Specification.","format":"int32","example":3},"description":{"type":"string","description":"Description of the Customization Specification Spec.","example":"Prism Spec"},"id":{"type":"string","description":"Id of the Customization Specification Spec.","example":"6862f0b5-cf51-492a-a9a8-554222c0e5ee"},"name":{"type":"string","description":"Name of the Customization Specification Spec.","example":"Prism Prod SpecName"},"owner_name":{"type":"string","description":"Owner name of the Customization Specification Spec.","example":"Omnissa"},"owner_org":{"type":"string","description":"Owner org of the Customization Specification Spec.","example":"Omnissa LLC"},"time_zone":{"type":"string","description":"Indicates the timezone of the Customization Specification Spec.","example":"Africa/Kigali"}},"description":"Information about Customization Specification."},"CustomizationSpecificationUpdateSpec":{"required":["auto_logon","auto_logon_attempts","owner_name","owner_org","password","time_zone"],"type":"object","properties":{"auto_logon":{"type":"boolean","description":"Indicates whether the autoLogon is enabled or not.","example":true},"auto_logon_attempts":{"maximum":500,"minimum":0,"type":"integer","description":"Number of auto logon attempts.","format":"int32","example":1,"default":0},"commands":{"type":"array","description":"Commands to run the first time a user logs on.","example":["C:\\setup.ps1"],"items":{"type":"string","description":"Commands to run the first time a user logs on.","example":"[\"C:\\\\setup.ps1\"]"}},"description":{"type":"string","description":"Description of the Customization Specification Spec.","example":"Prism Spec"},"owner_name":{"type":"string","description":"Owner name of the Customization Specification Spec.","example":"Omnissa"},"owner_org":{"type":"string","description":"Owner org of the Customization Specification Spec.","example":"Omnissa LLC"},"password":{"type":"array","description":"Local admin's password of the Customization Specification Spec.","example":"<password>","items":{"type":"string","description":"Local admin's password of the Customization Specification Spec.","example":"<password>"}},"time_zone":{"type":"string","description":"Indicates the timezone of the Customization Specification Spec.","example":"Pacific Standard Time"}},"description":"Customization Specification whose settings need to be updated."},"DatacenterInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID representing a datacenter.\nSupported Filters : 'Equals'.","example":"datacenter-1"},"name":{"type":"string","description":"Name of the datacenter.\nSupported Filters : 'Equals','StartsWith','Contains'.Supports Sorting.","example":"datacenter"},"path":{"type":"string","description":"Datacenter path.\nSupported Filters : 'Equals','StartsWith','Contains'.Supports Sorting.","example":"/datacenter"}},"description":"Information related to datacenter."},"DatastoreClusterInfo":{"type":"object","properties":{"capacity_mb":{"type":"integer","description":"Maximum capacity of this datastore cluster, in MB.\nSupported Filters : 'Between'.\nThis property can be used for sorting.","format":"int64","example":946176},"datacenter_id":{"type":"string","description":"ID of the datacenter for this datastore cluster.\nSupported Filters : 'Equals'.","example":"datacenter-1"},"datastore_ids":{"type":"array","description":"IDs of datastores which are a part of this datastore cluster.\nSupported Filters : 'Equals','Contains'.","example":["datastore-29","datastore-12"],"items":{"type":"string","description":"IDs of datastores which are a part of this datastore cluster.\nSupported Filters : 'Equals','Contains'.","example":"[\"datastore-29\",\"datastore-12\"]"}},"free_space_mb":{"type":"integer","description":"Available capacity of this datastore cluster, in MB.\nSupported Filters : 'Between'.\nThis property can be used for sorting.","format":"int64","example":88239},"host_or_cluster_id":{"type":"string","description":"ID of the host or cluster for this datastore cluster.\nSupported Filters : 'Equals'.","example":"domain-c15"},"id":{"type":"string","description":"Unique ID representing this datastore cluster.\nSupported Filters : 'Equals'.","example":"group-p1"},"name":{"type":"string","description":"Datastore cluster name.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting.","example":"datastoreCluster1"},"path":{"type":"string","description":"Datastore cluster path.\nSupported Filters : 'Equals','StartsWith','Contains'.","example":"/DC/host/cls/datastoreCluster1"},"vcenter_id":{"type":"string","description":"ID of the virtual center for this datastore cluster.\nSupported Filters : 'Equals'.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"}}},"DatastoreInfo":{"type":"object","properties":{"capacity_mb":{"type":"integer","description":"Maximum capacity of this datastore, in MB.Supported Filters : 'Equals'.\nThis property can be used for sorting.","format":"int64","example":946176},"datacenter_id":{"type":"string","description":"Datacenter id for this datastore.Supported Filters : 'Equals'.","example":"datacenter-1"},"disk_type":{"type":"string","description":"Disk type of the datastore.Supported Filters : 'Equals'.\n* SSD: Solid State Drive disk type.\n* NON_SSD: NON-Solid State Drive disk type.\n* UNKNOWN: Unknown disk type.\n* NON_VMFS: NON-VMFS disk type.","example":"NON_SSD","enum":["SSD","NON_SSD","UNKNOWN","NON_VMFS"]},"file_system_type":{"type":"string","description":"File system type of the datastore.Supported Filters : 'Equals'.\n* VMFS: Virtual Machine File System.\n* NFS: Network File System.\n* VSAN: vSAN File System.\n* VVOL: Virtual Volumes.\n* UNKNOWN: Unknown File System type.","example":"VMFS","enum":["VMFS","NFS","VSAN","VVOL","UNKNOWN"]},"free_space_mb":{"type":"integer","description":"Available capacity of this datastore, in MB.Supported Filters : 'Equals'.\nThis property can be used for sorting.","format":"int64","example":88239},"host_or_cluster_id":{"type":"string","description":"Host or Cluster id for this datastore.Supported Filters : 'Equals'.","example":"domain-c85"},"id":{"type":"string","description":"Unique ID representing the datastore. Supported Filters : 'Equals'.","example":"datastore-29"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this Datastore from being used in desktop pool/farm.Supported Filters : 'Equals'.","items":{"type":"string","description":"* INACCESSIBLE_TO_SOME_HOSTS: When this Datastore is inaccessible to at least one host in a cluster.\n* VMFS6_AND_MORE_THAN_64_HOSTS: When this Datastore is VMFS version 6 or greater, but belongs to a cluster with more than 64 hosts, then this cannot be used as a replica disk in linked clone desktop pool/farm.\n* VMFS5_AND_MORE_THAN_32_HOSTS: When this Datastore is VMFS version 5 or greater, but belongs to a cluster with more than 32 hosts, then this cannot be used as a replica disk in linked clone desktop pool/farm.\n* NOT_VMFS5_AND_MORE_THAN_8_HOSTS: When this Datastore is not VMFS version 5 and belongs to a cluster with more than 8 hosts, then this cannot be used as a replica disk in linked clone desktop pool/farm.\n* ESX65_AND_MORE_THAN_64_HOSTS: When this Datastore is ESX version 6.5 or greater, but belongs to a cluster with more than 64 hosts, then this cannot be used as a replica disk in linked clone desktop pool/farm.\n* ESX51_AND_MORE_THAN_32_HOSTS: When this Datastore is ESX version 5.1 or greater, but belongs to a cluster with more than 32 hosts, then this cannot be used as a replica disk in linked clone desktop pool/farm.\n* NOT_ESX51_AND_MORE_THAN_8_HOSTS: When this Datastore is not ESX version 5.1 and belongs to a cluster with more than 8 hosts, then this cannot be used as a replica disk in linked clone desktop pool/farm.\n* INCOMPATIBLE_NATIVE_SNAPSHOTS: If the datastore is incompatible with the native snapshot feature then this datastore cannot be used as a replica or OS disk for linked clone desktop pool/farm with native snapshots enabled.","enum":["INACCESSIBLE_TO_SOME_HOSTS","VMFS6_AND_MORE_THAN_64_HOSTS","VMFS5_AND_MORE_THAN_32_HOSTS","NOT_VMFS5_AND_MORE_THAN_8_HOSTS","ESX65_AND_MORE_THAN_64_HOSTS","ESX51_AND_MORE_THAN_32_HOSTS","NOT_ESX51_AND_MORE_THAN_8_HOSTS","INCOMPATIBLE_NATIVE_SNAPSHOTS"]}},"local_datastore":{"type":"boolean","description":"Indicates if this datastore is local to a single host.Supported Filters : 'Equals'.","example":true},"name":{"type":"string","description":"Datastore name.<br>Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Datastore1"},"number_of_vms":{"type":"integer","description":"Indicates the number of virtual machines the datastore has for desktop pool/farm when applicableSupported Filters : 'Equals'.\nThis property can be used for sorting.","format":"int32","example":15},"path":{"type":"string","description":"Datastore path.<br>Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"/Datacenter/host/Cluster/Datastore1"},"vcenter_id":{"type":"string","description":"Virtual Center id for this datastore.Supported Filters : 'Equals'.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"vmfs_major_version":{"type":"string","description":"The VMFS major version number.Supported Filters : 'Equals'.","example":"5"}},"description":"Information related to datastore."},"DatastorePathInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID representing the datastore path.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"path":{"type":"string","description":"Datastore path.","example":"\"[datastore1] ISO images\""}},"description":"Information related to datastore paths."},"DatastoreSpaceRequirementInfo":{"type":"object","properties":{"disk_type":{"type":"string","description":"Indicates the type of disk used for storage.\n* OS: Disk to store operating system related data.\n* REPLICA: Disk for placement of replica VMs created by instant clone engine.","enum":["OS","REPLICA"]},"max_size_disk_gb":{"type":"number","description":"Indicates maximum recommended disk space, in GB.","format":"double","example":15},"mid_size_disk_gb":{"type":"number","description":"Indicates recommended disk space with 50% utilization, in GB.","format":"double","example":10},"min_size_disk_gb":{"type":"number","description":"Indicates minimum recommended disk space, in GB.","format":"double","example":5}},"description":"Information about Datastore Space Requirement."},"DatastoreSpaceRequirementSpec":{"required":["pool_size","source","type","vcenter_id"],"type":"object","properties":{"base_snapshot_id":{"type":"string","description":"Parent VM snapshot ID. Must be set if source is INSTANT_CLONE.","example":"snapshot-22"},"base_vm_id":{"type":"string","description":"Parent VM ID. Must be set if source is INSTANT_CLONE.","example":"vm-34"},"id":{"type":"string","description":"Id of inventory resource for which space requirement is to be found. Can be desktop pool or farm id.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"pool_size":{"type":"integer","description":"Desired size of the desktop pool or farm.","format":"int32"},"source":{"type":"string","description":"Source or provisioning type of machines.\n* FULL_CLONE: Virtual Machines created from a vCenter Server template.\n* INSTANT_CLONE: Virtual Machines created by instant clone engine.","example":"INSTANT_CLONE","enum":["FULL_CLONE","INSTANT_CLONE"]},"type":{"type":"string","description":"Type of inventory resource for which space requirement is to be found.\n* DESKTOP_POOL: Desktop pool inventory resource.\n* FARM: Farm inventory resource.","example":"FARM","enum":["DESKTOP_POOL","FARM"]},"use_separate_replica_and_os_disk":{"type":"boolean","description":"Indicates whether separate datastores are to be used for OS and replica disks. Will be ignored if source is FULL_CLONE or vSAN is to be configured. Default value is false.","example":false},"use_vsan":{"type":"boolean","description":"Indicates whether vSAN is to be configured for the desktop pool or farm. Default value is false. vSAN should be configured if set to true.","example":false},"user_assignment":{"type":"string","description":"User assignment of the desktop pool. Will be ignored if type is FARM. Default value is FLOATING.\n* DEDICATED: Dedicated user assignment.\n* FLOATING: Floating user assignment.","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"ID of virtual center where parent VM or master image is present.","example":"ed3f92f3-0eef-4bf1-a405-de69f138d382"},"vm_template_id":{"type":"string","description":"VM template ID. Must be set if source is FULL_CLONE.","example":"vm-344"}},"description":"Datastore space requirement to be computed."},"DatastoreSpaceRequirementSpecV2":{"required":["pool_size","source","type","vcenter_id"],"type":"object","properties":{"base_snapshot_id":{"type":"string","description":"Parent VM snapshot ID. Must be set if source is INSTANT_CLONE.","example":"snapshot-22"},"base_vm_id":{"type":"string","description":"Parent VM ID. Must be set if source is INSTANT_CLONE.","example":"vm-34"},"id":{"type":"string","description":"Id of inventory resource for which space requirement is to be found. Can be desktop pool or farm id.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"persistent_disk_size_mb":{"type":"integer","description":"Indicates the size of the persistent disk in MB.","format":"int32","example":2048},"pool_size":{"type":"integer","description":"Desired size of the desktop pool or farm.","format":"int32"},"source":{"type":"string","description":"Source or provisioning type of machines.\n* FULL_CLONE: Virtual Machines created from a vCenter Server template.\n* INSTANT_CLONE: Virtual Machines created by instant clone engine.","example":"INSTANT_CLONE","enum":["FULL_CLONE","INSTANT_CLONE"]},"type":{"type":"string","description":"Type of inventory resource for which space requirement is to be found.\n* DESKTOP_POOL: Desktop pool inventory resource.\n* FARM: Farm inventory resource.","example":"FARM","enum":["DESKTOP_POOL","FARM"]},"use_separate_replica_and_os_disk":{"type":"boolean","description":"Indicates whether separate datastores are to be used for OS and replica disks. Will be ignored if source is FULL_CLONE or vSAN is to be configured. Default value is false.","example":false},"use_vsan":{"type":"boolean","description":"Indicates whether vSAN is to be configured for the desktop pool or farm. Default value is false. vSAN should be configured if set to true.","example":false},"user_assignment":{"type":"string","description":"User assignment of the desktop pool. Will be ignored if type is FARM. Default value is FLOATING.\n* DEDICATED: Dedicated user assignment.\n* FLOATING: Floating user assignment.","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"ID of virtual center where parent VM or master image is present.","example":"ed3f92f3-0eef-4bf1-a405-de69f138d382"},"vm_template_id":{"type":"string","description":"VM template ID. Must be set if source is FULL_CLONE.","example":"vm-344"}},"description":"Datastore space requirement to be computed."},"DesktopCapacityProviderResourceSettingsCreateSpec":{"type":"object","properties":{"clone_datastore_id":{"type":"string","description":"Datastore to store the machines","example":"datastore-1"},"clone_disk_datastore_policy_id":{"type":"string","description":"Datastore to store policy id foe the clone disks.","example":"policy-1"},"enable_cbrc":{"type":"boolean","description":"Indicates whether to use CBRC. <br> Default value is false.","example":false},"folder_id":{"type":"string","description":"Folder where the machines are deployed to.","example":"group-v1"},"image_id":{"type":"string","description":"This property can be set only when type is set to AUTOMATED.","example":"0a950b74-5175-4a4a-b73e-bb323562ba34"},"image_snapshot_id":{"type":"string","description":"This property can be set only when type is set to AUTOMATED.","example":"80ba9ed8-f8b7-43c8-ae3c-4c14bc5b230e"},"network_attributes":{"type":"object","additionalProperties":{"type":"string","description":"Indicates the network attributes like network_id","example":"network_id:c9896e51-48a2-4d82-ae9e-a0246981b473"},"description":"Indicates the network attributes like network_id","example":"network_id:c9896e51-48a2-4d82-ae9e-a0246981b473"},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks. <br> This property is required if use_separate_datastores_replica_and_os_disks is set to true. <br>","example":"datastore-1"},"replica_disk_datastore_policy_id":{"type":"string","description":"Datastore to store policy id foe the replicate disks. <br> This property is required if use_separate_datastores_replica_and_os_disks is set to true. <br>","example":"policy-2"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the machines.","example":"resgroup-1"},"use_parent_image_network":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as false.<br>Indicates whether to use parent network or different network","example":false},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Indicates whether to use separate datastores for replica and OS disks. <br> Default value is false.","example":false}},"description":"Applicable To: Automated desktop pool. <br>Capacity provider resource settings for Automated desktop pool."},"DesktopCapacityProviderResourceSettingsPushImageSpec":{"required":["image_id","image_snapshot_id"],"type":"object","properties":{"clone_datastore_id":{"type":"string","description":"Datastore to store the machines","example":"datastore-1"},"clone_disk_datastore_policy_id":{"type":"string","description":"Datastore to store policy id foe the clone disks.","example":"policy-1"},"enable_cbrc":{"type":"boolean","description":"Indicates whether to use CBRC. <br> Default value is false.","example":false},"folder_id":{"type":"string","description":"Folder where the machines are deployed to.","example":"group-v1"},"image_id":{"type":"string","description":"New base image virtual machine for the desktop pool. This must be in the same datacenter as the base image of the desktop pool.<br>Either parent VM and snapshot to be specified.","example":"vm-1"},"image_snapshot_id":{"type":"string","description":"New base image snapshot for the desktop pool. This must be a snapshot of the parent VM.","example":"snapshot-1"},"network_attributes":{"type":"object","additionalProperties":{"type":"string","description":"Indicates the network attributes like network_id, cidr. ","example":"network_id:c9896e51-48a2-4d82-ae9e-a0246981b473 cidr:10.212.10.12\u0014"},"description":"Indicates the network attributes like network_id, cidr. ","example":"network_id:c9896e51-48a2-4d82-ae9e-a0246981b473 cidr:10.212.10.12\u0014"},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks. <br> This property is required if use_separate_datastores_replica_and_os_disks is set to true. <br>","example":"datastore-1"},"replica_disk_datastore_policy_id":{"type":"string","description":"Datastore to store policy id foe the replicate disks. <br> This property is required if use_separate_datastores_replica_and_os_disks is set to true. <br>","example":"policy-2"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the machines.","example":"resgroup-1"},"use_parent_image_network":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as true.<br>Indicates whether to use parent network or different network","example":false},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Indicates whether to use separate datastores for replica and OS disks. <br> Default value is false.","example":false}},"description":"Applicable To: Automated desktop pool. <br>Capacity provider resource settings for Automated desktop pool."},"DesktopCustomizationSettingsCreateSpec":{"required":["customization_type","domain_account_id"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Full clone desktop pools.<br>This is required for full clone desktop pools. <br>Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Automated desktop pools.<br>Name of the AD Site.","example":"Default-First-Site-Name"},"compute_profile_id":{"type":"string","description":"Compute profile to used.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"customization_type":{"type":"string","description":"Type of customization to use.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"SYS_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"domain_account_id":{"type":"string","description":"Applicable To :Automated desktop pools.<br> This is required for automated desktop pools.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on  machines before they are powered off. Provide the path to the script on the parent machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as false.<br>Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. <br>","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated desktop pool. <br>Customization settings for Automated desktop pool."},"DesktopCustomizationSettingsCreateSpecV2":{"required":["customization_type","domain_account_id"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Full clone desktop pools.<br>This is required for full clone desktop pools. <br>Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Automated desktop pools.<br>Name of the AD Site.","example":"Default-First-Site-Name"},"compute_profile_id":{"type":"string","description":"Compute profile to used.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"customization_type":{"type":"string","description":"Type of customization to use.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"SYS_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"domain_account_id":{"type":"string","description":"Applicable To :Automated desktop pools.<br> This is required for automated desktop pools.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on  machines before they are powered off. Provide the path to the script on the parent machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"},"priming_computer_account":{"type":"string","description":"Publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.","example":"primingComputerAccount-1"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as false.<br>Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. <br>","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated desktop pool. <br>Customization settings for Automated desktop pool."},"DesktopCustomizationSettingsPushImageSpec":{"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Full clone desktop pools.<br>This is required for full clone desktop pools. <br>Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Automated desktop pools.<br>Name of the AD Site.","example":"Default-First-Site-Name"},"compute_profile_id":{"type":"string","description":"Compute profile to used.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"customization_type":{"type":"string","description":"Type of customization to use.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"SYS_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"domain_account_id":{"type":"string","description":"Applicable To :Automated desktop pools.<br> This is required for automated desktop pools.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"priming_computer_account":{"type":"string","description":"Publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.","example":"primingComputerAccount-1"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as false.<br>Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. <br>","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated desktop pool. <br>Customization settings for Automated desktop pool."},"DesktopCustomizationSettingsUpdateSpec":{"required":["customization_type"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Full clone desktop pools.<br>This is required for full clone desktop pools. <br>Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Automated desktop pools.<br>Name of the AD Site.","example":"Default-First-Site-Name"},"compute_profile_id":{"type":"string","description":"Compute profile to used.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"customization_type":{"type":"string","description":"Type of customization to use.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"SYS_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on  machines before they are powered off. Provide the path to the script on the parent machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as false.<br>Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. <br>","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated desktop pool. <br>Customization settings for Automated desktop pool."},"DesktopMonitorInfo":{"type":"object","properties":{"access_group_id":{"type":"string","description":"ID of access group associated with the desktop.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"enable_app_remoting":{"type":"boolean","description":"Is set as true if desktop can be used for application pool creation.\nDefault value is false.","example":false},"id":{"type":"string","description":"Unique ID of the Desktop.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"name":{"type":"string","description":"Desktop name.","example":"Desktop1"},"source":{"type":"string","description":"Source of the machines in the desktop pool.\nThis property is required if type is set to \"AUTOMATED\".\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"status":{"type":"string","description":"Status of Desktop.\n* OK: Desktop is enabled and no machines are in WARNING or ERROR state. One or more machine(s) may be DISABLED (including the case where all of them are DISABLED).\n* WARNING: Desktop is enabled. One or more machine(s) is either in WARNING or ERROR (not exceeding the predefined threshold) state.\n* ERROR: Desktop is enabled. One or more machine(s) (exceeding the predefined threshold) is in ERROR state, or, for Automated Desktops, there could be a provisioning error.\n* DISABLED: Desktop is disabled.","example":"OK","enum":["OK","WARNING","ERROR","DISABLED"]},"type":{"type":"string","description":"Type of the desktop.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]}},"description":"Monitoring information related to Desktop."},"DesktopMonitorInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","description":"ID of access group associated with the desktop.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"application_count":{"minimum":0,"type":"integer","description":"Number of Applications published from the desktop.","format":"int32","example":12},"enable_app_remoting":{"type":"boolean","description":"Is set as true if desktop can be used for application pool creation.\nDefault value is false.","example":false},"id":{"type":"string","description":"Unique ID of the Desktop.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"name":{"type":"string","description":"Desktop name.","example":"Desktop1"},"source":{"type":"string","description":"Source of the machines in the desktop pool.\nThis property is required if type is set to \"AUTOMATED\".\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"status":{"type":"string","description":"Status of Desktop.\n* OK: Desktop is enabled and no machines are in WARNING or ERROR state. One or more machine(s) may be DISABLED (including the case where all of them are DISABLED).\n* WARNING: Desktop is enabled. One or more machine(s) is either in WARNING or ERROR (not exceeding the predefined threshold) state.\n* ERROR: Desktop is enabled. One or more machine(s) (exceeding the predefined threshold) is in ERROR state, or, for Automated Desktops, there could be a provisioning error.\n* DISABLED: Desktop is disabled.","example":"OK","enum":["OK","WARNING","ERROR","DISABLED"]},"type":{"type":"string","description":"Type of the desktop.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]}},"description":"Monitoring information related to Desktop."},"DesktopNamePatternSettings":{"type":"object","properties":{"max_number_of_machines":{"type":"integer","description":"Maximum number of machines in the desktop pool.\nThis property can be used for sorting.","format":"int32","example":100},"min_number_of_machines":{"type":"integer","description":"The minimum number of machines to have provisioned if on demand provisioning is selected.\nThis property can be used for sorting.","format":"int32","example":10},"naming_pattern":{"type":"string","description":"Machines will be named according to the specified naming pattern.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":"vm-{n}-sales"},"number_of_spare_machines":{"type":"integer","description":"Number of spare powered on machines.\nThis property can be used for sorting.","format":"int32","example":10},"provisioning_time":{"type":"string","description":"Determines when the machines are provisioned. <br> Default value is UP_FRONT\nThis property can be used for sorting.\n* ON_DEMAND: Provision machines on demand.\n* UP_FRONT: Provision all machines up-front.","example":"UP_FRONT","enum":["ON_DEMAND","UP_FRONT"]}},"description":"Applicable To: Automated desktop pool. <br>Naming pattern settings for Automated desktop pool."},"DesktopNamePatternSettingsCreateSpec":{"required":["naming_pattern"],"type":"object","properties":{"max_number_of_machines":{"minimum":1,"type":"integer","description":"Maximum number of machines in the desktop pool. <br> Default value is 1.","format":"int32","example":100},"min_number_of_machines":{"minimum":0,"type":"integer","description":"This is applicable if provisioning_time is set to ON_DEMAND with default value of 0. <br>","format":"int32","example":10},"naming_pattern":{"type":"string","description":"Machines will be named according to the specified naming pattern.<br> By default, view manager appends a unique number to the specified pattern to provide a unique name for each virtual machine. To place this unique number elsewhere in the pattern, use '{n}'. (For example: vm-{n}-sales.) The unique number can also be made a fixed length. (For example: vm-{n:fixed=3}-sales will name VMs from vm-001-sales to vm-999-sales). <br>Machine names are constrained to a maximum size of 15 characters including the unique number. Therefore, care must be taken when choosing a pattern. If the maximum desktop size is 9 machines, the pattern must be at most 14 characters. For 99 machines, 13 characters, for 999 machines, 12 characters. For 9999 machines, 11 characters. If using a fixed size token, use a maximum of 14 characters for \"n=1\", 13 characters for \"n=2\", 12 characters for \"n=3\", and 11 characters for \"n=4\".<br>If {n} is specified with no size, a size of 2 is automatically used and if no {} is specified, {n=2} is automatically appended to the end of the pattern.","example":"vm-{n}-sales"},"number_of_spare_machines":{"minimum":1,"type":"integer","description":"Number of spare powered on machines. <br> Default value is 1.","format":"int32","example":10},"provisioning_time":{"type":"string","description":"Determines when the machines are provisioned. <br> Default value is UP_FRONT\n* ON_DEMAND: Provision machines on demand.\n* UP_FRONT: Provision all machines up-front.","example":"UP_FRONT","enum":["ON_DEMAND","UP_FRONT"]}},"description":"Applicable To: Automated desktop pool. <br>Naming pattern settings for Automated desktop pool."},"DesktopNamePatternSettingsUpdateSpec":{"required":["naming_pattern"],"type":"object","properties":{"max_number_of_machines":{"minimum":1,"type":"integer","description":"Maximum number of machines in the desktop pool. <br> Default value is 1.","format":"int32","example":100},"min_number_of_machines":{"minimum":0,"type":"integer","description":"This is applicable if provisioning_time is set to ON_DEMAND with default value of 0. <br>","format":"int32","example":10},"naming_pattern":{"type":"string","description":"Machines will be named according to the specified naming pattern.<br> By default, view manager appends a unique number to the specified pattern to provide a unique name for each virtual machine. To place this unique number elsewhere in the pattern, use '{n}'. (For example: vm-{n}-sales.) The unique number can also be made a fixed length. (For example: vm-{n:fixed=3}-sales will name VMs from vm-001-sales to vm-999-sales). <br>Machine names are constrained to a maximum size of 15 characters including the unique number. Therefore, care must be taken when choosing a pattern. If the maximum desktop size is 9 machines, the pattern must be at most 14 characters. For 99 machines, 13 characters, for 999 machines, 12 characters. For 9999 machines, 11 characters. If using a fixed size token, use a maximum of 14 characters for \"n=1\", 13 characters for \"n=2\", 12 characters for \"n=3\", and 11 characters for \"n=4\".<br>If {n} is specified with no size, a size of 2 is automatically used and if no {} is specified, {n=2} is automatically appended to the end of the pattern.","example":"vm-{n}-sales"},"number_of_spare_machines":{"minimum":1,"type":"integer","description":"Number of spare powered on machines. <br> Default value is 1.","format":"int32","example":10},"provisioning_time":{"type":"string","description":"Determines when the machines are provisioned. <br> Default value is UP_FRONT\n* ON_DEMAND: Provision machines on demand.\n* UP_FRONT: Provision all machines up-front.","example":"UP_FRONT","enum":["ON_DEMAND","UP_FRONT"]}},"description":"Applicable To: Automated desktop pool. <br>Naming pattern settings for Automated desktop pool."},"DesktopPoolCloneprepCustomizationSettings":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. ClonePrep can run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"cloneprep_postsync_script","deprecated":true},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3","deprecated":true},"power_off_script_name":{"type":"string","description":"Power off script. ClonePrep can run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"cloneprep_poweroff_script","deprecated":true},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3","deprecated":true},"priming_computer_account":{"type":"string","description":"Instant Clone publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Settings for ClonePrep customization. This setting is only applicable to instant clone desktop pools."},"DesktopPoolCloneprepCustomizationSettingsCreateSpec":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. ClonePrep can run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"cloneprep_postsync_script","deprecated":true},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3","deprecated":true},"power_off_script_name":{"type":"string","description":"Power off script. ClonePrep can run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"cloneprep_poweroff_script","deprecated":true},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3","deprecated":true},"priming_computer_account":{"type":"string","description":"Instant Clone publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.","example":"priming"}},"description":"Settings for CLONE_PREP customization for instant clone desktop pool."},"DesktopPoolCloneprepCustomizationSettingsUpdateSpec":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. ClonePrep can run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"cloneprep_postsync_script","deprecated":true},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3","deprecated":true},"power_off_script_name":{"type":"string","description":"Power off script. ClonePrep can run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"cloneprep_poweroff_script","deprecated":true},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3","deprecated":true},"priming_computer_account":{"type":"string","description":"Instant Clone publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.","example":"priming"}},"description":"Settings for CLONE_PREP customization for Instant Clone desktop pool."},"DesktopPoolCreateSpec":{"required":["name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools with manual user assignment with default value as false.<br>Whether assignment of multiple users to a single machine is allowed.<br>If this is true then automatic_user_assignment should be false. <br>","example":false},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools with default value as false.<br>Indicates whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user from session_settings will be applicable. <br>","example":false},"automatic_user_assignment":{"type":"boolean","description":"Automatic assignment of a user the first time they access the machine.<br>This property is applicable if user_assignment is set to DEDICATED with default value as true.<br>","example":true},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is set to true.<br>Default value is false. <br>","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools with default value as false.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services. This can be set to false only when cloud_assigned is set to false.<br>Default value is false. <br>This property cannot be set to true, if any of the conditions are satisfied: <br>user is provided.<br>enabled is false.<br>supported_session_type is not DESKTOP.<br>global_entitlement is set.<br>user_assignment is DEDICATED and automatic_user_assignment is false. <br>Local entitlements are configured. <br>Any of the machines in the pool have users assigned. <br>cs_restriction_tags is not set. <br>Desktop pool type is MANUAL.","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsCreateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.<br>","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br> If no machine is assigned to the user then \"displayName No machine assigned)\" will be displayed in the Horizon client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":false},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsCreateSpec"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as true.<br>Indicates whether provisioning is enabled.<br>","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS Desktop pool.<br>Farm is needed to create RDS desktop pool. This is required for RDS desktop pools.This Farm must not already be associated with another RDS desktop.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"machines":{"type":"array","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation.","items":{"type":"string","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation."}},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","example":"ManualPool"},"naming_method":{"type":"string","description":"Applicable To: Automated desktop pool.<br>Naming method for the desktop pool. This is required for Automated desktop pools.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Network interface card settings for machines provisioned for this desktop.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsCreateSpec"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsCreateSpec"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Applicable To: Manual and Automated desktop pools.<br>Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.<br>\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable for Automated pools only with default value as true.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools with default value as VM.<br>Transparent page sharing scope for this Desktop Pool.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.<br>\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server. <br>This is required for all desktop pool except Unmanaged Manual and RDS desktop pool. <br>","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsCreateSpec"}},"description":"Desktop pool object to be created."},"DesktopPoolCreateSpecV2":{"required":["name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools with manual user assignment with default value as false.<br>Whether assignment of multiple users to a single machine is allowed.<br>If this is true then automatic_user_assignment should be false. <br>","example":false},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools with default value as false.<br>Indicates whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user from session_settings will be applicable. <br>","example":false},"automatic_user_assignment":{"type":"boolean","description":"Automatic assignment of a user the first time they access the machine.<br>This property is applicable if user_assignment is set to DEDICATED with default value as true.<br>","example":true},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is set to true.<br>Default value is false. <br>","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools with default value as false.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services. This can be set to false only when cloud_assigned is set to false.<br>Default value is false. <br>This property cannot be set to true, if any of the conditions are satisfied: <br>user is provided.<br>enabled is false.<br>supported_session_type is not DESKTOP.<br>global_entitlement is set.<br>user_assignment is DEDICATED and automatic_user_assignment is false. <br>Local entitlements are configured. <br>Any of the machines in the pool have users assigned. <br>cs_restriction_tags is not set. <br>Desktop pool type is MANUAL.","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsCreateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.<br>","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br> If no machine is assigned to the user then \"displayName No machine assigned)\" will be displayed in the Horizon client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":false},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsCreateSpec"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as true.<br>Indicates whether provisioning is enabled.<br>","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS Desktop pool.<br>Farm is needed to create RDS desktop pool. This is required for RDS desktop pools.This Farm must not already be associated with another RDS desktop.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"machines":{"type":"array","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation.","items":{"type":"string","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation."}},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","example":"ManualPool"},"naming_method":{"type":"string","description":"Applicable To: Automated desktop pool.<br>Naming method for the desktop pool. This is required for Automated desktop pools.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Network interface card settings for machines provisioned for this desktop.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsCreateSpecV2"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsCreateSpec"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Applicable To: Manual and Automated desktop pools.<br>Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.<br>\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable for Automated pools only with default value as true.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools with default value as VM.<br>Transparent page sharing scope for this Desktop Pool.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.<br>\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server. <br>This is required for all desktop pool except Unmanaged Manual and RDS desktop pool. <br>","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsCreateSpec"}},"description":"Desktop pool object to be created."},"DesktopPoolCreateSpecV3":{"required":["name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools with manual user assignment with default value as false.<br>Whether assignment of multiple users to a single machine is allowed.<br>If this is true then automatic_user_assignment should be false. <br>","example":false},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools with default value as false.<br>Indicates whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user from session_settings will be applicable. <br>","example":false},"automatic_user_assignment":{"type":"boolean","description":"Automatic assignment of a user the first time they access the machine.<br>This property is applicable if user_assignment is set to DEDICATED with default value as true.<br>","example":true},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is set to true.<br>Default value is false. <br>","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools with default value as false.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services. This can be set to false only when cloud_assigned is set to false.<br>Default value is false. <br>This property cannot be set to true, if any of the conditions are satisfied: <br>user is provided.<br>enabled is false.<br>supported_session_type is not DESKTOP.<br>global_entitlement is set.<br>user_assignment is DEDICATED and automatic_user_assignment is false. <br>Local entitlements are configured. <br>Any of the machines in the pool have users assigned. <br>cs_restriction_tags is not set. <br>Desktop pool type is MANUAL.","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsCreateV2"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.<br>","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br> If no machine is assigned to the user then \"displayName No machine assigned)\" will be displayed in the Horizon client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":false},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsCreateSpec"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as true.<br>Indicates whether provisioning is enabled.<br>","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS Desktop pool.<br>Farm is needed to create RDS desktop pool. This is required for RDS desktop pools.This Farm must not already be associated with another RDS desktop.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"machines":{"type":"array","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation.","items":{"type":"string","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation."}},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","example":"ManualPool"},"naming_method":{"type":"string","description":"Applicable To: Automated desktop pool.<br>Naming method for the desktop pool. This is required for Automated desktop pools.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Network interface card settings for machines provisioned for this desktop.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsCreateSpecV2"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsCreateSpec"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Applicable To: Manual and Automated desktop pools.<br>Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.<br>\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable for Automated pools only with default value as true.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsCreateSpecV2"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools with default value as VM.<br>Transparent page sharing scope for this Desktop Pool.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.<br>\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server. <br>This is required for all desktop pool except Unmanaged Manual and RDS desktop pool. <br>","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsCreateSpec"}},"description":"Desktop pool object to be created."},"DesktopPoolCreateSpecV4":{"required":["name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools with manual user assignment with default value as false.<br>Whether assignment of multiple users to a single machine is allowed.<br>If this is true then automatic_user_assignment should be false. <br>","example":false},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools with default value as false.<br>Indicates whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user from session_settings will be applicable. <br>","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment. Default value is false.","example":true},"automatic_user_assignment":{"type":"boolean","description":"Automatic assignment of a user the first time they access the machine.<br>This property is applicable if user_assignment is set to DEDICATED with default value as true.<br>","example":true},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is set to true.<br>Default value is false. <br>","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools with default value as false.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services. This can be set to false only when cloud_assigned is set to false.<br>Default value is false. <br>This property cannot be set to true, if any of the conditions are satisfied: <br>user is provided.<br>enabled is false.<br>supported_session_type is not DESKTOP.<br>global_entitlement is set.<br>user_assignment is DEDICATED and automatic_user_assignment is false. <br>Local entitlements are configured. <br>Any of the machines in the pool have users assigned. <br>cs_restriction_tags is not set. <br>Desktop pool type is MANUAL.","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsCreateV3"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.<br>","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br> If no machine is assigned to the user then \"displayName No machine assigned)\" will be displayed in the Horizon client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":false},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsCreateSpec"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as true.<br>Indicates whether provisioning is enabled.<br>","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS Desktop pool.<br>Farm is needed to create RDS desktop pool. This is required for RDS desktop pools.This Farm must not already be associated with another RDS desktop.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"machines":{"type":"array","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation.","items":{"type":"string","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation."}},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","example":"ManualPool"},"naming_method":{"type":"string","description":"Applicable To: Automated desktop pool.<br>Naming method for the desktop pool. This is required for Automated desktop pools.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Network interface card settings for machines provisioned for this desktop.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsCreateSpecV2"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsCreateSpecV2"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Applicable To: Manual and Automated desktop pools.<br>Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.<br>\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable for Automated pools only with default value as true.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsCreateSpecV2"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools with default value as VM.<br>Transparent page sharing scope for this Desktop Pool.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.<br>\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server. <br>This is required for all desktop pool except Unmanaged Manual and RDS desktop pool. <br>","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsCreateSpec"}},"description":"Desktop pool object to be created."},"DesktopPoolCreateSpecV5":{"required":["name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools with manual user assignment with default value as false.<br>Whether assignment of multiple users to a single machine is allowed.<br>If this is true then automatic_user_assignment should be false. <br>","example":false},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools with default value as false.<br>Indicates whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user from session_settings will be applicable. <br>","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment. Default value is false.","example":true},"automatic_user_assignment":{"type":"boolean","description":"Automatic assignment of a user the first time they access the machine.<br>This property is applicable if user_assignment is set to DEDICATED with default value as true.<br>","example":true},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is set to true.<br>Default value is false. <br>","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools with default value as false.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services. This can be set to false only when cloud_assigned is set to false.<br>Default value is false. <br>This property cannot be set to true, if any of the conditions are satisfied: <br>user is provided.<br>enabled is false.<br>supported_session_type is not DESKTOP.<br>global_entitlement is set.<br>user_assignment is DEDICATED and automatic_user_assignment is false. <br>Local entitlements are configured. <br>Any of the machines in the pool have users assigned. <br>cs_restriction_tags is not set. <br>Desktop pool type is MANUAL.","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsCreateV3"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.<br>","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br> If no machine is assigned to the user then \"displayName No machine assigned)\" will be displayed in the Horizon client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":false},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsCreateSpecV2"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as true.<br>Indicates whether provisioning is enabled.<br>","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS Desktop pool.<br>Farm is needed to create RDS desktop pool. This is required for RDS desktop pools.This Farm must not already be associated with another RDS desktop.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"machines":{"type":"array","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation.","items":{"type":"string","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation."}},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","example":"ManualPool"},"naming_method":{"type":"string","description":"Applicable To: Automated desktop pool.<br>Naming method for the desktop pool. This is required for Automated desktop pools.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Network interface card settings for machines provisioned for this desktop.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsCreateSpecV2"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsCreateSpecV2"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Applicable To: Manual and Automated desktop pools.<br>Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.<br>\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable for Automated pools only with default value as true.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsCreateSpecV2"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools with default value as VM.<br>Transparent page sharing scope for this Desktop Pool.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.<br>\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server. <br>This is required for all desktop pool except Unmanaged Manual and RDS desktop pool. <br>","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsCreateSpec"}},"description":"Desktop pool object to be created."},"DesktopPoolCreateSpecV6":{"required":["name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools with manual user assignment with default value as false.<br>Whether assignment of multiple users to a single machine is allowed.<br>If this is true then automatic_user_assignment should be false. <br>","example":false},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools with default value as false.<br>Indicates whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user from session_settings will be applicable. <br>","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment. Default value is false.","example":true},"automatic_user_assignment":{"type":"boolean","description":"Automatic assignment of a user the first time they access the machine.<br>This property is applicable if user_assignment is set to DEDICATED with default value as true.<br>","example":true},"aws_core_desktop_settings":{"$ref":"#/components/schemas/AwsCoreDesktopSettingsCreateSpec"},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is set to true.<br>Default value is false. <br>","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools with default value as false.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services. This can be set to false only when cloud_assigned is set to false.<br>Default value is false. <br>This property cannot be set to true, if any of the conditions are satisfied: <br>user is provided.<br>enabled is false.<br>supported_session_type is not DESKTOP.<br>global_entitlement is set.<br>user_assignment is DEDICATED and automatic_user_assignment is false. <br>Local entitlements are configured. <br>Any of the machines in the pool have users assigned. <br>cs_restriction_tags is not set. <br>Desktop pool type is MANUAL.","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsCreateV3"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.<br>","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br> If no machine is assigned to the user then \"displayName No machine assigned)\" will be displayed in the Horizon client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":false},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsCreateSpecV2"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as true.<br>Indicates whether provisioning is enabled.<br>","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS Desktop pool.<br>Farm is needed to create RDS desktop pool. This is required for RDS desktop pools.This Farm must not already be associated with another RDS desktop.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"machines":{"type":"array","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation.","items":{"type":"string","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation."}},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","example":"ManualPool"},"naming_method":{"type":"string","description":"Applicable To: Automated desktop pool.<br>Naming method for the desktop pool. This is required for Automated desktop pools.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Network interface card settings for machines provisioned for this desktop.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsCreateSpecV2"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsCreateSpecV2"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Applicable To: Manual and Automated desktop pools.<br>Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.<br>\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable for Automated pools only with default value as true.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsCreateSpecV2"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools with default value as VM.<br>Transparent page sharing scope for this Desktop Pool.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.<br>\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server. <br>This is required for all desktop pool except Unmanaged Manual and RDS desktop pool. <br>","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsCreateSpec"}},"description":"Desktop pool object to be created."},"DesktopPoolCreateSpecV7":{"required":["name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools with manual user assignment with default value as false.<br>Whether assignment of multiple users to a single machine is allowed.<br>If this is true then automatic_user_assignment should be false. <br>","example":false},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools with default value as false.<br>Indicates whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user from session_settings will be applicable. <br>","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment. Default value is false.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nDefault value - BOTH.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"automatic_user_assignment":{"type":"boolean","description":"Automatic assignment of a user the first time they access the machine.<br>This property is applicable if user_assignment is set to DEDICATED with default value as true.<br>","example":true},"aws_core_desktop_settings":{"$ref":"#/components/schemas/AwsCoreDesktopSettingsCreateSpec"},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is set to true.<br>Default value is false. <br>","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools with default value as false.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services. This can be set to false only when cloud_assigned is set to false.<br>Default value is false. <br>This property cannot be set to true, if any of the conditions are satisfied: <br>user is provided.<br>enabled is false.<br>supported_session_type is not DESKTOP.<br>global_entitlement is set.<br>user_assignment is DEDICATED and automatic_user_assignment is false. <br>Local entitlements are configured. <br>Any of the machines in the pool have users assigned. <br>cs_restriction_tags is not set. <br>Desktop pool type is MANUAL.","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsCreateV3"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.<br>","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br> If no machine is assigned to the user then \"displayName No machine assigned)\" will be displayed in the Horizon client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":false},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsCreateSpecV2"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as true.<br>Indicates whether provisioning is enabled.<br>","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS Desktop pool.<br>Farm is needed to create RDS desktop pool. This is required for RDS desktop pools.This Farm must not already be associated with another RDS desktop.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"machines":{"type":"array","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation.","items":{"type":"string","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation."}},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","example":"ManualPool"},"naming_method":{"type":"string","description":"Applicable To: Automated desktop pool.<br>Naming method for the desktop pool. This is required for Automated desktop pools.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Network interface card settings for machines provisioned for this desktop.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsCreateSpecV2"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect.\nDefault value - false."},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsCreateSpecV2"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Applicable To: Manual and Automated desktop pools.<br>Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.<br>\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable for Automated pools only with default value as true.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsCreateSpecV2"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools with default value as VM.<br>Transparent page sharing scope for this Desktop Pool.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.<br>\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server. <br>This is required for all desktop pool except Unmanaged Manual and RDS desktop pool. <br>","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsCreateSpec"}},"description":"Desktop pool object to be created."},"DesktopPoolCreateSpecV8":{"required":["entra_sso_enabled","name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools with manual user assignment with default value as false.<br>Whether assignment of multiple users to a single machine is allowed.<br>If this is true then automatic_user_assignment should be false. <br>","example":false},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools with default value as false.<br>Indicates whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user from session_settings will be applicable. <br>","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment. Default value is false.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nDefault value - BOTH.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"automatic_user_assignment":{"type":"boolean","description":"Automatic assignment of a user the first time they access the machine.<br>This property is applicable if user_assignment is set to DEDICATED with default value as true.<br>","example":true},"aws_core_desktop_settings":{"$ref":"#/components/schemas/AwsCoreDesktopSettingsCreateSpecV2"},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is set to true.<br>Default value is false. <br>","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools with default value as false.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services. This can be set to false only when cloud_assigned is set to false.<br>Default value is false. <br>This property cannot be set to true, if any of the conditions are satisfied: <br>user is provided.<br>enabled is false.<br>supported_session_type is not DESKTOP.<br>global_entitlement is set.<br>user_assignment is DEDICATED and automatic_user_assignment is false. <br>Local entitlements are configured. <br>Any of the machines in the pool have users assigned. <br>cs_restriction_tags is not set. <br>Desktop pool type is MANUAL.","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags to which the access to the desktop pool is restricted. If this property is not set it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsCreateV3"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.<br>","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools with default value as false.<br> If no machine is assigned to the user then \"displayName No machine assigned)\" will be displayed in the Horizon client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":false},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","example":"ManualPool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsCreateSpecV3"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Default value is false.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as true.<br>Indicates whether provisioning is enabled.<br>","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering. Default value is true.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled for the desktop pool","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS Desktop pool.<br>Farm is needed to create RDS desktop pool. This is required for RDS desktop pools.This Farm must not already be associated with another RDS desktop.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"machines":{"type":"array","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation.","items":{"type":"string","description":"Applicable To: Manual desktop pools. <br>List of machines to add to this desktop pool during creation."}},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","example":"ManualPool"},"naming_method":{"type":"string","description":"Applicable To: Automated desktop pool.<br>Naming method for the desktop pool. This is required for Automated desktop pools.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Network interface card settings for machines provisioned for this desktop.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsCreateSpecV2"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect.\nDefault value - false."},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsCreateSpecV2"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools with default value as DESKTOP.<br> Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will be useful when the machines in the pool support application remoting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if the category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Applicable To: Manual and Automated desktop pools.<br>Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.<br>\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable for Automated pools only with default value as true.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsCreateSpecV2"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools with default value as VM.<br>Transparent page sharing scope for this Desktop Pool.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"uem_server_id":{"type":"string","description":"UEM Server Id.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"user_assignment":{"type":"string","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.<br>\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server. <br>This is required for all desktop pool except Unmanaged Manual and RDS desktop pool. <br>","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsCreateSpec"}},"description":"Desktop pool object to be created."},"DesktopPoolCustomizationScriptSettings":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"}},"description":"Settings for customization scripts. This setting is only applicable to instant clone desktop pools."},"DesktopPoolCustomizationScriptSettingsCreateSpec":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"}},"description":"Settings to configure customization scripts for instant clone desktop pool."},"DesktopPoolCustomizationScriptSettingsUpdateSpec":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"}},"description":"Settings to update customization scripts for Instant Clone desktop pool."},"DesktopPoolCustomizationSettings":{"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To: Full/instant clone automated desktop pools.<br>Full clone and Instant Clone Engine Active Directory container for SysPrep and ClonePrep.\nThis property can be used for sorting.","example":"CN=Computers"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/DesktopPoolCloneprepCustomizationSettings"},"customization_type":{"type":"string","description":"Type of customization to use.\nThis property can be used for sorting.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"CLONE_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"do_not_power_on_vms_after_creation":{"type":"boolean","description":"Whether to power on VMs after creation. This is the settings when customization will be done manually.\nThis property can be used for sorting.","example":false},"instant_clone_domain_account_id":{"type":"string","description":"Applicable To: Instant clone and Full clone desktop pools.<br>Instant clone or full clone domain account. This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"quickprep_customization_settings":{"$ref":"#/components/schemas/DesktopPoolQuickprepCustomizationSettings"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Manual and automated desktop pools.<br>Whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. This is applicable only for automated desktop pools.\nThis property can be used for sorting.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"view_composer_domain_account_id":{"type":"string","description":"Applicable To: Linked clone automated desktop pools.<br>View Composer domain account. This is the administrator which will add the machines to its domain upon creation. This must be set for linked-clone automated desktop pools.","example":"0ebb464a-8780-4860-924f-8b2d1d1b33ef"}},"description":"Customization settings."},"DesktopPoolCustomizationSettingsCreateSpec":{"required":["customization_type"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Instant clone and Full clone desktop pools.<br>This is required for instant clone desktop pools. <br>Instant Clone Engine and Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/DesktopPoolCloneprepCustomizationSettingsCreateSpec"},"customization_type":{"type":"string","description":"Type of customization to use.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"CLONE_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"do_not_power_on_vms_after_creation":{"type":"boolean","description":"Indicates whether to power on VMs after creation. This is the settings when customization will be done manually. <br> This property is required if customization_type is set to NONE with default value as false. <br>","example":false},"instant_clone_domain_account_id":{"type":"string","description":"Applicable To : Instant clone and Full clone desktop pools.<br> This is required for instant clone desktop pools.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as false.<br>Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. <br>","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated desktop pool. <br>Customization settings for Automated desktop pool."},"DesktopPoolCustomizationSettingsCreateV2":{"required":["customization_type"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Instant clone and Full clone desktop pools.<br>This is required for instant clone desktop pools. <br>Instant Clone Engine and Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Instant Clone desktop pools. <br>The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone pool provisioning.","example":"Default-First-Site-Name"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/DesktopPoolCloneprepCustomizationSettingsCreateSpec"},"customization_type":{"type":"string","description":"Type of customization to use.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"CLONE_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"do_not_power_on_vms_after_creation":{"type":"boolean","description":"Indicates whether to power on VMs after creation. This is the settings when customization will be done manually. <br> This property is required if customization_type is set to NONE with default value as false. <br>","example":false},"instant_clone_domain_account_id":{"type":"string","description":"Applicable To : Instant clone and Full clone desktop pools.<br> This is required for instant clone desktop pools.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as false.<br>Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. <br>","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated desktop pools.<br>Customization settings for this desktop pool."},"DesktopPoolCustomizationSettingsCreateV3":{"required":["customization_type"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Instant clone and Full clone desktop pools.<br>This is required for instant clone desktop pools. <br>Instant Clone Engine and Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Instant Clone desktop pools. <br>The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone pool provisioning.","example":"Default-First-Site-Name"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/DesktopPoolCloneprepCustomizationSettingsCreateSpec"},"customization_script_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationScriptSettingsCreateSpec"},"customization_type":{"type":"string","description":"Type of customization to use.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"CLONE_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"do_not_power_on_vms_after_creation":{"type":"boolean","description":"Indicates whether to power on VMs after creation. This is the settings when customization will be done manually. <br> This property is required if customization_type is set to NONE with default value as false. <br>","example":false},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by default.","example":true},"instant_clone_domain_account_id":{"type":"string","description":"Applicable To : Instant clone and Full clone desktop pools.<br> This is required for instant clone desktop pools.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as false.<br>Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. <br>","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated desktop pools.<br>Customization settings for this desktop pool."},"DesktopPoolCustomizationSettingsUpdateSpec":{"required":["customization_type"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Instant clone and Full clone desktop pools.<br> This is required for instant clone desktop pools.<br>Instant Clone Engine and Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/DesktopPoolCloneprepCustomizationSettingsUpdateSpec"},"customization_type":{"type":"string","description":"Type of customization to use.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"CLONE_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"do_not_power_on_vms_after_creation":{"type":"boolean","description":"Indicates whether to power on VMs after creation. This is the settings when customization will be done manually. This property is required if customization_type is set NONE.","example":false},"instant_clone_domain_account_id":{"type":"string","description":"Applicable To : Instant clone and Full clone desktop pools.<br> This is required for instant clone desktop pools.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated Desktop pool. <br> Customization settings for Automated desktop pool."},"DesktopPoolCustomizationSettingsUpdateV2":{"required":["customization_type"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Instant clone and Full clone desktop pools.<br> This is required for instant clone desktop pools.<br>Instant Clone Engine and Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Instant Clone desktop pools. <br>The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone pool provisioning.","example":"Default-First-Site-Name"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/DesktopPoolCloneprepCustomizationSettingsUpdateSpec"},"customization_type":{"type":"string","description":"Type of customization to use.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"CLONE_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"do_not_power_on_vms_after_creation":{"type":"boolean","description":"Indicates whether to power on VMs after creation. This is the settings when customization will be done manually. This property is required if customization_type is set NONE.","example":false},"instant_clone_domain_account_id":{"type":"string","description":"Applicable To : Instant clone and Full clone desktop pools.<br> This is required for instant clone desktop pools.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated desktop pools.<br>Customization settings for this desktop pool."},"DesktopPoolCustomizationSettingsUpdateV3":{"required":["customization_type"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To : Instant clone and Full clone desktop pools.<br> This is required for instant clone desktop pools.<br>Instant Clone Engine and Full Clone Active Directory container for ClonePrep and SysPrep respectively.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Instant Clone desktop pools. <br>The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone pool provisioning.","example":"Default-First-Site-Name"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/DesktopPoolCloneprepCustomizationSettingsUpdateSpec"},"customization_script_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationScriptSettingsUpdateSpec"},"customization_type":{"type":"string","description":"Type of customization to use.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"CLONE_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"do_not_power_on_vms_after_creation":{"type":"boolean","description":"Indicates whether to power on VMs after creation. This is the settings when customization will be done manually. This property is required if customization_type is set NONE.","example":false},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by default.","example":true},"instant_clone_domain_account_id":{"type":"string","description":"Applicable To : Instant clone and Full clone desktop pools.<br> This is required for instant clone desktop pools.<br>This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"This is required when customization_type is set as SYS_PREP.<br>Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated desktop pools.<br>Customization settings for this desktop pool."},"DesktopPoolCustomizationSettingsV2":{"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To: Full/instant clone automated desktop pools.<br>Full clone and Instant Clone Engine Active Directory container for SysPrep and ClonePrep.\nThis property can be used for sorting.","example":"CN=Computers"},"ad_site_name":{"type":"string","description":"Applicable To: Instant Clone desktop pools. <br>The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone pool provisioning.","example":"Default-First-Site-Name"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/DesktopPoolCloneprepCustomizationSettings"},"customization_type":{"type":"string","description":"Type of customization to use.\nThis property can be used for sorting.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"CLONE_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"do_not_power_on_vms_after_creation":{"type":"boolean","description":"Whether to power on VMs after creation. This is the settings when customization will be done manually.\nThis property can be used for sorting.","example":false},"instant_clone_domain_account_id":{"type":"string","description":"Applicable To: Instant clone and Full clone desktop pools.<br>Instant clone or full clone domain account. This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"quickprep_customization_settings":{"$ref":"#/components/schemas/DesktopPoolQuickprepCustomizationSettings"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Manual and automated desktop pools.<br>Whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. This is applicable only for automated desktop pools.\nThis property can be used for sorting.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"view_composer_domain_account_id":{"type":"string","description":"Applicable To: Linked clone automated desktop pools.<br>View Composer domain account. This is the administrator which will add the machines to its domain upon creation. This must be set for linked-clone automated desktop pools.","example":"0ebb464a-8780-4860-924f-8b2d1d1b33ef"}},"description":"Applicable To: Automated desktop pools.<br>Customization settings for this desktop pool."},"DesktopPoolCustomizationSettingsV3":{"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Applicable To: Full/instant clone automated desktop pools.<br>Full clone and Instant Clone Engine Active Directory container for SysPrep and ClonePrep.\nThis property can be used for sorting.","example":"CN=Computers"},"ad_site_name":{"type":"string","description":"Applicable To: Instant Clone desktop pools. <br>The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone pool provisioning.","example":"Default-First-Site-Name"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/DesktopPoolCloneprepCustomizationSettings"},"customization_script_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationScriptSettings"},"customization_type":{"type":"string","description":"Type of customization to use.\nThis property can be used for sorting.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.\n* NONE: Applicable To: Full clone desktop pools.<br>No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.","example":"CLONE_PREP","enum":["CLONE_PREP","NONE","SYS_PREP"]},"do_not_power_on_vms_after_creation":{"type":"boolean","description":"Whether to power on VMs after creation. This is the settings when customization will be done manually.\nThis property can be used for sorting.","example":false},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by default.","example":true},"instant_clone_domain_account_id":{"type":"string","description":"Applicable To: Instant clone and Full clone desktop pools.<br>Instant clone or full clone domain account. This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"quickprep_customization_settings":{"$ref":"#/components/schemas/DesktopPoolQuickprepCustomizationSettings"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Applicable To: Manual and automated desktop pools.<br>Whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. This is applicable only for automated desktop pools.\nThis property can be used for sorting.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"Customization specification to use when Sysprep customization is requested.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"view_composer_domain_account_id":{"type":"string","description":"Applicable To: Linked clone automated desktop pools.<br>View Composer domain account. This is the administrator which will add the machines to its domain upon creation. This must be set for linked-clone automated desktop pools.","example":"0ebb464a-8780-4860-924f-8b2d1d1b33ef"}},"description":"Applicable To: Automated desktop pools.<br>Customization settings for this desktop pool."},"DesktopPoolDatastoreSettings":{"type":"object","properties":{"datastore_id":{"type":"string","description":"Id of the datastore.","example":"datastore-1"},"sdrs_cluster":{"type":"boolean","description":"Whether datastore represents a Storage DRS cluster.","example":false},"storage_overcommit":{"type":"string","description":"Storage overcommit determines how Horizon places new machines on the selected datastores. With an aggressive overcommit level, Horizon reserves less space for sparse disk growth, but fits more machines on the datastore.\n* NONE: No overcommit.\n* CONSERVATIVE: Conservative.\n* MODERATE: Moderate.\n* AGGRESSIVE: Aggressive.\n* UNBOUNDED: Unbounded.","example":"CONSERVATIVE","enum":["NONE","CONSERVATIVE","MODERATE","AGGRESSIVE","UNBOUNDED"]}},"description":"Settings for a Virtual Center datastore."},"DesktopPoolDatastoreSettingsCreateSpec":{"required":["datastore_id"],"type":"object","properties":{"datastore_id":{"type":"string","description":"Id of the datastore.","example":"datastore-1"},"sdrs_cluster":{"type":"boolean","description":"Applicable to full clone desktop pools with default value as false. Indicates whether datastore represents a Storage DRS cluster.","example":false}},"description":"Settings for a Virtual Center datastore."},"DesktopPoolDatastoreSettingsUpdateSpec":{"required":["datastore_id"],"type":"object","properties":{"datastore_id":{"type":"string","description":"Id of the datastore.","example":"datastore-1"},"sdrs_cluster":{"type":"boolean","description":"Indicates whether datastore represents a Storage DRS cluster.","example":false}},"description":"Settings for a Virtual Center datastore."},"DesktopPoolDeleteSpec":{"type":"object","properties":{"delete_from_disk":{"type":"boolean","description":"Determines whether the machine VMs should be deleted from vCenter Server.<br> This must be false for RDS and unmanaged desktop pools and true for Instant Clone desktop pools.<br>Default value is true for IC pools and false for all other types of desktop pools. <br>","example":false}},"description":"Desktop pool object to be deleted."},"DesktopPoolDisplayProtocolSettings":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the desktop pool. For a managed desktop pool, this will default to PCOIP.For an unmanaged desktop pool, this will default to RDP.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"display_protocols":{"type":"array","description":"List of supported display protocols for this desktop pool.Default value is [PCOIP, RDP, BLAST].","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"grid_vgpus_enabled":{"type":"boolean","description":"When 3D rendering is managed by the vSphere Client, this enables support for NVIDIA GRID vGPUs.This will be false if 3D rendering is not managed by the vSphere Client. If this is true,the host or cluster associated with the desktop pool must support NVIDIA GRID and vGPU types required by the desktop pool's VirtualMachines,VmTemplate, or BaseImageSnapshot. If this is false, the desktop pool's VirtualMachines, VmTemplate, orBaseImageSnapshot must not support NVIDIA GRID vGPUs. Since suspending VMs with passthroughdevices such as vGPUs is not possible, power_policy cannot be set to SUSPEND if this is enabled.Default value is false.\nThis property can be used for sorting.","example":false},"html_access_enabled":{"type":"boolean","description":"This property is no longer in use for Horizon Components. It is always set to true. HTML Access, enabled by Omnissa Blast technology, allows users to connect to machines from Web browsers. Horizon Client software does not have to be installed on the client devices. To enable HTML Access, you must install the HTML Machine Access feature pack. Also, Blast must be configured as a supported protocol in displayProtocols.\nThis property can be used for sorting.","example":true},"max_number_of_monitors":{"type":"integer","description":"When 3D is disabled, the 'Max number of monitors' and 'Max resolution of any one monitor' settings determine the amount ofvRAM assigned to machines in this desktop. The greater these values are, the more memory will be consumeon the associated ESX hosts. Existing virtual machines must be powered off and subsequently powered onfor the change to take effect. A restart will not cause the changes to take effect. If 3D is enabled and managedby View, the maximum number of monitors must be 1 or 2. For Instant Clones, this value is inherited from snapshot of Master VM.\nThis property can be used for sorting.","format":"int32","example":2},"max_resolution_of_any_one_monitor":{"type":"string","description":"If 3D rendering is enabled and managed by View, this must be set to the default value. When 3D rendering is disabled,the 'Max number of monitors' and 'Max resolution of any one monitor' settings determine the amount of vRAM assignedto machines in this desktop. The greater these values are, the more memory will be consumed on the associated ESX hosts.This setting is only relevant on managed machines. Existing virtual machines must be powered off and subsequently poweredon for the change to take effect. A restart will not cause the changes to take effect. For Instant Clones,this value is inherited from snapshot of Master VM. This property has a default value of WUXGA.\nThis property can be used for sorting.\n* UHD: 3840x2160 resolution.\n* UHD_5K: 5120x2880 resolution.\n* UHD_8K: 7680x4320 resolution.\n* WQXGA: 2560x1600 resolution.\n* WSXGA_PLUS: 1680x1050 resolution.\n* WUXGA: 1920x1200 resolution.","example":"WUXGA","enum":["UHD","UHD_5K","UHD_8K","WQXGA","WSXGA_PLUS","WUXGA"]},"renderer3d":{"type":"string","description":"3D rendering is supported on Windows 7 or later guests running on VMs with virtual hardware version8 or later. The default protocol must be PCoIP and users must not be allowed to choose their ownprotocol to enable 3D rendering. For instant clone source desktop 3D rendering always mapped to MANAGE_BY_VSPHERE_CLIENT.Default value is DISABLED.\nThis property can be used for sorting.\n* AUTOMATIC: 3D rendering is automatic.\n* DISABLED: 3D rendering is disabled.\n* HARDWARE: 3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.","example":"true","enum":["AUTOMATIC","DISABLED","HARDWARE","MANAGE_BY_VSPHERE_CLIENT","SOFTWARE"]},"session_collaboration_enabled":{"type":"boolean","description":"Enable session collaboration feature. Session collaborationallows a user to share their remote session with other users.BLAST must be configured as a supported protocol in supported_display_protocols.Default value is false.\nThis property can be used for sorting.","example":false},"vgpu_grid_profile":{"type":"string","description":"NVIDIA GRID vGPUs might have multiple profiles and any one of the available profiles can beapplied to newly created instant clone desktop. The profile specified in this field will beused in the newly created instant clone desktop. Will be set if enable_grid_vgpus set to true.\nThis property can be used for sorting.","example":"instant-profile"},"vram_size_mb":{"type":"integer","description":"vRAM size for View managed 3D rendering. More VRAM can improve 3D performance.Size is in MB. On ESXi 5.0 hosts, the renderer allows a maximum VRAM size of 128MB. On ESXi 5.1and later hosts, the maximum VRAM size is 512MB. For Instant Clones, this value is inherited from snapshot of Master VM.This property is applicable when 3D renderer is not disabled. This has a default value of 96.\nThis property can be used for sorting.","format":"int32","example":64}},"description":"Settings for the networking protocol to display the remote machine."},"DesktopPoolDisplayProtocolSettingsCreateSpec":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true. This should be false for the AWS-CORE desktop pools.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the desktop pool. For a managed desktop pool, this will default to PCOIP and for unmanaged desktop pool, this will default to RDP.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"grid_vgpus_enabled":{"type":"boolean","description":"When 3D rendering is managed by the vSphere Client, this enables support for NVIDIA GRID vGPUs. This will be false if 3D rendering is not managed by the vSphere Client. If this is true, the host or cluster associated with the desktop pool must support NVIDIA GRID and vGPU types required by the desktop pool's VirtualMachines, VmTemplate or BaseImageSnapshot. If this is false, the desktop pool's VirtualMachines, VmTemplate or BaseImageSnapshot must not support NVIDIA GRID vGPUs. Since suspending VMs with passthrough devices such as vGPUs is not possible, power_policy cannot be set to SUSPEND if this is enabled. Default value is false.","example":false},"max_number_of_monitors":{"maximum":4,"minimum":1,"type":"integer","description":"When render3D is disabled, the max_number_of_monitors and max_resolution_of_any_one_monitor settings determine the amount of vRAM assigned to machines in this desktop. The greater these values are, the more memory will be consume on the associated ESX hosts. Existing virtual machines must be powered off and subsequently powered on for the change to take effect. A restart will not cause the changes to take effect. If 3D is enabled  and managed by View, the maximum number of monitors must be 1 or 2. For Instant Clones, this value is inherited from snapshot of Master VM. This property has a default value of 2. <br> This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.","format":"int32","example":2},"max_resolution_of_any_one_monitor":{"type":"string","description":"If 3D rendering is enabled and managed by View, this must be set to the default value. When 3D rendering is disabled, the max_number_of_monitors and max_resolution_of_any_one_monitor settings determine the amount of vRAM assigned to machines in this desktop. The greater these values are, the more memory will be consumed on the associated ESX hosts. This setting is only relevant on managed machines. Existing virtual machines must be powered off and subsequently powered on for the change to take effect. A restart will not cause the changes to take effect. For Instant Clones, this value is inherited from snapshot of Master VM. This property has a default value of WUXGA. <br> This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.\n* UHD: 3840x2160 resolution.\n* UHD_5K: 5120x2880 resolution.\n* UHD_8K: 7680x4320 resolution.\n* WQXGA: 2560x1600 resolution.\n* WSXGA_PLUS: 1680x1050 resolution.\n* WUXGA: 1920x1200 resolution.","example":"WUXGA","enum":["UHD","UHD_5K","UHD_8K","WQXGA","WSXGA_PLUS","WUXGA"]},"renderer3d":{"type":"string","description":"3D rendering is supported on Windows 7 or later guests running on VMs with virtual hardware version 8 or later. The default_display_protocol must set to PCOIP and allow_users_to_choose_protocol must be set to false to enable 3D rendering. For instant clone source desktop 3D rendering always mapped to MANAGE_BY_VSPHERE_CLIENT. Default value is DISABLED.\n* AUTOMATIC: 3D rendering is automatic.\n* DISABLED: 3D rendering is disabled.\n* HARDWARE: 3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.","example":"DISABLED","enum":["AUTOMATIC","DISABLED","HARDWARE","MANAGE_BY_VSPHERE_CLIENT","SOFTWARE"]},"session_collaboration_enabled":{"type":"boolean","description":"Applicable To: Automated and Manual pools with default value of false. <br> Enable session collaboration feature. Session collaboration allows a user to share their remote session with other users. BLAST must be configured as a supported protocol in supported_display_protocols.","example":false},"vram_size_mb":{"maximum":512,"minimum":64,"type":"integer","description":"vRAM size for View managed 3D rendering. More VRAM can improve 3D performance. Size is in MB. On ESXi 5.0 hosts, the renderer allows a maximum VRAM size of 128MB. On ESXi 5.1 and later hosts, the maximum VRAM size is 512MB. For Instant Clones, this value is inherited from snapshot of Master VM. This property has a default value of 96. <br>This property is required if renderer3d is set to AUTOMATIC, SOFTWARE or HARDWARE.","format":"int32","example":64}},"description":"Applicable To: Automated and Manual desktop pool. <br>Display protocol settings for Automated and Manual desktop pool."},"DesktopPoolDisplayProtocolSettingsCreateSpecV2":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true. This should be false for the AWS-CORE desktop pools.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the desktop pool. For a managed desktop pool, this will default to PCOIP and for unmanaged desktop pool, this will default to RDP.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"grid_vgpus_enabled":{"type":"boolean","description":"When 3D rendering is managed by the vSphere Client, this enables support for NVIDIA GRID vGPUs. This will be false if 3D rendering is not managed by the vSphere Client. If this is true, the host or cluster associated with the desktop pool must support NVIDIA GRID and vGPU types required by the desktop pool's VirtualMachines, VmTemplate or BaseImageSnapshot. If this is false, the desktop pool's VirtualMachines, VmTemplate or BaseImageSnapshot must not support NVIDIA GRID vGPUs. Since suspending VMs with passthrough devices such as vGPUs is not possible, power_policy cannot be set to SUSPEND if this is enabled. Default value is false.","example":false},"max_number_of_monitors":{"maximum":4,"minimum":1,"type":"integer","description":"When render3D is disabled, the max_number_of_monitors and max_resolution_of_any_one_monitor settings determine the amount of vRAM assigned to machines in this desktop. The greater these values are, the more memory will be consume on the associated ESX hosts. Existing virtual machines must be powered off and subsequently powered on for the change to take effect. A restart will not cause the changes to take effect. If 3D is enabled  and managed by View, the maximum number of monitors must be 1 or 2. For Instant Clones, this value is inherited from snapshot of Master VM. This property has a default value of 2. <br> This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.","format":"int32","example":2},"max_resolution_of_any_one_monitor":{"type":"string","description":"If 3D rendering is enabled and managed by View, this must be set to the default value. When 3D rendering is disabled, the max_number_of_monitors and max_resolution_of_any_one_monitor settings determine the amount of vRAM assigned to machines in this desktop. The greater these values are, the more memory will be consumed on the associated ESX hosts. This setting is only relevant on managed machines. Existing virtual machines must be powered off and subsequently powered on for the change to take effect. A restart will not cause the changes to take effect. For Instant Clones, this value is inherited from snapshot of Master VM. This property has a default value of WUXGA. <br> This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.\n* UHD: 3840x2160 resolution.\n* UHD_5K: 5120x2880 resolution.\n* UHD_8K: 7680x4320 resolution.\n* WQXGA: 2560x1600 resolution.\n* WSXGA_PLUS: 1680x1050 resolution.\n* WUXGA: 1920x1200 resolution.","example":"WUXGA","enum":["UHD","UHD_5K","UHD_8K","WQXGA","WSXGA_PLUS","WUXGA"]},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool. Default value is false.","example":false},"renderer3d":{"type":"string","description":"3D rendering is supported on Windows 7 or later guests running on VMs with virtual hardware version 8 or later. The default_display_protocol must set to PCOIP and allow_users_to_choose_protocol must be set to false to enable 3D rendering. For instant clone source desktop 3D rendering always mapped to MANAGE_BY_VSPHERE_CLIENT. Default value is DISABLED.\n* AUTOMATIC: 3D rendering is automatic.\n* DISABLED: 3D rendering is disabled.\n* HARDWARE: 3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.","example":"DISABLED","enum":["AUTOMATIC","DISABLED","HARDWARE","MANAGE_BY_VSPHERE_CLIENT","SOFTWARE"]},"session_collaboration_enabled":{"type":"boolean","description":"Applicable To: Automated and Manual pools with default value of false. <br> Enable session collaboration feature. Session collaboration allows a user to share their remote session with other users. BLAST must be configured as a supported protocol in supported_display_protocols.","example":false},"vram_size_mb":{"maximum":512,"minimum":64,"type":"integer","description":"vRAM size for View managed 3D rendering. More VRAM can improve 3D performance. Size is in MB. On ESXi 5.0 hosts, the renderer allows a maximum VRAM size of 128MB. On ESXi 5.1 and later hosts, the maximum VRAM size is 512MB. For Instant Clones, this value is inherited from snapshot of Master VM. This property has a default value of 96. <br>This property is required if renderer3d is set to AUTOMATIC, SOFTWARE or HARDWARE.","format":"int32","example":64}},"description":"Applicable To: Automated and Manual desktop pool. <br>Display protocol settings for Automated and Manual desktop pool."},"DesktopPoolDisplayProtocolSettingsCreateSpecV3":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true. This should be false for the AWS-CORE desktop pools.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the desktop pool. For a managed desktop pool, this will default to PCOIP and for unmanaged desktop pool, this will default to RDP.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"grid_vgpus_enabled":{"type":"boolean","description":"When 3D rendering is managed by the vSphere Client, this enables support for NVIDIA GRID vGPUs. This will be false if 3D rendering is not managed by the vSphere Client. If this is true, the host or cluster associated with the desktop pool must support NVIDIA GRID and vGPU types required by the desktop pool's VirtualMachines, VmTemplate or BaseImageSnapshot. If this is false, the desktop pool's VirtualMachines, VmTemplate or BaseImageSnapshot must not support NVIDIA GRID vGPUs. Since suspending VMs with passthrough devices such as vGPUs is not possible, power_policy cannot be set to SUSPEND if this is enabled. Default value is false.","example":false},"max_number_of_monitors":{"maximum":4,"minimum":1,"type":"integer","description":"When render3D is disabled, the max_number_of_monitors and max_resolution_of_any_one_monitor settings determine the amount of vRAM assigned to machines in this desktop. The greater these values are, the more memory will be consume on the associated ESX hosts. Existing virtual machines must be powered off and subsequently powered on for the change to take effect. A restart will not cause the changes to take effect. If 3D is enabled  and managed by View, the maximum number of monitors must be 1 or 2. For Instant Clones, this value is inherited from snapshot of Master VM. This property has a default value of 2. <br> This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.","format":"int32","example":2},"max_resolution_of_any_one_monitor":{"type":"string","description":"If 3D rendering is enabled and managed by View, this must be set to the default value. When 3D rendering is disabled, the max_number_of_monitors and max_resolution_of_any_one_monitor settings determine the amount of vRAM assigned to machines in this desktop. The greater these values are, the more memory will be consumed on the associated ESX hosts. This setting is only relevant on managed machines. Existing virtual machines must be powered off and subsequently powered on for the change to take effect. A restart will not cause the changes to take effect. For Instant Clones, this value is inherited from snapshot of Master VM. This property has a default value of WUXGA. <br> This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.\n* UHD: 3840x2160 resolution.\n* UHD_5K: 5120x2880 resolution.\n* UHD_8K: 7680x4320 resolution.\n* WQXGA: 2560x1600 resolution.\n* WSXGA_PLUS: 1680x1050 resolution.\n* WUXGA: 1920x1200 resolution.","example":"WUXGA","enum":["UHD","UHD_5K","UHD_8K","WQXGA","WSXGA_PLUS","WUXGA"]},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool. Default value is false.","example":false},"renderer3d":{"type":"string","description":"3D rendering is supported on Windows 7 or later guests running on VMs with virtual hardware version 8 or later. The default_display_protocol must set to PCOIP and allow_users_to_choose_protocol must be set to false to enable 3D rendering. For instant clone source desktop 3D rendering always mapped to MANAGE_BY_VSPHERE_CLIENT. Default value is DISABLED.\n* AUTOMATIC: 3D rendering is automatic.\n* DISABLED: 3D rendering is disabled.\n* HARDWARE: 3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.","example":"DISABLED","enum":["AUTOMATIC","DISABLED","HARDWARE","MANAGE_BY_VSPHERE_CLIENT","SOFTWARE"]},"session_collaboration_enabled":{"type":"boolean","description":"Applicable To: Automated and Manual pools with default value of false. <br> Enable session collaboration feature. Session collaboration allows a user to share their remote session with other users. BLAST must be configured as a supported protocol in supported_display_protocols.","example":false},"vgpu_grid_profile":{"type":"string","description":"vGPU Grid Profile.","example":"grid_m10-4q"},"vram_size_mb":{"maximum":512,"minimum":64,"type":"integer","description":"vRAM size for View managed 3D rendering. More VRAM can improve 3D performance. Size is in MB. On ESXi 5.0 hosts, the renderer allows a maximum VRAM size of 128MB. On ESXi 5.1 and later hosts, the maximum VRAM size is 512MB. For Instant Clones, this value is inherited from snapshot of Master VM. This property has a default value of 96. <br>This property is required if renderer3d is set to AUTOMATIC, SOFTWARE or HARDWARE.","format":"int32","example":64}},"description":"Applicable To: Automated and Manual desktop pool. <br>Display protocol settings for Automated and Manual desktop pool."},"DesktopPoolDisplayProtocolSettingsUpdateSpec":{"required":["allow_users_to_choose_protocol","default_display_protocol"],"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the desktop pool.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"max_number_of_monitors":{"maximum":4,"minimum":1,"type":"integer","description":"When renderer3d is disabled, the max_number_of_monitors and max_resolution_of_any_one_monitor' settings determine the amount ofvRAM assigned to machines in this desktop pool. The greater these values are, the more memory will be consumeon the associated ESX hosts. Existing virtual machines must be powered off and subsequently powered onfor the change to take effect. A restart will not cause the changes to take effect. If 3D is enabled and managedby Horizon, the maximum number of monitors must be 1 or 2. For Instant Clones, this value is inherited from snapshot of Master VM. This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE, or DISABLED.","format":"int32","example":2},"max_resolution_of_any_one_monitor":{"type":"string","description":"If 3D rendering is enabled and managed by Horizon, this must be set to the default value. When 3D rendering is disabled,the max_number_of_monitors and max_resolution_of_any_one_monitor' settings determine the amount of vRAM assignedto machines in this desktop pool. The greater these values are, the more memory will be consumed on the associated ESX hosts.This setting is only relevant on managed machines. Existing virtual machines must be powered off and subsequently poweredon for the change to take effect. A restart will not cause the changes to take effect. For Instant Clones,this value is inherited from snapshot of Master VM. This property has a default value of WUXGA.<br> This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.\n* UHD: 3840x2160 resolution.\n* UHD_5K: 5120x2880 resolution.\n* UHD_8K: 7680x4320 resolution.\n* WQXGA: 2560x1600 resolution.\n* WSXGA_PLUS: 1680x1050 resolution.\n* WUXGA: 1920x1200 resolution.","example":"WUXGA","enum":["UHD","UHD_5K","UHD_8K","WQXGA","WSXGA_PLUS","WUXGA"]},"renderer3d":{"type":"string","description":"3D rendering is supported on Windows 7 or later guests running on VMs with virtual hardware version8 or later. The default_display_protocol must set to PCOIP or BLAST and allow_users_to_choose_protocol must be set to false to enable 3D rendering protocol to enable 3D rendering. For instant clone source desktop pool 3D rendering always mapped to MANAGE_BY_VSPHERE_CLIENT.\n* AUTOMATIC: 3D rendering is automatic.\n* DISABLED: 3D rendering is disabled.\n* HARDWARE: 3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.","example":"DISABLED","enum":["AUTOMATIC","DISABLED","HARDWARE","MANAGE_BY_VSPHERE_CLIENT","SOFTWARE"]},"session_collaboration_enabled":{"type":"boolean","description":"Applicable To: Automated and Manual pools.<br>Enable session collaboration feature. Session collaborationallows a user to share their remote session with other users.BLAST must be configured as a supported protocol in supported_display_protocols.","example":false},"vram_size_mb":{"maximum":512,"minimum":64,"type":"integer","description":"vRAM size for Horizon managed 3D rendering. More VRAM can improve 3D performance. Size is in MB. On ESXi 5.0 hosts, the renderer allows a maximum VRAM size of 128MB. On ESXi 5.1 and later hosts, the maximum VRAM size is 512MB. For Instant Clones, this value is inherited from snapshot of Master VM.This property is applicable when 3D renderer is not disabled. This property is required if renderer3d is set to AUTOMATIC, SOFTWARE, or HARDWARE.","format":"int32","example":64}},"description":"Applicable To: Automated and Manual desktop pool. <br>Display protocol setting for Automated and Manual desktop pool."},"DesktopPoolDisplayProtocolSettingsUpdateSpecV2":{"required":["allow_users_to_choose_protocol","default_display_protocol","pcoip_ultra_protocol_enabled"],"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the desktop pool.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"max_number_of_monitors":{"maximum":4,"minimum":1,"type":"integer","description":"When renderer3d is disabled, the max_number_of_monitors and max_resolution_of_any_one_monitor' settings determine the amount ofvRAM assigned to machines in this desktop pool. The greater these values are, the more memory will be consumeon the associated ESX hosts. Existing virtual machines must be powered off and subsequently powered onfor the change to take effect. A restart will not cause the changes to take effect. If 3D is enabled and managedby Horizon, the maximum number of monitors must be 1 or 2. For Instant Clones, this value is inherited from snapshot of Master VM. This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE, or DISABLED.","format":"int32","example":2},"max_resolution_of_any_one_monitor":{"type":"string","description":"If 3D rendering is enabled and managed by Horizon, this must be set to the default value. When 3D rendering is disabled,the max_number_of_monitors and max_resolution_of_any_one_monitor' settings determine the amount of vRAM assignedto machines in this desktop pool. The greater these values are, the more memory will be consumed on the associated ESX hosts.This setting is only relevant on managed machines. Existing virtual machines must be powered off and subsequently poweredon for the change to take effect. A restart will not cause the changes to take effect. For Instant Clones,this value is inherited from snapshot of Master VM. This property has a default value of WUXGA.<br> This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.\n* UHD: 3840x2160 resolution.\n* UHD_5K: 5120x2880 resolution.\n* UHD_8K: 7680x4320 resolution.\n* WQXGA: 2560x1600 resolution.\n* WSXGA_PLUS: 1680x1050 resolution.\n* WUXGA: 1920x1200 resolution.","example":"WUXGA","enum":["UHD","UHD_5K","UHD_8K","WQXGA","WSXGA_PLUS","WUXGA"]},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool","example":false},"renderer3d":{"type":"string","description":"3D rendering is supported on Windows 7 or later guests running on VMs with virtual hardware version8 or later. The default_display_protocol must set to PCOIP or BLAST and allow_users_to_choose_protocol must be set to false to enable 3D rendering protocol to enable 3D rendering. For instant clone source desktop pool 3D rendering always mapped to MANAGE_BY_VSPHERE_CLIENT.\n* AUTOMATIC: 3D rendering is automatic.\n* DISABLED: 3D rendering is disabled.\n* HARDWARE: 3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.","example":"DISABLED","enum":["AUTOMATIC","DISABLED","HARDWARE","MANAGE_BY_VSPHERE_CLIENT","SOFTWARE"]},"session_collaboration_enabled":{"type":"boolean","description":"Applicable To: Automated and Manual pools.<br>Enable session collaboration feature. Session collaborationallows a user to share their remote session with other users.BLAST must be configured as a supported protocol in supported_display_protocols.","example":false},"vram_size_mb":{"maximum":512,"minimum":64,"type":"integer","description":"vRAM size for Horizon managed 3D rendering. More VRAM can improve 3D performance. Size is in MB. On ESXi 5.0 hosts, the renderer allows a maximum VRAM size of 128MB. On ESXi 5.1 and later hosts, the maximum VRAM size is 512MB. For Instant Clones, this value is inherited from snapshot of Master VM.This property is applicable when 3D renderer is not disabled. This property is required if renderer3d is set to AUTOMATIC, SOFTWARE, or HARDWARE.","format":"int32","example":64}},"description":"Applicable To: Automated and Manual desktop pool. <br>Display protocol setting for Automated and Manual desktop pool."},"DesktopPoolDisplayProtocolSettingsV2":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the desktop pool. For a managed desktop pool, this will default to PCOIP.For an unmanaged desktop pool, this will default to RDP.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"display_protocols":{"type":"array","description":"List of supported display protocols for this desktop pool.Default value is [PCOIP, RDP, BLAST].","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"grid_vgpus_enabled":{"type":"boolean","description":"When 3D rendering is managed by the vSphere Client, this enables support for NVIDIA GRID vGPUs.This will be false if 3D rendering is not managed by the vSphere Client. If this is true,the host or cluster associated with the desktop pool must support NVIDIA GRID and vGPU types required by the desktop pool's VirtualMachines,VmTemplate, or BaseImageSnapshot. If this is false, the desktop pool's VirtualMachines, VmTemplate, orBaseImageSnapshot must not support NVIDIA GRID vGPUs. Since suspending VMs with passthroughdevices such as vGPUs is not possible, power_policy cannot be set to SUSPEND if this is enabled.Default value is false.\nThis property can be used for sorting.","example":false},"html_access_enabled":{"type":"boolean","description":"This property is no longer in use for Horizon Components. It is always set to true. HTML Access, enabled by Omnissa Blast technology, allows users to connect to machines from Web browsers. Horizon Client software does not have to be installed on the client devices. To enable HTML Access, you must install the HTML Machine Access feature pack. Also, Blast must be configured as a supported protocol in displayProtocols.\nThis property can be used for sorting.","example":true},"max_number_of_monitors":{"type":"integer","description":"When 3D is disabled, the 'Max number of monitors' and 'Max resolution of any one monitor' settings determine the amount ofvRAM assigned to machines in this desktop. The greater these values are, the more memory will be consumeon the associated ESX hosts. Existing virtual machines must be powered off and subsequently powered onfor the change to take effect. A restart will not cause the changes to take effect. If 3D is enabled and managedby View, the maximum number of monitors must be 1 or 2. For Instant Clones, this value is inherited from snapshot of Master VM.\nThis property can be used for sorting.","format":"int32","example":2},"max_resolution_of_any_one_monitor":{"type":"string","description":"If 3D rendering is enabled and managed by View, this must be set to the default value. When 3D rendering is disabled,the 'Max number of monitors' and 'Max resolution of any one monitor' settings determine the amount of vRAM assignedto machines in this desktop. The greater these values are, the more memory will be consumed on the associated ESX hosts.This setting is only relevant on managed machines. Existing virtual machines must be powered off and subsequently poweredon for the change to take effect. A restart will not cause the changes to take effect. For Instant Clones,this value is inherited from snapshot of Master VM. This property has a default value of WUXGA.\nThis property can be used for sorting.\n* UHD: 3840x2160 resolution.\n* UHD_5K: 5120x2880 resolution.\n* UHD_8K: 7680x4320 resolution.\n* WQXGA: 2560x1600 resolution.\n* WSXGA_PLUS: 1680x1050 resolution.\n* WUXGA: 1920x1200 resolution.","example":"WUXGA","enum":["UHD","UHD_5K","UHD_8K","WQXGA","WSXGA_PLUS","WUXGA"]},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this desktop pool.","example":false},"renderer3d":{"type":"string","description":"3D rendering is supported on Windows 7 or later guests running on VMs with virtual hardware version8 or later. The default protocol must be PCoIP and users must not be allowed to choose their ownprotocol to enable 3D rendering. For instant clone source desktop 3D rendering always mapped to MANAGE_BY_VSPHERE_CLIENT.Default value is DISABLED.\nThis property can be used for sorting.\n* AUTOMATIC: 3D rendering is automatic.\n* DISABLED: 3D rendering is disabled.\n* HARDWARE: 3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.","example":"true","enum":["AUTOMATIC","DISABLED","HARDWARE","MANAGE_BY_VSPHERE_CLIENT","SOFTWARE"]},"session_collaboration_enabled":{"type":"boolean","description":"Enable session collaboration feature. Session collaborationallows a user to share their remote session with other users.BLAST must be configured as a supported protocol in supported_display_protocols.Default value is false.\nThis property can be used for sorting.","example":false},"vgpu_grid_profile":{"type":"string","description":"NVIDIA GRID vGPUs might have multiple profiles and any one of the available profiles can beapplied to newly created instant clone desktop. The profile specified in this field will beused in the newly created instant clone desktop. Will be set if enable_grid_vgpus set to true.\nThis property can be used for sorting.","example":"instant-profile"},"vram_size_mb":{"type":"integer","description":"vRAM size for View managed 3D rendering. More VRAM can improve 3D performance.Size is in MB. On ESXi 5.0 hosts, the renderer allows a maximum VRAM size of 128MB. On ESXi 5.1and later hosts, the maximum VRAM size is 512MB. For Instant Clones, this value is inherited from snapshot of Master VM.This property is applicable when 3D renderer is not disabled. This has a default value of 96.\nThis property can be used for sorting.","format":"int32","example":64}},"description":"Settings for the networking protocol to display the remote machine."},"DesktopPoolInfo":{"type":"object","properties":{"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.","example":"Desktop pool description"},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.","example":"pool"},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.","example":true},"id":{"type":"string","description":"Unique ID representing Desktop Pool.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.","example":"sales-pool1"},"settings":{"$ref":"#/components/schemas/DesktopPoolSettings"},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"type":{"type":"string","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]}},"description":"Information related to Desktop Pool."},"DesktopPoolInfoV10":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.<br>Whether assignment of multiple users to a single machine is allowed.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.This property will not be set for dedicated user assignment.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"aws_core_desktop_settings":{"$ref":"#/components/schemas/AwsCoreDesktopSettings"},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider<br>Supported Filters: 'Equals'.","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\dir2, dir1\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_brokered":{"type":"boolean","description":"Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the Desktop-pool was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"cs_restriction_tags":{"type":"array","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsV3"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using View Client. If no machine is assigned to the user then \"displayName (No machine assigned)\" will be displayed in the client.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsV2"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_entitlement_name":{"type":"string","description":"Total Number of Application Sessions on the Desktop.\n"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_source":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Source of image used in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"naming_method":{"type":"string","description":"Naming method for the desktop pool.\nThis property can be used for sorting.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.<br>Network interface card settings for machines provisioned for this desktop. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettings"}},"num_application_sessions":{"type":"integer","description":"Total Number of Application Sessions of the Desktop when applications are associated with it.\n","format":"int32"},"num_sessions":{"type":"integer","description":"Total Number of Sessions on the Desktop.\n","format":"int32"},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsV3"},"provisioning_status_data":{"$ref":"#/components/schemas/DesktopPoolProvisioningStatusDataV2"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsV4"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning on all machines stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>The transparent page sharing scope.\nThis property can be used for sorting.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the Desktop-pool was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","description":"Count of user or group entitlements present for the desktop pool.\nThis property can be used for sorting.","format":"int32","example":1},"vcenter_id":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>Virtual Center that manages the machines of the desktop pool.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"vcenter_name":{"type":"string","description":"Name of the Virtual Center that manages the machines of the desktop pool.","example":"vcenter.example"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettings"}},"description":"Information related to Desktop Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"DesktopPoolInfoV11":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.<br>Whether assignment of multiple users to a single machine is allowed.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.This property will not be set for dedicated user assignment.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nSupported Filters: Equals.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"aws_core_desktop_settings":{"$ref":"#/components/schemas/AwsCoreDesktopSettings"},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider<br>Supported Filters: 'Equals'.","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\dir2, dir1\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_brokered":{"type":"boolean","description":"Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the Desktop-pool was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"cs_restriction_tags":{"type":"array","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsV3"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using View Client. If no machine is assigned to the user then \"displayName (No machine assigned)\" will be displayed in the client.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsV2"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_entitlement_name":{"type":"string","description":"Total Number of Application Sessions on the Desktop.\n"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_source":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Source of image used in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"launch_id":{"type":"string","description":"Launch ID used by clients to connect to the pool."},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"naming_method":{"type":"string","description":"Naming method for the desktop pool.\nThis property can be used for sorting.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.<br>Network interface card settings for machines provisioned for this desktop. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettings"}},"num_application_sessions":{"type":"integer","description":"Total Number of Application Sessions of the Desktop when applications are associated with it.\n","format":"int32"},"num_sessions":{"type":"integer","description":"Total Number of Sessions on the Desktop.\n","format":"int32"},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsV3"},"provisioning_status_data":{"$ref":"#/components/schemas/DesktopPoolProvisioningStatusDataV2"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect."},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsV4"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning on all machines stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>The transparent page sharing scope.\nThis property can be used for sorting.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the Desktop-pool was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","description":"Count of user or group entitlements present for the desktop pool.\nThis property can be used for sorting.","format":"int32","example":1},"vcenter_id":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>Virtual Center that manages the machines of the desktop pool.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"vcenter_name":{"type":"string","description":"Name of the Virtual Center that manages the machines of the desktop pool.","example":"vcenter.example"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettings"}},"description":"Information related to Desktop Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"DesktopPoolInfoV12":{"required":["entra_sso_enabled"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.<br>Whether assignment of multiple users to a single machine is allowed.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.This property will not be set for dedicated user assignment.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nSupported Filters: Equals.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"application_count":{"type":"integer","description":"Number of applications associated with the desktop","format":"int32","example":2},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"aws_core_desktop_settings":{"$ref":"#/components/schemas/AwsCoreDesktopSettingsV2"},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider<br>Supported Filters: 'Equals'.","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\dir2, dir1\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_brokered":{"type":"boolean","description":"Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the Desktop-pool was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"cs_restriction_tags":{"type":"array","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsV3"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using View Client. If no machine is assigned to the user then \"displayName (No machine assigned)\" will be displayed in the client.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsV2"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled for the desktop pool","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_entitlement_name":{"type":"string","description":"Total Number of Application Sessions on the Desktop.\n"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_source":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Source of image used in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"launch_id":{"type":"string","description":"Launch ID used by clients to connect to the pool."},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"naming_method":{"type":"string","description":"Naming method for the desktop pool.\nThis property can be used for sorting.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.<br>Network interface card settings for machines provisioned for this desktop. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettings"}},"num_application_sessions":{"type":"integer","description":"Total Number of Application Sessions of the Desktop when applications are associated with it.\n","format":"int32"},"num_machines":{"type":"integer","description":"Number of machines associated with the desktop","format":"int32","example":2},"num_sessions":{"type":"integer","description":"Total Number of Sessions on the Desktop.\n","format":"int32"},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsV4"},"provisioning_status_data":{"$ref":"#/components/schemas/DesktopPoolProvisioningStatusDataV3"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect."},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsV4"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning on all machines stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettings"},"supported_domains":{"type":"array","description":"List of domains supported by this desktop pool.","example":["domain1.com","domain2.com"],"items":{"type":"string","description":"List of domains supported by this desktop pool.","example":"[\"domain1.com\",\"domain2.com\"]"}},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>The transparent page sharing scope.\nThis property can be used for sorting.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"uem_server_id":{"type":"string","description":"UEM Server Id.\nSupported Filters: Equals.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"uem_server_label":{"type":"string","description":"UEM Server Label.\nSupported Filters: Equals, StartsWithFilter and ContainsFilter.","example":"uem-server-1"},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the Desktop-pool was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","description":"Count of user or group entitlements present for the desktop pool.\nThis property can be used for sorting.","format":"int32","example":1},"vcenter_id":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>Virtual Center that manages the machines of the desktop pool.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"vcenter_name":{"type":"string","description":"Name of the Virtual Center that manages the machines of the desktop pool.","example":"vcenter.example"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettings"}},"description":"Information related to Desktop Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"DesktopPoolInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.<br>Whether assignment of multiple users to a single machine is allowed.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\dir2, dir1\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettings"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using View Client. If no machine is assigned to the user then \"displayName (No machine assigned)\" will be displayed in the client.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_source":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Source of image used in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.<br>Network interface card settings for machines provisioned for this desktop. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettings"},"provisioning_status_data":{"$ref":"#/components/schemas/DesktopPoolProvisioningStatusData"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsV2"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.The value will be present if categoryFolderName is set.","example":["Desktop"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.The value will be present if categoryFolderName is set.","example":"[\"Desktop\"]"}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning on all machines stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>The transparent page sharing scope.\nThis property can be used for sorting.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>Virtual Center that manages the machines of the desktop pool.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettings"}},"description":"Information related to Desktop Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"DesktopPoolInfoV3":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.<br>Whether assignment of multiple users to a single machine is allowed.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\dir2, dir1\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettings"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using View Client. If no machine is assigned to the user then \"displayName (No machine assigned)\" will be displayed in the client.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_source":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Source of image used in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.<br>Network interface card settings for machines provisioned for this desktop. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettings"},"provisioning_status_data":{"$ref":"#/components/schemas/DesktopPoolProvisioningStatusData"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsV2"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.The value will be present if categoryFolderName is set.","example":["Desktop"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.The value will be present if categoryFolderName is set.","example":"[\"Desktop\"]"}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning on all machines stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>The transparent page sharing scope.\nThis property can be used for sorting.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>Virtual Center that manages the machines of the desktop pool.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettings"}},"description":"Information related to Desktop Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"DesktopPoolInfoV4":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.<br>Whether assignment of multiple users to a single machine is allowed.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\dir2, dir1\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_brokered":{"type":"boolean","description":"Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettings"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using View Client. If no machine is assigned to the user then \"displayName (No machine assigned)\" will be displayed in the client.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_source":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Source of image used in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.<br>Network interface card settings for machines provisioned for this desktop. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettings"},"provisioning_status_data":{"$ref":"#/components/schemas/DesktopPoolProvisioningStatusData"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsV2"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.The value will be present if categoryFolderName is set.","example":["Desktop"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.The value will be present if categoryFolderName is set.","example":"[\"Desktop\"]"}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning on all machines stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>The transparent page sharing scope.\nThis property can be used for sorting.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>Virtual Center that manages the machines of the desktop pool.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettings"}},"description":"Information related to Desktop Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"DesktopPoolInfoV5":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.<br>Whether assignment of multiple users to a single machine is allowed.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\dir2, dir1\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_brokered":{"type":"boolean","description":"Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettings"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using View Client. If no machine is assigned to the user then \"displayName (No machine assigned)\" will be displayed in the client.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_source":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Source of image used in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"naming_method":{"type":"string","description":"Naming method for the desktop pool.\nThis property can be used for sorting.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.<br>Network interface card settings for machines provisioned for this desktop. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettings"},"provisioning_status_data":{"$ref":"#/components/schemas/DesktopPoolProvisioningStatusData"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsV3"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning on all machines stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>The transparent page sharing scope.\nThis property can be used for sorting.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","description":"Count of user or group entitlements present for the desktop pool.\nThis property can be used for sorting.","format":"int32","example":1},"vcenter_id":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>Virtual Center that manages the machines of the desktop pool.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettings"}},"description":"Information related to Desktop Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"DesktopPoolInfoV6":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.<br>Whether assignment of multiple users to a single machine is allowed.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\dir2, dir1\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_brokered":{"type":"boolean","description":"Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettings"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using View Client. If no machine is assigned to the user then \"displayName (No machine assigned)\" will be displayed in the client.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_source":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Source of image used in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"naming_method":{"type":"string","description":"Naming method for the desktop pool.\nThis property can be used for sorting.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.<br>Network interface card settings for machines provisioned for this desktop. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsV2"},"provisioning_status_data":{"$ref":"#/components/schemas/DesktopPoolProvisioningStatusDataV2"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsV3"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning on all machines stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>The transparent page sharing scope.\nThis property can be used for sorting.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","description":"Count of user or group entitlements present for the desktop pool.\nThis property can be used for sorting.","format":"int32","example":1},"vcenter_id":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>Virtual Center that manages the machines of the desktop pool.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettings"}},"description":"Information related to Desktop Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"DesktopPoolInfoV7":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.<br>Whether assignment of multiple users to a single machine is allowed.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\dir2, dir1\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_brokered":{"type":"boolean","description":"Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsV2"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using View Client. If no machine is assigned to the user then \"displayName (No machine assigned)\" will be displayed in the client.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_source":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Source of image used in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"naming_method":{"type":"string","description":"Naming method for the desktop pool.\nThis property can be used for sorting.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.<br>Network interface card settings for machines provisioned for this desktop. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsV2"},"provisioning_status_data":{"$ref":"#/components/schemas/DesktopPoolProvisioningStatusDataV2"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsV3"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning on all machines stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>The transparent page sharing scope.\nThis property can be used for sorting.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","description":"Count of user or group entitlements present for the desktop pool.\nThis property can be used for sorting.","format":"int32","example":1},"vcenter_id":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>Virtual Center that manages the machines of the desktop pool.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettings"}},"description":"Information related to Desktop Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"DesktopPoolInfoV8":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.<br>Whether assignment of multiple users to a single machine is allowed.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.This property will not be set for dedicated user assignment.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\dir2, dir1\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_brokered":{"type":"boolean","description":"Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the Desktop-pool was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"cs_restriction_tags":{"type":"array","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsV3"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using View Client. If no machine is assigned to the user then \"displayName (No machine assigned)\" will be displayed in the client.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_source":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Source of image used in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"naming_method":{"type":"string","description":"Naming method for the desktop pool.\nThis property can be used for sorting.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.<br>Network interface card settings for machines provisioned for this desktop. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsV2"},"provisioning_status_data":{"$ref":"#/components/schemas/DesktopPoolProvisioningStatusDataV2"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsV4"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning on all machines stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>The transparent page sharing scope.\nThis property can be used for sorting.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the Desktop-pool was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","description":"Count of user or group entitlements present for the desktop pool.\nThis property can be used for sorting.","format":"int32","example":1},"vcenter_id":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>Virtual Center that manages the machines of the desktop pool.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettings"}},"description":"Information related to Desktop Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"DesktopPoolInfoV9":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.<br>Whether assignment of multiple users to a single machine is allowed.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.This property will not be set for dedicated user assignment.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\dir2, dir1\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_brokered":{"type":"boolean","description":"Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the Desktop-pool was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"cs_restriction_tags":{"type":"array","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsV3"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the Desktop Pool. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Desktop pool description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using View Client. If no machine is assigned to the user then \"displayName (No machine assigned)\" will be displayed in the client.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Display name of the Desktop Pool. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsV2"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the Desktop Pool is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"Applicable To: RDS desktop pools.<br>Farm needed to create RDS desktop pool.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"global_desktop_entitlement_id":{"type":"string","description":"Global desktop entitlement for this desktop pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.<br>Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing Desktop Pool.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_source":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Source of image used in the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"naming_method":{"type":"string","description":"Naming method for the desktop pool.\nThis property can be used for sorting.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"SPECIFIED","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.<br>Network interface card settings for machines provisioned for this desktop. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsV2"},"provisioning_status_data":{"$ref":"#/components/schemas/DesktopPoolProvisioningStatusDataV2"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsV4"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","description":"Source of the Machines in this Desktop Pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Whether provisioning on all machines stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>The transparent page sharing scope.\nThis property can be used for sorting.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"type":{"type":"string","description":"Type of the desktop pool.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the Desktop-pool was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"user_assignment":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>User assignment scheme.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","description":"Count of user or group entitlements present for the desktop pool.\nThis property can be used for sorting.","format":"int32","example":1},"vcenter_id":{"type":"string","description":"Applicable To: Manual and automated desktop pools.<br>Virtual Center that manages the machines of the desktop pool.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettings"}},"description":"Information related to Desktop Pool.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"DesktopPoolInstantClonePushImageSettings":{"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","description":"Whether to add Virtual TPM device.","example":false},"logoff_policy":{"type":"string","description":"Determines when to perform the operation on machines which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"WAIT_FOR_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"start_time":{"type":"integer","description":"When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time.","format":"int64","example":1587081283000},"stop_on_first_error":{"type":"boolean","description":"Indicates that the operation should stop on first error.","example":true}},"description":"Settings for the push image operation."},"DesktopPoolMetricsInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the desktop pool.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"num_connected_sessions":{"type":"integer","description":"Number of connected sessions of the desktop pool.","format":"int32","example":50},"num_machines":{"type":"integer","description":"Number of machines in the desktop pool.","format":"int32","example":100},"occupancy_count":{"type":"integer","description":"Occupancy count for the desktop pool.\n* For dedicated assignment desktop, it is the number of assigned machine count.\n* For floating assignment desktop, it is the summation of the connected and disconnected sessions.","format":"int32","example":60}},"description":"Metrics related to desktop pool."},"DesktopPoolMetricsInfoV2":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the desktop pool.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"load_index":{"type":"number","description":"Load Index is a number between 0-100 and it indicates the current load on the desktop pool. ","format":"double","example":75.9},"num_connected_sessions":{"type":"integer","description":"Number of connected sessions of the desktop pool.","format":"int32","example":50},"num_machines":{"type":"integer","description":"Number of machines in the desktop pool.","format":"int32","example":100},"occupancy_count":{"type":"integer","description":"Occupancy count for the desktop pool.\n* For dedicated assignment desktop, it is the number of assigned machine count.\n* For floating assignment desktop, it is the summation of the connected and disconnected sessions.","format":"int32","example":60}},"description":"Metrics related to desktop pool."},"DesktopPoolMetricsInfoV3":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the desktop pool.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"load_index":{"type":"number","description":"Load Index is a number between 0-100 and it indicates the current load on the desktop pool. ","format":"double","example":75.9},"num_connected_sessions":{"type":"integer","description":"Number of connected sessions of the desktop pool.","format":"int32","example":50},"num_disconnected_sessions":{"type":"integer","description":"Number of disconnected sessions of the desktop pool.","format":"int32","example":50},"num_idle_sessions":{"type":"integer","description":"Number of idle sessions of the desktop pool.","format":"int32","example":50},"num_machines":{"type":"integer","description":"Number of machines in the desktop pool.","format":"int32","example":100},"occupancy_count":{"type":"integer","description":"Occupancy count for the desktop pool.\n* For dedicated assignment desktop, it is the number of assigned machine count.\n* For floating assignment desktop, it is the summation of the connected and disconnected sessions.","format":"int32","example":60}},"description":"Metrics related to desktop pool."},"DesktopPoolNetworkInterfaceCardSettings":{"type":"object","properties":{"network_interface_card_id":{"type":"string","description":"The network interface card id for these settings.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"network_interface_card_name":{"type":"string","description":"The network interface card name.","example":"Network adapter 1"},"network_label_assignment_specs":{"type":"array","description":"Automatic network label assignment feature settings for this NIC. By default, newly provisioned machines of an automated desktop pool retain their parent image's network labels on each of their network interface cards. In certain circumstances, notably dealing with VLAN subset sizing and DHCP IP address availability, it may be desirable for the desktop pool to instead use different network labels for these newly provisioned machines. This feature allows an administrator to provide a per NIC list of network labels and their maximum availability to be automatically distributed to newly provisioned machines. <br> If this is unset, the feature is disabled.<br> Starting at the alphabetically first network label specification in the list that has not yet been assigned its maximum count for this NIC on this desktop pool, the desktop pool will have its next provisioned machine's NIC assigned that label. If all network labels in this list have reached their maximum count, this desktop pool will have further provisioned machines assigned the last label in the list over capacity, and an error will be logged. Not all labels need be configured. <br> Any changes to these settings will be applicable only to machines provisioned after the change. Already provisioned machines will never have their network label assignments altered by this feature.","items":{"$ref":"#/components/schemas/NetworkLabelAssignmentSettings"}}},"description":"Network interface card settings for machines provisioned for this desktop pool."},"DesktopPoolNetworkInterfaceCardSettingsCreateSpec":{"required":["network_interface_card_id"],"type":"object","properties":{"network_interface_card_id":{"type":"string","description":"The network interface card id for these settings.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"network_label_assignment_specs":{"type":"array","description":"Automatic network label assignment feature settings for this NIC.  If network_label_assignment_specs is not set, nics will be ignored. By default, newly provisioned machines of an automated desktop pool retain their parent image's network labels on each of their network interface cards. In certain circumstances, notably dealing with VLAN subset sizing and DHCP IP address availability, it may be desirable for the desktop pool to instead use different network labels for these newly provisioned machines. This feature allows an administrator to provide a per NIC list of network labels and their maximum availability to be automatically distributed to newly provisioned machines. <br> If this is unset, the feature is disabled.<br> Starting at the alphabetically first network label specification in the list that has not yet been assigned its maximum count for this NIC on this desktop pool, the desktop pool will have its next provisioned machine's NIC assigned that label. If all network labels in this list have reached their maximum count, this desktop pool will have further provisioned machines assigned the last label in the list over capacity, and an error will be logged. Not all labels need be configured. <br>","items":{"$ref":"#/components/schemas/DesktopPoolNetworkLabelAssignmentSettingsCreateSpec"}}},"description":"Applicable To: Instant clone desktop pool. <br> Network interface card settings for machines provisioned for the instant clone desktop pool."},"DesktopPoolNetworkInterfaceCardSettingsUpdateSpec":{"required":["network_interface_card_id"],"type":"object","properties":{"network_interface_card_id":{"type":"string","description":"The network interface card id for these settings.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"network_label_assignment_specs":{"type":"array","description":"Automatic network label assignment feature settings for this NIC. If network_label_assignment_specs is not set, nics will be ignored. By default, newly provisioned machines of an automated desktop pool retain their parent image's network labels on each of their network interface cards. In certain circumstances, notably dealing with VLAN subset sizing and DHCP IP address availability, it may be desirable for the desktop pool to instead use different network labels for these newly provisioned machines. This feature allows an administrator to provide a per NIC list of network labels and their maximum availability to be automatically distributed to newly provisioned machines. <br> If this is unset, the feature is disabled.<br> Starting at the alphabetically first network label specification in the list that has not yet been assigned its maximum count for this NIC on this desktop pool, the desktop pool will have its next provisioned machine's NIC assigned that label. If all network labels in this list have reached their maximum count, this desktop pool will have further provisioned machines assigned the last label in the list over capacity, and an error will be logged. Not all labels need be configured. <br>Any changes to these settings will be applicable only to machines provisioned after the change. Already provisioned machines will never have their network label assignments altered by this feature.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkLabelAssignmentSettingsUpdateSpec"}}},"description":"Applicable To: Instant Clone desktop pool. <br>Network interface card settings for machines provisioned for Instant Clone desktop pool."},"DesktopPoolNetworkLabelAssignmentSettingsCreateSpec":{"required":["max_label_type","network_label_name"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether or not this specification is enabled. While this specification is disabled, automatic network label assigment for this desktop pool will skip over the network label in this spec. <br> Default value is true. <br>","example":true},"max_label":{"minimum":1,"type":"integer","description":"The maximum number of times this network label can be assigned to a machine. <br>","format":"int32","example":1},"max_label_type":{"type":"string","description":"The property specifies whether or not there is a maximum limit to the number of times this label may be assigned to machines within this spec.\n* UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.\n* LIMITED: The network label assignment specification has a limited number of labels to assign.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","description":"The network label name. <br>","example":"vm-network"}},"description":"Specification for an individual network label assignment, stipulating the label and how many times it may be assigned to machines with this spec."},"DesktopPoolNetworkLabelAssignmentSettingsUpdateSpec":{"required":["enabled","max_label_type","network_label_name"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether or not this specification is enabled. While this specification is disabled, automatic network label assigment for this desktop pool will skip over the network label in this spec.","example":true},"max_label":{"minimum":1,"type":"integer","description":"The maximum number of times this label can be assigned to a machine. Note this count only encompasses this spec. That is, this label may be used for other NICs and in other Desktop pools, but those assignments will not be counted towards this total. This count also does not include assignments of this label to machines not under the control of Horizon.","format":"int32","example":1},"max_label_type":{"type":"string","description":"This type specifies whether or not there is a maximum limit to the number of times this label may be assigned to machines within this spec. While this specification is enabled and unlimited, specs after this one in the NIC's network label specification list will never be used.\n* UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.\n* LIMITED: The network label assignment specification has a limited number of labels to assign.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","description":"The network label id for this spec. This network label must not have any incompatibility reasons that would preclude it from automatic machine assignment.","example":"vm-network"}},"description":"Specification for an individual network label assignment, stipulating the label and how many times it may be assigned to machines with this spec."},"DesktopPoolOrFarmDatastoreUsageInfo":{"type":"object","properties":{"desktop_pool_id":{"type":"string","description":"Unique ID representing Desktop Pool.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"farm_id":{"type":"string","description":"Unique ID representing Farm.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"name":{"type":"string","description":"Desktop Pool or Farm name.","example":"ICPool"},"other_datastore_names":{"type":"array","description":"Other datastore(s) in-use for this Desktop pool or Farm.","example":["Datastore1","Datastore2"],"items":{"type":"string","description":"Other datastore(s) in-use for this Desktop pool or Farm.","example":"[\"Datastore1\",\"Datastore2\"]"}},"source":{"type":"string","description":"Source or provisioning type of machines.\n* FULL_CLONE: Virtual Machines created from a vCenter Server template.\n* INSTANT_CLONE: Virtual Machines created by instant clone engine.","example":"INSTANT_CLONE","enum":["FULL_CLONE","INSTANT_CLONE"]},"used_space_in_gb":{"type":"integer","description":"Used capacity of the datastore (in GB) for this Desktop pool or Farm.","format":"int64","example":32},"user_assignment":{"type":"string","description":" User assignment of the Desktop. \n* DEDICATED: Dedicated user assignment.\n* FLOATING: Floating user assignment.","example":"DEDICATED","enum":["DEDICATED","FLOATING"]}},"description":"Desktop Pool or Farm usage information for a given datastore."},"DesktopPoolProvisioningSettings":{"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","description":"Whether to add Virtual TPM device.\nThis property can be used for sorting.","example":false},"base_snapshot_id":{"type":"string","description":"Applicable To: Linked/instant clone automated desktop pools.<br>Base image snapshot for linked clone desktop pool and current image snapshot for instant clone desktop pool.","example":"snapshot-1"},"datacenter_id":{"type":"string","description":"Datacenter within which the desktop pool is configured.","example":"datacenter-1"},"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in.","example":"domain-s425"},"im_stream_id":{"type":"string","description":"Applicable To: Full/instant clone automated desktop pools.<br>Image management stream used in desktop pool when Image Management feature is enabled.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"Applicable To: Full/instant clone automated desktop pools.<br>Image management tag associated with the selected image management stream which is used in desktop pool when Image Management feature is enabled.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"min_ready_vms_on_vcomposer_maintenance":{"type":"integer","description":"Applicable To: Linked clone automated desktop pools.<br>Minimum number of ready (provisioned) machines during View Composer maintenance operations.\nThis property can be used for sorting.","format":"int32","example":10},"parent_vm_id":{"type":"string","description":"Applicable To: Linked/instant clone automated desktop pools.<br>Base image VM for linked clone desktop pool and current image for instant clone desktop pool.","example":"vm-2"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the machines.","example":"resgroup-1"},"vm_folder_id":{"type":"string","description":"VM folder where the machines are deployed to.","example":"group-v1"},"vm_template_id":{"type":"string","description":"Applicable To: Full clone automated desktop pools.<br>Template from which full clone machines are deployed.","example":"vm-1"}},"description":"Virtual Center provisioning settings for the automated desktop pool."},"DesktopPoolProvisioningSettingsCreateSpec":{"required":["host_or_cluster_id","resource_pool_id","vm_folder_id"],"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","description":"Indicates whether to add Virtual TPM device. <br> Default value is false.","example":false},"base_snapshot_id":{"type":"string","description":"This property can be set only when source is set to INSTANT_CLONE, vm_template_id is unset and parent_vm_id is set.","example":"snapshot-1"},"datacenter_id":{"type":"string","description":"Datacenter within which the desktop pool is configured.","example":"datacenter-1"},"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in. <br> For Instant clone desktops it can only be set to a cluster id. <br>","example":"domain-s425"},"im_stream_id":{"type":"string","description":"Applicable To: Automated desktop pools.<br>This is required when vm_template_id, parent_vm_id and base_snapshot_id are not set.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"Applicable To: Automated desktop pools.<br>This is required when im_stream_Id is set.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"parent_vm_id":{"type":"string","description":"This property can be set only when source is set to INSTANT_CLONE.","example":"vm-2"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the machines.","example":"resgroup-1"},"vm_folder_id":{"type":"string","description":"VM folder where the machines are deployed to.","example":"group-v1"},"vm_template_id":{"type":"string","description":"Applicable To: Full clone desktop pools.<br>This is required if parent_vm_id and base_snapshot_id are not set. <br>","example":"vm-1"}},"description":"Applicable To: Automated desktop pool. <br>Virtual center provisioning settings for Automated desktop pool."},"DesktopPoolProvisioningSettingsCreateSpecV2":{"required":["host_or_cluster_id","resource_pool_id","vm_folder_id"],"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","description":"Indicates whether to add Virtual TPM device. <br> Default value is false.","example":false},"base_snapshot_id":{"type":"string","description":"This property can be set only when source is set to INSTANT_CLONE, vm_template_id is unset and parent_vm_id is set.","example":"snapshot-1"},"compute_profile_num_cores_per_socket":{"minimum":1,"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones.\nIf set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set. ","format":"int32","example":1},"compute_profile_num_cpus":{"minimum":1,"type":"integer","description":"Indicates the number of CPUs in the compute profile to be configured on clones.\nIf set, this must be a multiple of compute_profile_num_cores_per_socket.","format":"int32","example":4},"compute_profile_ram_mb":{"minimum":1024,"type":"integer","description":"Indicates the RAM in MB in the compute profile to be configured on clones.","format":"int32","example":4096},"datacenter_id":{"type":"string","description":"Datacenter within which the desktop pool is configured.","example":"datacenter-1"},"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in. <br> For Instant clone desktops it can only be set to a cluster id. <br>","example":"domain-s425"},"im_stream_id":{"type":"string","description":"Applicable To: Automated desktop pools.<br>This is required when vm_template_id, parent_vm_id and base_snapshot_id are not set.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"Applicable To: Automated desktop pools.<br>This is required when im_stream_Id is set.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"parent_vm_id":{"type":"string","description":"This property can be set only when source is set to INSTANT_CLONE.","example":"vm-2"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the machines.","example":"resgroup-1"},"vm_folder_id":{"type":"string","description":"VM folder where the machines are deployed to.","example":"group-v1"},"vm_template_id":{"type":"string","description":"Applicable To: Full clone desktop pools.<br>This is required if parent_vm_id and base_snapshot_id are not set. <br>","example":"vm-1"}},"description":"Virtual center provisioning settings for automated desktop pool"},"DesktopPoolProvisioningSettingsUpdateSpec":{"required":["host_or_cluster_id","resource_pool_id"],"type":"object","properties":{"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in.","example":"domain-s425"},"im_stream_id":{"type":"string","description":"Applicable To: Full clone desktop pools.<br> This is required when vm_template_id is not set.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"Applicable To: Full clone desktop pools.<br> This is required when im_stream_id is set.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the machines.","example":"resgroup-1"},"vm_template_id":{"type":"string","description":"Applicable To: Full clone desktop pools.<br>Template from which full clone machines are deployed.","example":"vm-1"}},"description":"Applicable To: Automated desktop pool. <br>Virtual Center provisioning settings for automated desktop pool."},"DesktopPoolProvisioningSettingsV2":{"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","description":"Whether to add Virtual TPM device.\nThis property can be used for sorting.","example":false},"base_snapshot_id":{"type":"string","description":"Applicable To: Linked/instant clone automated desktop pools.<br>Base image snapshot for linked clone desktop pool and current image snapshot for instant clone desktop pool.","example":"snapshot-1"},"compute_profile_num_cores_per_socket":{"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile configured on clones.","format":"int32","example":1},"compute_profile_num_cpus":{"type":"integer","description":"Indicates the number of CPUs in the compute profile configured on clones.","format":"int32","example":4},"compute_profile_ram_mb":{"type":"integer","description":"Indicates the RAM in MB in the compute profile configured on clones.","format":"int32","example":4096},"datacenter_id":{"type":"string","description":"Datacenter within which the desktop pool is configured.","example":"datacenter-1"},"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in.","example":"domain-s425"},"im_stream_id":{"type":"string","description":"Applicable To: Full/instant clone automated desktop pools.<br>Image management stream used in desktop pool when Image Management feature is enabled.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"Applicable To: Full/instant clone automated desktop pools.<br>Image management tag associated with the selected image management stream which is used in desktop pool when Image Management feature is enabled.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"min_ready_vms_on_vcomposer_maintenance":{"type":"integer","description":"Applicable To: Linked clone automated desktop pools.<br>Minimum number of ready (provisioned) machines during View Composer maintenance operations.\nThis property can be used for sorting.","format":"int32","example":10},"parent_vm_id":{"type":"string","description":"Applicable To: Linked/instant clone automated desktop pools.<br>Base image VM for linked clone desktop pool and current image for instant clone desktop pool.","example":"vm-2"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the machines.","example":"resgroup-1"},"vm_folder_id":{"type":"string","description":"VM folder where the machines are deployed to.","example":"group-v1"},"vm_template_id":{"type":"string","description":"Applicable To: Full clone automated desktop pools.<br>Template from which full clone machines are deployed.","example":"vm-1"}},"description":"Virtual Center provisioning settings for the automated desktop pool."},"DesktopPoolProvisioningSettingsV3":{"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","description":"Whether to add Virtual TPM device.\nThis property can be used for sorting.","example":false},"base_snapshot_id":{"type":"string","description":"Applicable To: Linked/instant clone automated desktop pools.<br>Base image snapshot for linked clone desktop pool and current image snapshot for instant clone desktop pool.","example":"snapshot-1"},"compute_profile_num_cores_per_socket":{"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile configured on clones.","format":"int32","example":1},"compute_profile_num_cpus":{"type":"integer","description":"Indicates the number of CPUs in the compute profile configured on clones.","format":"int32","example":4},"compute_profile_ram_mb":{"type":"integer","description":"Indicates the RAM in MB in the compute profile configured on clones.","format":"int32","example":4096},"datacenter_id":{"type":"string","description":"Datacenter within which the desktop pool is configured.","example":"datacenter-1"},"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in.","example":"domain-s425"},"host_or_cluster_path":{"type":"string"},"im_stream_id":{"type":"string","description":"Applicable To: Full/instant clone automated desktop pools.<br>Image management stream used in desktop pool when Image Management feature is enabled.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_stream_name":{"type":"string","description":"Name of Image management stream used in desktop pool when Image Management feature is enabled.<br>"},"im_tag_id":{"type":"string","description":"Applicable To: Full/instant clone automated desktop pools.<br>Image management tag associated with the selected image management stream which is used in desktop pool when Image Management feature is enabled.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_name":{"type":"string","description":"Name of Image management tag associated with the selected image management stream which is used.\n"},"min_ready_vms_on_vcomposer_maintenance":{"type":"integer","description":"Applicable To: Linked clone automated desktop pools.<br>Minimum number of ready (provisioned) machines during View Composer maintenance operations.\nThis property can be used for sorting.","format":"int32","example":10},"parent_vm_id":{"type":"string","description":"Applicable To: Linked/instant clone automated desktop pools.<br>Base image VM for linked clone desktop pool and current image for instant clone desktop pool.","example":"vm-2"},"parent_vm_path":{"type":"string","description":"Base image VM Path for instant clone desktop pool.\n"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the machines.","example":"resgroup-1"},"resource_pool_path":{"type":"string","description":"Resource pool path to deploy the machines.\n"},"snapshot_path":{"type":"string","description":"current image snapshot path for instant clone desktop pool."},"template_path":{"type":"string","description":"Template Path from which full clone machines are deployed.\n"},"vm_folder_id":{"type":"string","description":"VM folder where the machines are deployed to.","example":"group-v1"},"vm_folder_path":{"type":"string","description":"VM folder path where the machines are deployed to.\n"},"vm_template_id":{"type":"string","description":"Applicable To: Full clone automated desktop pools.<br>Template from which full clone machines are deployed.","example":"vm-1"}},"description":"Virtual Center provisioning settings for the automated desktop pool."},"DesktopPoolProvisioningSettingsV4":{"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","description":"Whether to add Virtual TPM device.\nThis property can be used for sorting.","example":false},"base_snapshot_id":{"type":"string","description":"Applicable To: Linked/instant clone automated desktop pools.<br>Base image snapshot for linked clone desktop pool and current image snapshot for instant clone desktop pool.","example":"snapshot-1"},"compute_profile_num_cores_per_socket":{"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile configured on clones.","format":"int32","example":1},"compute_profile_num_cpus":{"type":"integer","description":"Indicates the number of CPUs in the compute profile configured on clones.","format":"int32","example":4},"compute_profile_ram_mb":{"type":"integer","description":"Indicates the RAM in MB in the compute profile configured on clones.","format":"int32","example":4096},"customization_spec_name":{"type":"string","description":"Name of the customization spec.","example":"cust-spec-name"},"datacenter_id":{"type":"string","description":"Datacenter within which the desktop pool is configured.","example":"datacenter-1"},"datacenter_name":{"type":"string","description":"Name of the data center of the Machines","example":"dataCenterName-1"},"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in.","example":"domain-s425"},"host_or_cluster_path":{"type":"string"},"im_stream_id":{"type":"string","description":"Applicable To: Full/instant clone automated desktop pools.<br>Image management stream used in desktop pool when Image Management feature is enabled.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_stream_name":{"type":"string","description":"Name of Image management stream used in desktop pool when Image Management feature is enabled.<br>"},"im_tag_id":{"type":"string","description":"Applicable To: Full/instant clone automated desktop pools.<br>Image management tag associated with the selected image management stream which is used in desktop pool when Image Management feature is enabled.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_name":{"type":"string","description":"Name of Image management tag associated with the selected image management stream which is used.\n"},"min_ready_vms_on_vcomposer_maintenance":{"type":"integer","description":"Applicable To: Linked clone automated desktop pools.<br>Minimum number of ready (provisioned) machines during View Composer maintenance operations.\nThis property can be used for sorting.","format":"int32","example":10},"parent_vm_id":{"type":"string","description":"Applicable To: Linked/instant clone automated desktop pools.<br>Base image VM for linked clone desktop pool and current image for instant clone desktop pool.","example":"vm-2"},"parent_vm_path":{"type":"string","description":"Base image VM Path for instant clone desktop pool.\n"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the machines.","example":"resgroup-1"},"resource_pool_path":{"type":"string","description":"Resource pool path to deploy the machines.\n"},"snapshot_path":{"type":"string","description":"current image snapshot path for instant clone desktop pool."},"template_path":{"type":"string","description":"Template Path from which full clone machines are deployed.\n"},"vm_folder_id":{"type":"string","description":"VM folder where the machines are deployed to.","example":"group-v1"},"vm_folder_path":{"type":"string","description":"VM folder path where the machines are deployed to.\n"},"vm_template_id":{"type":"string","description":"Applicable To: Full clone automated desktop pools.<br>Template from which full clone machines are deployed.","example":"vm-1"}},"description":"Virtual Center provisioning settings for the automated desktop pool."},"DesktopPoolProvisioningStatusData":{"type":"object","properties":{"instant_clone_current_image_state":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>This represents the state of the current image of this instant clone desktop pool.\nThis property can be used for sorting.\n* FAILED: This is the state of the current image if instant clone delete operation has failed or timed out.\n* PENDING_UNPUBLISH: This is the state of the current image before instant clone delete or cluster edit or datastore(s) edit operation(s) begins.\n* READY: This is the state of the current image after successful completion of creation operation. At this stage the current image is ready to be used to create the instant clones. Please note that this state is also reached from UNPUBLISHING state on successful completion of editing of cluster or editing of datastore(s) operations.\n* UNPUBLISHING: This is the transient state of the current image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","enum":["FAILED","PENDING_UNPUBLISH","READY","UNPUBLISHING"]},"instant_clone_operation":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>The operation that this instant clone desktop pool is undergoing.\nThis property can be used for sorting.\n* CANCEL_SCHEDULED_PUSH_IMAGE: The scheduled push operation on the desktop pool is being cancelled.\n* FINAL_UNPUBLISH: A desktop pool has been deleted and is undergoing final unpublishing.\n* INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the desktop pool.\n* INITIAL_PUBLISH: The desktop pool has just been created and is undergoing initial publishing.\n* NONE: There is no current operation on the desktop pool.\n* SCHEDULE_PUSH_IMAGE: The push operation is scheduled on the desktop pool.","example":"NONE","enum":["CANCEL_SCHEDULED_PUSH_IMAGE","FINAL_UNPUBLISH","INFRASTRUCTURE_CHANGE","INITIAL_PUBLISH","NONE","SCHEDULE_PUSH_IMAGE"]},"instant_clone_pending_im_stream_id":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending image management stream for instant clone desktop pools.<br>Supported Filters: 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"instant_clone_pending_im_tag_id":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending image management tag for instant clone desktop pools<br>Supported Filters: 'Equals'.","example":"e9896e51-48a2-4d82-ae9e-a0246981b484"},"instant_clone_pending_image_error":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>This represents the error message if publishing of push image operation is failed.\nThis property can be used for sorting.","example":"Could not authenticate with domain administrator credentials"},"instant_clone_pending_image_parent_vm_id":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending base image VM for instant clone desktop pools. This is used to return the information about the parent VM of the pending Image.","example":"vm-1"},"instant_clone_pending_image_progress":{"type":"integer","description":"Applicable To: instant clone automated desktop pools.<br>This represents the pending image publish progress in percentage for an instant clone desktop pool.\nThis property can be used for sorting.","format":"int32","example":10},"instant_clone_pending_image_snapshot_id":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending base image snapshot for instant clone desktop pools. This is used to return the information about the snapshot of the pending image.","example":"snapshot-1"},"instant_clone_pending_image_state":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>This represents the state of the pending image of this instant clone desktop pool. This will be null when there is no pending image for the desktop pool.\nThis property can be used for sorting.\n* FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.\n* PENDING_PUBLISH: This is the initial transient state of the pending image before instant clone creation operation has started.\n* PUBLISHING: This is the transient state of the pending image when creation of instant clone operation is going on.\n* READY: This is the state of the pending image after successful publish of the pending image and before that image has been upgraded to the current image. This is normally seen after successful publish for a push image which has been scheduled to trigger at a later time.\n* READY_HELD: This is the state of the pending image after performing a selective resync operation, in which the image may be applied to some VMs in the desktop pool/farm.\n* UNPUBLISHING: This is the transient state of the pending image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"FAILED","enum":["FAILED","PENDING_PUBLISH","PUBLISHING","READY","READY_HELD","UNPUBLISHING"]},"instant_clone_push_image_settings":{"$ref":"#/components/schemas/DesktopPoolInstantClonePushImageSettings"},"last_provisioning_error":{"type":"string","description":"String message detailing the last provisioning error on this desktop pool while stop_provisioning_on_error is enabled. This will be cleared when enable_provisioning is updated to true.\nThis property can be used for sorting.","example":"Initial publish failed: Could not authenticate with domain administrator credentials"},"last_provisioning_error_time":{"type":"integer","description":"Time the last provisioning error occurred on this desktop while stop_provisioning_on_error is enabled. This will be cleared when enable_provisioning is updated to true. Measured as epoch time.\nThis property can be used for sorting.","format":"int64","example":1587081283000}},"description":"Provisioning status data about this automated desktop pool."},"DesktopPoolProvisioningStatusDataV2":{"type":"object","properties":{"instant_clone_current_image_state":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>This represents the state of the current image of this instant clone desktop pool.\nThis property can be used for sorting.\n* FAILED: This is the state of the current image if instant clone delete operation has failed or timed out.\n* PENDING_UNPUBLISH: This is the state of the current image before instant clone delete or cluster edit or datastore(s) edit operation(s) begins.\n* READY: This is the state of the current image after successful completion of creation operation. At this stage the current image is ready to be used to create the instant clones. Please note that this state is also reached from UNPUBLISHING state on successful completion of editing of cluster or editing of datastore(s) operations.\n* UNPUBLISHING: This is the transient state of the current image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","enum":["FAILED","PENDING_UNPUBLISH","READY","UNPUBLISHING"]},"instant_clone_operation":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>The operation that this instant clone desktop pool is undergoing.\nThis property can be used for sorting.\n* CANCEL_SCHEDULED_PUSH_IMAGE: The scheduled push operation on the desktop pool is being cancelled.\n* FINAL_UNPUBLISH: A desktop pool has been deleted and is undergoing final unpublishing.\n* INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the desktop pool.\n* INITIAL_PUBLISH: The desktop pool has just been created and is undergoing initial publishing.\n* NONE: There is no current operation on the desktop pool.\n* SCHEDULE_PUSH_IMAGE: The push operation is scheduled on the desktop pool.","example":"NONE","enum":["CANCEL_SCHEDULED_PUSH_IMAGE","FINAL_UNPUBLISH","INFRASTRUCTURE_CHANGE","INITIAL_PUBLISH","NONE","SCHEDULE_PUSH_IMAGE"]},"instant_clone_pending_im_stream_id":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending image management stream for instant clone desktop pools.<br>Supported Filters: 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"instant_clone_pending_im_tag_id":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending image management tag for instant clone desktop pools<br>Supported Filters: 'Equals'.","example":"e9896e51-48a2-4d82-ae9e-a0246981b484"},"instant_clone_pending_image_error":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>This represents the error message if publishing of push image operation is failed.\nThis property can be used for sorting.","example":"Could not authenticate with domain administrator credentials"},"instant_clone_pending_image_parent_vm_id":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending base image VM for instant clone desktop pools. This is used to return the information about the parent VM of the pending Image.","example":"vm-1"},"instant_clone_pending_image_progress":{"type":"integer","description":"Applicable To: instant clone automated desktop pools.<br>This represents the pending image publish progress in percentage for an instant clone desktop pool.\nThis property can be used for sorting.","format":"int32","example":10},"instant_clone_pending_image_snapshot_id":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending base image snapshot for instant clone desktop pools. This is used to return the information about the snapshot of the pending image.","example":"snapshot-1"},"instant_clone_pending_image_state":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>This represents the state of the pending image of this instant clone desktop pool. This will be null when there is no pending image for the desktop pool.\nThis property can be used for sorting.\n* FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.\n* PENDING_PUBLISH: This is the initial transient state of the pending image before instant clone creation operation has started.\n* PUBLISHING: This is the transient state of the pending image when creation of instant clone operation is going on.\n* READY: This is the state of the pending image after successful publish of the pending image and before that image has been upgraded to the current image. This is normally seen after successful publish for a push image which has been scheduled to trigger at a later time.\n* READY_HELD: This is the state of the pending image after performing a selective resync operation, in which the image may be applied to some VMs in the desktop pool/farm.\n* UNPUBLISHING: This is the transient state of the pending image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"FAILED","enum":["FAILED","PENDING_PUBLISH","PUBLISHING","READY","READY_HELD","UNPUBLISHING"]},"instant_clone_push_image_settings":{"$ref":"#/components/schemas/DesktopPoolInstantClonePushImageSettings"},"last_provisioning_error":{"type":"string","description":"String message detailing the last provisioning error on this desktop pool while stop_provisioning_on_error is enabled. This will be cleared when enable_provisioning is updated to true.\nThis property can be used for sorting.","example":"Initial publish failed: Could not authenticate with domain administrator credentials"},"last_provisioning_error_time":{"type":"integer","description":"Time the last provisioning error occurred on this desktop while stop_provisioning_on_error is enabled. This will be cleared when enable_provisioning is updated to true. Measured as epoch time.\nThis property can be used for sorting.","format":"int64","example":1587081283000},"pending_compute_profile_num_cores_per_socket":{"type":"integer","description":"Indicates the pending number of cores per socket for the CPU in the compute profile configured on clones.","format":"int32","example":1},"pending_compute_profile_num_cpus":{"type":"integer","description":"Indicates the pending number of CPUs in the compute profile configured on clones.","format":"int32","example":4},"pending_compute_profile_ram_mb":{"type":"integer","description":"Indicates the pending RAM in MB in the compute profile configured on clones.","format":"int32","example":4096}},"description":"Provisioning status data about this automated desktop pool."},"DesktopPoolProvisioningStatusDataV3":{"type":"object","properties":{"instant_clone_current_image_state":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>This represents the state of the current image of this instant clone desktop pool.\nThis property can be used for sorting.\n* FAILED: This is the state of the current image if instant clone delete operation has failed or timed out.\n* PENDING_UNPUBLISH: This is the state of the current image before instant clone delete or cluster edit or datastore(s) edit operation(s) begins.\n* READY: This is the state of the current image after successful completion of creation operation. At this stage the current image is ready to be used to create the instant clones. Please note that this state is also reached from UNPUBLISHING state on successful completion of editing of cluster or editing of datastore(s) operations.\n* UNPUBLISHING: This is the transient state of the current image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","enum":["FAILED","PENDING_UNPUBLISH","READY","UNPUBLISHING"]},"instant_clone_operation":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>The operation that this instant clone desktop pool is undergoing.\nThis property can be used for sorting.\n* CANCEL_SCHEDULED_PUSH_IMAGE: The scheduled push operation on the desktop pool is being cancelled.\n* FINAL_UNPUBLISH: A desktop pool has been deleted and is undergoing final unpublishing.\n* INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the desktop pool.\n* INITIAL_PUBLISH: The desktop pool has just been created and is undergoing initial publishing.\n* NONE: There is no current operation on the desktop pool.\n* SCHEDULE_PUSH_IMAGE: The push operation is scheduled on the desktop pool.","example":"NONE","enum":["CANCEL_SCHEDULED_PUSH_IMAGE","FINAL_UNPUBLISH","INFRASTRUCTURE_CHANGE","INITIAL_PUBLISH","NONE","SCHEDULE_PUSH_IMAGE"]},"instant_clone_pending_im_stream_id":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending image management stream for instant clone desktop pools.<br>Supported Filters: 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"instant_clone_pending_im_stream_name":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending image management stream for instant clone desktop pools.<br>Supported Filters: 'Equals'.","example":"Stream1"},"instant_clone_pending_im_tag_id":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending image management tag for instant clone desktop pools<br>Supported Filters: 'Equals'.","example":"e9896e51-48a2-4d82-ae9e-a0246981b484"},"instant_clone_pending_im_tag_name":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending image management tag for instant clone desktop pools<br>Supported Filters: 'Equals'.","example":"tag1"},"instant_clone_pending_image_error":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>This represents the error message if publishing of push image operation is failed.\nThis property can be used for sorting.","example":"Could not authenticate with domain administrator credentials"},"instant_clone_pending_image_parent_vm_id":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending base image VM for instant clone desktop pools. This is used to return the information about the parent VM of the pending Image.","example":"vm-1"},"instant_clone_pending_image_parent_vm_path":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending base image VM for instant clone desktop pools. This is used to return the parent VM path of the pending Image.","example":"folder/vm-1"},"instant_clone_pending_image_progress":{"type":"integer","description":"Applicable To: instant clone automated desktop pools.<br>This represents the pending image publish progress in percentage for an instant clone desktop pool.\nThis property can be used for sorting.","format":"int32","example":10},"instant_clone_pending_image_snapshot_id":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending base image snapshot for instant clone desktop pools. This is used to return the information about the snapshot of the pending image.","example":"snapshot-1"},"instant_clone_pending_image_snapshot_path":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>Pending base image snapshot for instant clone desktop pools. This is used to return the snapshot path of the pending image.","example":"folder/snapshot-1"},"instant_clone_pending_image_state":{"type":"string","description":"Applicable To: instant clone automated desktop pools.<br>This represents the state of the pending image of this instant clone desktop pool. This will be null when there is no pending image for the desktop pool.\nThis property can be used for sorting.\n* FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.\n* PENDING_PUBLISH: This is the initial transient state of the pending image before instant clone creation operation has started.\n* PUBLISHING: This is the transient state of the pending image when creation of instant clone operation is going on.\n* READY: This is the state of the pending image after successful publish of the pending image and before that image has been upgraded to the current image. This is normally seen after successful publish for a push image which has been scheduled to trigger at a later time.\n* READY_HELD: This is the state of the pending image after performing a selective resync operation, in which the image may be applied to some VMs in the desktop pool/farm.\n* UNPUBLISHING: This is the transient state of the pending image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"FAILED","enum":["FAILED","PENDING_PUBLISH","PUBLISHING","READY","READY_HELD","UNPUBLISHING"]},"instant_clone_push_image_settings":{"$ref":"#/components/schemas/DesktopPoolInstantClonePushImageSettings"},"last_provisioning_error":{"type":"string","description":"String message detailing the last provisioning error on this desktop pool while stop_provisioning_on_error is enabled. This will be cleared when enable_provisioning is updated to true.\nThis property can be used for sorting.","example":"Initial publish failed: Could not authenticate with domain administrator credentials"},"last_provisioning_error_time":{"type":"integer","description":"Time the last provisioning error occurred on this desktop while stop_provisioning_on_error is enabled. This will be cleared when enable_provisioning is updated to true. Measured as epoch time.\nThis property can be used for sorting.","format":"int64","example":1587081283000},"pending_compute_profile_num_cores_per_socket":{"type":"integer","description":"Indicates the pending number of cores per socket for the CPU in the compute profile configured on clones.","format":"int32","example":1},"pending_compute_profile_num_cpus":{"type":"integer","description":"Indicates the pending number of CPUs in the compute profile configured on clones.","format":"int32","example":4},"pending_compute_profile_ram_mb":{"type":"integer","description":"Indicates the pending RAM in MB in the compute profile configured on clones.","format":"int32","example":4096}},"description":"Provisioning status data about this automated desktop pool."},"DesktopPoolPushImageSettings":{"type":"object","properties":{"logoff_policy":{"type":"string","description":"Determines when to perform the operation on machines which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"WAIT_FOR_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"start_time":{"type":"integer","description":"When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time.","format":"int64","example":1587081283000},"stop_on_first_error":{"type":"boolean","description":"Indicates that the operation should stop on first error.","example":true}},"description":"Settings for the push image operation."},"DesktopPoolPushImageSpec":{"required":["logoff_policy"],"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","description":"Indicates whether to add Virtual TPM device. Default: false","example":false},"im_stream_id":{"type":"string","description":"New image management stream for the desktop pool.<br>Either parent VM and snapshot or image management stream and tag are to be specified.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"New image management tag for the desktop pool. This must be a tag of the image management stream.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"logoff_policy":{"type":"string","description":"Determines when to perform the operation on machines which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"WAIT_FOR_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"parent_vm_id":{"type":"string","description":"New base image virtual machine for the desktop pool. This must be in the same datacenter as the base image of the desktop pool.<br>Either parent VM and snapshot or image management stream and tag are to be specified.","example":"vm-1"},"snapshot_id":{"type":"string","description":"New base image snapshot for the desktop pool. This must be a snapshot of the parent VM.","example":"snapshot-1"},"start_time":{"type":"integer","description":"When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time.","format":"int64","example":1587081283000},"stop_on_first_error":{"type":"boolean","description":"Indicates that the operation should stop on first error. Default: true","example":true}},"description":"Specification for the push image operation."},"DesktopPoolPushImageSpecV2":{"required":["logoff_policy"],"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","description":"Indicates whether to add Virtual TPM device. Default: false","example":false},"compute_profile_num_cores_per_socket":{"minimum":1,"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones. \nIf set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set. ","format":"int32","example":1},"compute_profile_num_cpus":{"minimum":1,"type":"integer","description":"Indicates the number of CPUs in the compute profile to be configured on clones. \nIf set, this must be a multiple of compute_profile_num_cores_per_socket.","format":"int32","example":4},"compute_profile_ram_mb":{"minimum":1024,"type":"integer","description":"Indicates the RAM in MB in the compute profile to be configured on clones.","format":"int32","example":4096},"im_stream_id":{"type":"string","description":"New image management stream for the desktop pool.<br>Either parent VM and snapshot or image management stream and tag are to be specified.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"New image management tag for the desktop pool. This must be a tag of the image management stream.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"logoff_policy":{"type":"string","description":"Determines when to perform the operation on machines which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"WAIT_FOR_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"machine_ids":{"uniqueItems":true,"type":"array","description":"Set of machines from the desktop pool on which the new image is to be applied. This can be set when selective_push_image is set to true.","example":["816d44cb-b486-3c97-adcb-cf3806d53657","414927f3-1a3b-3e4c-81b3-d39602f634dc"],"items":{"type":"string","description":"Set of machines from the desktop pool on which the new image is to be applied. This can be set when selective_push_image is set to true.","example":"[\"816d44cb-b486-3c97-adcb-cf3806d53657\",\"414927f3-1a3b-3e4c-81b3-d39602f634dc\"]"}},"parent_vm_id":{"type":"string","description":"New base image virtual machine for the desktop pool. This must be in the same datacenter as the base image of the desktop pool.<br>Either parent VM and snapshot or image management stream and tag are to be specified.","example":"vm-1"},"selective_push_image":{"type":"boolean","description":"Indicates whether selective push image is to be applied. If set to true, the new image will be applied to specified machine_ids in the desktop pool. The image published with this option will be held as a pending image, unless it is promoted or cancelled. The default value is false.","example":true},"snapshot_id":{"type":"string","description":"New base image snapshot for the desktop pool. This must be a snapshot of the parent VM.","example":"snapshot-1"},"start_time":{"type":"integer","description":"When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time.","format":"int64","example":1587081283000},"stop_on_first_error":{"type":"boolean","description":"Indicates that the operation should stop on first error. Default: true","example":true}},"description":"Specification for the push image operation."},"DesktopPoolPushImageSpecV3":{"required":["logoff_policy"],"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","description":"Indicates whether to add Virtual TPM device. Default: false","example":false},"compute_profile_num_cores_per_socket":{"minimum":1,"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones. \nIf set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set. ","format":"int32","example":1},"compute_profile_num_cpus":{"minimum":1,"type":"integer","description":"Indicates the number of CPUs in the compute profile to be configured on clones. \nIf set, this must be a multiple of compute_profile_num_cores_per_socket.","format":"int32","example":4},"compute_profile_ram_mb":{"minimum":1024,"type":"integer","description":"Indicates the RAM in MB in the compute profile to be configured on clones.","format":"int32","example":4096},"grid_vgpus_enabled":{"type":"boolean","description":"When 3D rendering is managed by the vSphere Client, this enables support for NVIDIA GRID vGPUs. This will be false if 3D rendering is not managed by the vSphere Client. If this is true, the host or cluster associated with the desktop pool must support NVIDIA GRID and vGPU types required by the desktop pool's VirtualMachines, VmTemplate or BaseImageSnapshot. If this is false, the desktop pool's VirtualMachines, VmTemplate or BaseImageSnapshot must not support NVIDIA GRID vGPUs. Since suspending VMs with passthrough devices such as vGPUs is not possible, power_policy cannot be set to SUSPEND if this is enabled. Default value is false.","example":false},"im_stream_id":{"type":"string","description":"New image management stream for the desktop pool.<br>Either parent VM and snapshot or image management stream and tag are to be specified.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"New image management tag for the desktop pool. This must be a tag of the image management stream.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"logoff_policy":{"type":"string","description":"Determines when to perform the operation on machines which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"WAIT_FOR_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"machine_ids":{"uniqueItems":true,"type":"array","description":"Set of machines from the desktop pool on which the new image is to be applied. This can be set when selective_push_image is set to true.","example":["816d44cb-b486-3c97-adcb-cf3806d53657","414927f3-1a3b-3e4c-81b3-d39602f634dc"],"items":{"type":"string","description":"Set of machines from the desktop pool on which the new image is to be applied. This can be set when selective_push_image is set to true.","example":"[\"816d44cb-b486-3c97-adcb-cf3806d53657\",\"414927f3-1a3b-3e4c-81b3-d39602f634dc\"]"}},"parent_vm_id":{"type":"string","description":"New base image virtual machine for the desktop pool. This must be in the same datacenter as the base image of the desktop pool.<br>Either parent VM and snapshot or image management stream and tag are to be specified.","example":"vm-1"},"selective_push_image":{"type":"boolean","description":"Indicates whether selective push image is to be applied. If set to true, the new image will be applied to specified machine_ids in the desktop pool. The image published with this option will be held as a pending image, unless it is promoted or cancelled. The default value is false.","example":true},"snapshot_id":{"type":"string","description":"New base image snapshot for the desktop pool. This must be a snapshot of the parent VM.","example":"snapshot-1"},"start_time":{"type":"integer","description":"When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time.","format":"int64","example":1587081283000},"stop_on_first_error":{"type":"boolean","description":"Indicates that the operation should stop on first error. Default: true","example":true},"vgpu_grid_profile":{"type":"string","description":"vGPU Grid Profile.","example":"grid_m10-4q"}},"description":"Specification for the push image operation."},"DesktopPoolPushImageSpecV4":{"required":["logoff_policy"],"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","description":"Indicates whether to add Virtual TPM device. Default: false","example":false},"bundle_id":{"type":"string","description":"Indicates AWS core bundle ID","example":"wdy-hv3qhyzb2"},"compute_profile_num_cores_per_socket":{"minimum":1,"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones. \nIf set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set. ","format":"int32","example":1},"compute_profile_num_cpus":{"minimum":1,"type":"integer","description":"Indicates the number of CPUs in the compute profile to be configured on clones. \nIf set, this must be a multiple of compute_profile_num_cores_per_socket.","format":"int32","example":4},"compute_profile_ram_mb":{"minimum":1024,"type":"integer","description":"Indicates the RAM in MB in the compute profile to be configured on clones.","format":"int32","example":4096},"grid_vgpus_enabled":{"type":"boolean","description":"When 3D rendering is managed by the vSphere Client, this enables support for NVIDIA GRID vGPUs. This will be false if 3D rendering is not managed by the vSphere Client. If this is true, the host or cluster associated with the desktop pool must support NVIDIA GRID and vGPU types required by the desktop pool's VirtualMachines, VmTemplate or BaseImageSnapshot. If this is false, the desktop pool's VirtualMachines, VmTemplate or BaseImageSnapshot must not support NVIDIA GRID vGPUs. Since suspending VMs with passthrough devices such as vGPUs is not possible, power_policy cannot be set to SUSPEND if this is enabled. Default value is false.","example":false},"im_stream_id":{"type":"string","description":"New image management stream for the desktop pool.<br>Either parent VM and snapshot or image management stream and tag are to be specified.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"New image management tag for the desktop pool. This must be a tag of the image management stream.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_id":{"type":"string","description":"Indicates AWS core image ID","example":"wsi-1ba58xt01"},"logoff_policy":{"type":"string","description":"Determines when to perform the operation on machines which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"WAIT_FOR_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"machine_ids":{"uniqueItems":true,"type":"array","description":"Set of machines from the desktop pool on which the new image is to be applied. This can be set when selective_push_image is set to true.","example":["816d44cb-b486-3c97-adcb-cf3806d53657","414927f3-1a3b-3e4c-81b3-d39602f634dc"],"items":{"type":"string","description":"Set of machines from the desktop pool on which the new image is to be applied. This can be set when selective_push_image is set to true.","example":"[\"816d44cb-b486-3c97-adcb-cf3806d53657\",\"414927f3-1a3b-3e4c-81b3-d39602f634dc\"]"}},"parent_vm_id":{"type":"string","description":"New base image virtual machine for the desktop pool. This must be in the same datacenter as the base image of the desktop pool.<br>Either parent VM and snapshot or image management stream and tag are to be specified.","example":"vm-1"},"selective_push_image":{"type":"boolean","description":"Indicates whether selective push image is to be applied. If set to true, the new image will be applied to specified machine_ids in the desktop pool. The image published with this option will be held as a pending image, unless it is promoted or cancelled. The default value is false.","example":true},"snapshot_id":{"type":"string","description":"New base image snapshot for the desktop pool. This must be a snapshot of the parent VM.","example":"snapshot-1"},"start_time":{"type":"integer","description":"When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time.","format":"int64","example":1587081283000},"stop_on_first_error":{"type":"boolean","description":"Indicates that the operation should stop on first error. Default: true","example":true},"vgpu_grid_profile":{"type":"string","description":"vGPU Grid Profile.","example":"grid_m10-4q"}},"description":"Specification for the push image operation."},"DesktopPoolQuickprepCustomizationSettings":{"type":"object","properties":{"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"post_synchronization_script_path":{"type":"string","description":"Post synchronization script. QuickPrep can run a customization script on linked-clone machines after they are created, recomposed, and refreshed. Provide the path to the script on the parent virtual machine.","example":"quickprep_postsync_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"},"power_off_script_path":{"type":"string","description":"Power off script. QuickPrep can run a customization script on linked-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"quickprep_poweroff_script"}},"description":"Settings for QuickPrep customization."},"DesktopPoolSessionSettings":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false.\nThis property can be used for sorting.","example":false},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false.\nThis property can be used for sorting.","example":false},"delete_or_refresh_machine_after_logoff":{"type":"string","description":"Whether machines are to be deleted or refreshed after logoff in case of Floating User Assignment.This is applicable for automated desktops with virtual machines names based onpattern naming. This is not applicable for desktops that are using specified naming since dynamic creation and deletion of VMs is not supported.For Instant clone desktops this setting can only be set to DELETE. Default value is NEVER.\nThis property can be used for sorting.\n* DELETE: Delete the machine after user logoff.\n* NEVER: Never delete or refresh the machine in the desktop pool.\n* REFRESH: Refresh the machine after user logoff.","example":"NEVER","enum":["DELETE","NEVER","REFRESH"]},"disconnected_session_timeout_minutes":{"type":"integer","description":"Disconnected sessions timeout (in minutes). Will be set when disconnected_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER.\nThis property can be used for sorting.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-ablewindow) is disconnected after the timeout. Default value is 1.Will be set when the empty_session_timeout_policy set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy. Default value is AFTER.\nThis property can be used for sorting.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.Default value is false.\nThis property can be used for sorting.","example":false},"power_policy":{"type":"string","description":"Power policy for the machines in the desktop pool after logoff. This setting is only relevant for managed machines.Default value is TAKE_NO_POWER_ACTION.\nThis property can be used for sorting.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION"]},"refresh_os_disk_after_logoff":{"type":"string","description":"Whether and when to refresh the OS disks for dedicated-assignment, linked-clone and instant-clone machines.Default value is NEVER.\nThis property can be used for sorting.\n* ALWAYS: The OS disk is refreshed every time the user logs off.\n* AT_SIZE: The OS disk is refreshed when its current size reaches a specified percentage of its maximum allowable size. The maximum size of a linked clone's OS disk is the size of the replica's OS disk. With this option, the size of the linked clone's OS disk in the datastore is compared to maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.\n* EVERY: The OS disk is refreshed at regular intervals of a specified number of days. The number of days is counted from the last refresh, or from the initial provisioning if no refresh has occurred yet. For example, if the specified value is 3 days, and three days have passed since the last refresh, the machine is refreshed after the user logs off.\n* NEVER: The OS disk is never refreshed.","example":"NEVER","enum":["ALWAYS","AT_SIZE","EVERY","NEVER"]},"refresh_period_days_for_replica_os_disk":{"type":"integer","description":"Regular interval at which to refresh the OS disk. Will be set when refresh_os_disk_after_logoff set to EVERY.\nThis property can be used for sorting.","format":"int32","example":20},"refresh_threshold_percentage_for_replica_os_disk":{"type":"integer","description":"With the 'AT_SIZE' option for refreshOsDiskAfterLogoff, the size of the linked clone's OS diskin the datastore is compared to its maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.Will be set when refresh_os_disk_after_logoff set to AT_SIZE.\nThis property can be used for sorting.","format":"int32","example":30}},"description":"Machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare."},"DesktopPoolSessionSettingsCreateSpec":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false.","example":false},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false.","example":false},"delete_or_refresh_machine_after_logoff":{"type":"string","description":"Whether machines are to be deleted or refreshed after logoff in case of Floating User Assignment. This is applicable for automated desktops with virtual machines names based on pattern naming. This is not applicable for desktops that are using specified naming since dynamic creation and deletion of VMs is not supported. For Instant clone desktops this setting can only be set to DELETE. Default value is NEVER.\n* DELETE: Delete the machine after user logoff.\n* NEVER: Never delete or refresh the machine in the desktop pool.\n* REFRESH: Refresh the machine after user logoff.","example":"NEVER","enum":["DELETE","NEVER","REFRESH"]},"disconnected_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Disconnected sessions timeout (in minutes). This is required if disconnected_session_timeout_policy is set to AFTER.<br>","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. This is required if the empty_session_timeout_policy set to AFTER. Default value is 1.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Application empty session timeout policy. Default value is AFTER.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. Default value is false.","example":false},"power_policy":{"type":"string","description":"Applicable to managed machines with default value as TAKE_NO_POWER_ACTION. Power policy for the machines in the desktop pool after logoff.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.","example":"TAKE_NO_POWER_ACTION","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION"]},"pre_launch_session_timeout_minutes":{"minimum":10,"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. This is required if pre_launch_session_timeout_policy is set to AFTER. Default value is 10.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Application pre-launch session timeout policy. Default value is AFTER.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","description":"Indicates whether and when to refresh the OS disks. Applicable To: dedicated instant-clone desktop pools with default value as NEVER.\n* ALWAYS: The OS disk is refreshed every time the user logs off.\n* AT_SIZE: The OS disk is refreshed when its current size reaches a specified percentage of its maximum allowable size. The maximum size of a linked clone's OS disk is the size of the replica's OS disk. With this option, the size of the linked clone's OS disk in the datastore is compared to maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.\n* EVERY: The OS disk is refreshed at regular intervals of a specified number of days. The number of days is counted from the last refresh, or from the initial provisioning if no refresh has occurred yet. For example, if the specified value is 3 days, and three days have passed since the last refresh, the machine is refreshed after the user logs off.\n* NEVER: The OS disk is never refreshed.","example":"NEVER","enum":["ALWAYS","AT_SIZE","EVERY","NEVER"]},"refresh_period_days_for_replica_os_disk":{"minimum":1,"type":"integer","description":"Regular interval at which to refresh the OS disk. This is required if refresh_os_disk_after_logoff is set to EVERY.","format":"int32","example":20},"refresh_threshold_percentage_for_replica_os_disk":{"maximum":100,"minimum":1,"type":"integer","description":"With the AT_SIZE option for refresh_os_disk_after_logoff, the size of the instant clone's OS diskin the datastore is compared to its maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system. This is required if refresh_os_disk_after_logoff set to AT_SIZE.","format":"int32","example":30},"session_timeout_policy":{"type":"string","description":"Session timeout policy. Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION with default value as DEFAULT.\n* DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.\n* NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.","example":"DEFAULT","enum":["DEFAULT","NEVER"]}},"description":"Applicable To: Automated and Manual desktop pool. <br>Session related settings for Automated and Manual desktop pool."},"DesktopPoolSessionSettingsCreateSpecV2":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false.","example":false},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false.","example":false},"delete_or_refresh_machine_after_logoff":{"type":"string","description":"Whether machines are to be deleted or refreshed after logoff in case of Floating User Assignment. This is applicable for automated desktops with virtual machines names based on pattern naming. This is not applicable for desktops that are using specified naming since dynamic creation and deletion of VMs is not supported. For Instant clone desktops this setting can only be set to DELETE. Default value is NEVER.\n* DELETE: Delete the machine after user logoff.\n* NEVER: Never delete or refresh the machine in the desktop pool.\n* REFRESH: Refresh the machine after user logoff.","example":"NEVER","enum":["DELETE","NEVER","REFRESH"]},"disconnected_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Disconnected sessions timeout (in minutes). This is required if disconnected_session_timeout_policy is set to AFTER.<br>","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. This is required if the empty_session_timeout_policy set to AFTER. Default value is 1.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Application empty session timeout policy. Default value is AFTER.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. Default value is false.","example":false},"power_policy":{"type":"string","description":"Applicable to managed machines with default value as TAKE_NO_POWER_ACTION. Power policy for the machines in the desktop pool after logoff.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.","example":"TAKE_NO_POWER_ACTION","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION"]},"pre_launch_session_timeout_minutes":{"minimum":10,"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. This is required if pre_launch_session_timeout_policy is set to AFTER. Default value is 10.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Application pre-launch session timeout policy. Default value is AFTER.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","description":"Indicates whether and when to refresh the OS disks. Applicable To: dedicated instant-clone desktop pools with default value as NEVER.\n* ALWAYS: The OS disk is refreshed every time the user logs off.\n* AT_SIZE: The OS disk is refreshed when its current size reaches a specified percentage of its maximum allowable size. The maximum size of a linked clone's OS disk is the size of the replica's OS disk. With this option, the size of the linked clone's OS disk in the datastore is compared to maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.\n* EVERY: The OS disk is refreshed at regular intervals of a specified number of days. The number of days is counted from the last refresh, or from the initial provisioning if no refresh has occurred yet. For example, if the specified value is 3 days, and three days have passed since the last refresh, the machine is refreshed after the user logs off.\n* NEVER: The OS disk is never refreshed.","example":"NEVER","enum":["ALWAYS","AT_SIZE","EVERY","NEVER"]},"refresh_period_days_for_replica_os_disk":{"minimum":1,"type":"integer","description":"Regular interval at which to refresh the OS disk. This is required if refresh_os_disk_after_logoff is set to EVERY.","format":"int32","example":20},"refresh_threshold_percentage_for_replica_os_disk":{"maximum":100,"minimum":1,"type":"integer","description":"With the AT_SIZE option for refresh_os_disk_after_logoff, the size of the instant clone's OS diskin the datastore is compared to its maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system. This is required if refresh_os_disk_after_logoff set to AT_SIZE.","format":"int32","example":30},"session_timeout_policy":{"type":"string","description":"Session timeout policy. Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION with default value as DEFAULT.\n* DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.\n* NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.","example":"DEFAULT","enum":["DEFAULT","NEVER"]},"used_vm_policy":{"type":"string","description":"Specifies the cleanup action to be taken in the event of not cleanly logged off for VMs within a pool that is configured with either a 'Refresh machine after logoff' or 'Delete machine after logoff' policy, or to block user access in case of uncleaned logoff. This is applicable for automated desktop pools with floating user assignment.\n* ALLOW_WITHOUT_REFRESH: Allow virtual machines that were not cleanly logged off to become available without being refreshed.\n* AUTO_REFRESH: Automatically refresh virtual machines that were not cleanly logged off. Users can access these virtual machines after the refresh operation is completed.\n* BLOCK_ACCESS: Mark virtual machines that were not cleanly logged off as \"Already used\" and block user access to them.","example":"BLOCK_ACCESS","enum":["ALLOW_WITHOUT_REFRESH","AUTO_REFRESH","BLOCK_ACCESS"]}},"description":"Applicable To: Automated and Manual desktop pool. <br>Session related settings for Automated and Manual desktop pool."},"DesktopPoolSessionSettingsUpdateSpec":{"required":["allow_multiple_sessions_per_user","disconnected_session_timeout_policy"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment.","example":false},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether the user can be allowed to reset or restart their machines.","example":false},"delete_or_refresh_machine_after_logoff":{"type":"string","description":"Indicates whether machines are to be deleted or refreshed after logoff in case of Floating User Assignment. This is applicable for automated desktop pools with virtual machines names based on pattern naming. This is not applicable for desktop pools that are using specified naming since dynamic creation and deletion of VMs is not supported. For Instant clone desktop pools this setting can only be set to DELETE.\n* DELETE: Delete the machine after user logoff.\n* NEVER: Never delete or refresh the machine in the desktop pool.\n* REFRESH: Refresh the machine after user logoff.","example":"NEVER","enum":["DELETE","NEVER","REFRESH"]},"disconnected_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Disconnected sessions timeout (in minutes). This is required if disconnected_session_timeout_policy is set to AFTER.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Desktop Pool empty session timeout (in minutes). An empty session (that has no remote-ablewindow) is disconnected after the timeout. This is required if empty_session_timeout_policy is set to AFTER.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Desktop Pool empty session timeout policy.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. Indicates whether the empty desktop pool sessions are logged off (true) or disconnected (false) after timeout.","example":false},"power_policy":{"type":"string","description":"Power policy for the machines in the desktop pool after logoff. This setting is only relevant for managed machines. \n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION"]},"pre_launch_session_timeout_minutes":{"minimum":10,"type":"integer","description":"Desktop Pool pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. This is required if pre-launch session timeout policy is set to AFTER.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Desktop Pool pre-launch session timeout policy.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","description":"Indicates whether and when to refresh the OS disks for dedicated instant-clone desktop pools.\n* ALWAYS: The OS disk is refreshed every time the user logs off.\n* AT_SIZE: The OS disk is refreshed when its current size reaches a specified percentage of its maximum allowable size. The maximum size of a linked clone's OS disk is the size of the replica's OS disk. With this option, the size of the linked clone's OS disk in the datastore is compared to maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.\n* EVERY: The OS disk is refreshed at regular intervals of a specified number of days. The number of days is counted from the last refresh, or from the initial provisioning if no refresh has occurred yet. For example, if the specified value is 3 days, and three days have passed since the last refresh, the machine is refreshed after the user logs off.\n* NEVER: The OS disk is never refreshed.","example":"NEVER","enum":["ALWAYS","AT_SIZE","EVERY","NEVER"]},"refresh_period_days_for_replica_os_disk":{"minimum":1,"type":"integer","description":"Regular interval at which to refresh the OS disk. This is required if when refresh_os_disk_after_logoff set to EVERY.","format":"int32","example":20},"refresh_threshold_percentage_for_replica_os_disk":{"maximum":100,"minimum":1,"type":"integer","description":"With the AT_SIZE option for refresh_os_disk_after_logoff, the size of the instant clone's OS diskin the datastore is compared to its maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.This is required if refresh_os_disk_after_logoff is set to AT_SIZE.","format":"int32","example":30},"session_timeout_policy":{"type":"string","description":"Specifies the session timeout policy for the applications published from the Desktop pool. This policy indicates whether the launched application session is a forever application session or not.\n* DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.\n* NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.","example":"DEFAULT","enum":["DEFAULT","NEVER"]}},"description":"Applicable To: Automated and Manual desktop pool. <br>Session related setting for Automated and Manual desktop pool."},"DesktopPoolSessionSettingsUpdateSpecV2":{"required":["allow_multiple_sessions_per_user","disconnected_session_timeout_policy"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment.","example":false},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether the user can be allowed to reset or restart their machines.","example":false},"delete_or_refresh_machine_after_logoff":{"type":"string","description":"Indicates whether machines are to be deleted or refreshed after logoff in case of Floating User Assignment. This is applicable for automated desktop pools with virtual machines names based on pattern naming. This is not applicable for desktop pools that are using specified naming since dynamic creation and deletion of VMs is not supported. For Instant clone desktop pools this setting can only be set to DELETE.\n* DELETE: Delete the machine after user logoff.\n* NEVER: Never delete or refresh the machine in the desktop pool.\n* REFRESH: Refresh the machine after user logoff.","example":"NEVER","enum":["DELETE","NEVER","REFRESH"]},"disconnected_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Disconnected sessions timeout (in minutes). This is required if disconnected_session_timeout_policy is set to AFTER.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Desktop Pool empty session timeout (in minutes). An empty session (that has no remote-ablewindow) is disconnected after the timeout. This is required if empty_session_timeout_policy is set to AFTER.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Desktop Pool empty session timeout policy.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. Indicates whether the empty desktop pool sessions are logged off (true) or disconnected (false) after timeout.","example":false},"power_policy":{"type":"string","description":"Power policy for the machines in the desktop pool after logoff. This setting is only relevant for managed machines. \n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION"]},"pre_launch_session_timeout_minutes":{"minimum":10,"type":"integer","description":"Desktop Pool pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. This is required if pre-launch session timeout policy is set to AFTER.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Desktop Pool pre-launch session timeout policy.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","description":"Indicates whether and when to refresh the OS disks for dedicated instant-clone desktop pools.\n* ALWAYS: The OS disk is refreshed every time the user logs off.\n* AT_SIZE: The OS disk is refreshed when its current size reaches a specified percentage of its maximum allowable size. The maximum size of a linked clone's OS disk is the size of the replica's OS disk. With this option, the size of the linked clone's OS disk in the datastore is compared to maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.\n* EVERY: The OS disk is refreshed at regular intervals of a specified number of days. The number of days is counted from the last refresh, or from the initial provisioning if no refresh has occurred yet. For example, if the specified value is 3 days, and three days have passed since the last refresh, the machine is refreshed after the user logs off.\n* NEVER: The OS disk is never refreshed.","example":"NEVER","enum":["ALWAYS","AT_SIZE","EVERY","NEVER"]},"refresh_period_days_for_replica_os_disk":{"minimum":1,"type":"integer","description":"Regular interval at which to refresh the OS disk. This is required if when refresh_os_disk_after_logoff set to EVERY.","format":"int32","example":20},"refresh_threshold_percentage_for_replica_os_disk":{"maximum":100,"minimum":1,"type":"integer","description":"With the AT_SIZE option for refresh_os_disk_after_logoff, the size of the instant clone's OS diskin the datastore is compared to its maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.This is required if refresh_os_disk_after_logoff is set to AT_SIZE.","format":"int32","example":30},"session_timeout_policy":{"type":"string","description":"Specifies the session timeout policy for the applications published from the Desktop pool. This policy indicates whether the launched application session is a forever application session or not.\n* DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.\n* NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.","example":"DEFAULT","enum":["DEFAULT","NEVER"]},"used_vm_policy":{"type":"string","description":"Specifies the cleanup action to be taken in the event of not cleanly logged off for VMs within a pool that is configured with either a 'Refresh machine after logoff' or 'Delete machine after logoff' policy, or to block user access in case of uncleaned logoff. This is applicable for automated desktop pools with floating user assignment.\n* ALLOW_WITHOUT_REFRESH: Allow virtual machines that were not cleanly logged off to become available without being refreshed.\n* AUTO_REFRESH: Automatically refresh virtual machines that were not cleanly logged off. Users can access these virtual machines after the refresh operation is completed.\n* BLOCK_ACCESS: Mark virtual machines that were not cleanly logged off as \"Already used\" and block user access to them.","example":"BLOCK_ACCESS","enum":["ALLOW_WITHOUT_REFRESH","AUTO_REFRESH","BLOCK_ACCESS"]}},"description":"Applicable To: Automated and Manual desktop pool. <br>Session related settings for Automated and Manual desktop pool."},"DesktopPoolSessionSettingsV2":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false.\nThis property can be used for sorting.","example":false},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false.\nThis property can be used for sorting.","example":false},"delete_or_refresh_machine_after_logoff":{"type":"string","description":"Whether machines are to be deleted or refreshed after logoff in case of Floating User Assignment.This is applicable for automated desktops with virtual machines names based onpattern naming. This is not applicable for desktops that are using specified naming since dynamic creation and deletion of VMs is not supported.For Instant clone desktops this setting can only be set to DELETE. Default value is NEVER.\nThis property can be used for sorting.\n* DELETE: Delete the machine after user logoff.\n* NEVER: Never delete or refresh the machine in the desktop pool.\n* REFRESH: Refresh the machine after user logoff.","example":"NEVER","enum":["DELETE","NEVER","REFRESH"]},"disconnected_session_timeout_minutes":{"type":"integer","description":"Disconnected sessions timeout (in minutes). Will be set when disconnected_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER.\nThis property can be used for sorting.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-ablewindow) is disconnected after the timeout. Default value is 1.Will be set when the empty_session_timeout_policy set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy. Default value is AFTER.\nThis property can be used for sorting.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.Default value is false.\nThis property can be used for sorting.","example":false},"power_policy":{"type":"string","description":"Power policy for the machines in the desktop pool after logoff. This setting is only relevant for managed machines.Default value is TAKE_NO_POWER_ACTION.\nThis property can be used for sorting.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION"]},"pre_launch_session_timeout_minutes":{"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. Default value is 10.Will be required when the pre-launch session timeout policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Application pre-launch session timeout policy. Default value is AFTER.\nThis property can be used for sorting.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","description":"Whether and when to refresh the OS disks for dedicated-assignment, linked-clone and instant-clone machines.Default value is NEVER.\nThis property can be used for sorting.\n* ALWAYS: The OS disk is refreshed every time the user logs off.\n* AT_SIZE: The OS disk is refreshed when its current size reaches a specified percentage of its maximum allowable size. The maximum size of a linked clone's OS disk is the size of the replica's OS disk. With this option, the size of the linked clone's OS disk in the datastore is compared to maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.\n* EVERY: The OS disk is refreshed at regular intervals of a specified number of days. The number of days is counted from the last refresh, or from the initial provisioning if no refresh has occurred yet. For example, if the specified value is 3 days, and three days have passed since the last refresh, the machine is refreshed after the user logs off.\n* NEVER: The OS disk is never refreshed.","example":"NEVER","enum":["ALWAYS","AT_SIZE","EVERY","NEVER"]},"refresh_period_days_for_replica_os_disk":{"type":"integer","description":"Regular interval at which to refresh the OS disk. Will be set when refresh_os_disk_after_logoff set to EVERY.\nThis property can be used for sorting.","format":"int32","example":20},"refresh_threshold_percentage_for_replica_os_disk":{"type":"integer","description":"With the 'AT_SIZE' option for refreshOsDiskAfterLogoff, the size of the linked clone's OS diskin the datastore is compared to its maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.Will be set when refresh_os_disk_after_logoff set to AT_SIZE.\nThis property can be used for sorting.","format":"int32","example":30}},"description":"Machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare."},"DesktopPoolSessionSettingsV3":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false.\nThis property can be used for sorting.","example":false},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false.\nThis property can be used for sorting.","example":false},"delete_or_refresh_machine_after_logoff":{"type":"string","description":"Whether machines are to be deleted or refreshed after logoff in case of Floating User Assignment.This is applicable for automated desktops with virtual machines names based onpattern naming. This is not applicable for desktops that are using specified naming since dynamic creation and deletion of VMs is not supported.For Instant clone desktops this setting can only be set to DELETE. Default value is NEVER.\nThis property can be used for sorting.\n* DELETE: Delete the machine after user logoff.\n* NEVER: Never delete or refresh the machine in the desktop pool.\n* REFRESH: Refresh the machine after user logoff.","example":"NEVER","enum":["DELETE","NEVER","REFRESH"]},"disconnected_session_timeout_minutes":{"type":"integer","description":"Disconnected sessions timeout (in minutes). Will be set when disconnected_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER.\nThis property can be used for sorting.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-ablewindow) is disconnected after the timeout. Default value is 1.Will be set when the empty_session_timeout_policy set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy. Default value is AFTER.\nThis property can be used for sorting.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.Default value is false.\nThis property can be used for sorting.","example":false},"power_policy":{"type":"string","description":"Power policy for the machines in the desktop pool after logoff. This setting is only relevant for managed machines.Default value is TAKE_NO_POWER_ACTION.\nThis property can be used for sorting.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION"]},"pre_launch_session_timeout_minutes":{"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. Default value is 10.Will be required when the pre-launch session timeout policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Application pre-launch session timeout policy. Default value is AFTER.\nThis property can be used for sorting.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","description":"Whether and when to refresh the OS disks for dedicated-assignment, linked-clone and instant-clone machines.Default value is NEVER.\nThis property can be used for sorting.\n* ALWAYS: The OS disk is refreshed every time the user logs off.\n* AT_SIZE: The OS disk is refreshed when its current size reaches a specified percentage of its maximum allowable size. The maximum size of a linked clone's OS disk is the size of the replica's OS disk. With this option, the size of the linked clone's OS disk in the datastore is compared to maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.\n* EVERY: The OS disk is refreshed at regular intervals of a specified number of days. The number of days is counted from the last refresh, or from the initial provisioning if no refresh has occurred yet. For example, if the specified value is 3 days, and three days have passed since the last refresh, the machine is refreshed after the user logs off.\n* NEVER: The OS disk is never refreshed.","example":"NEVER","enum":["ALWAYS","AT_SIZE","EVERY","NEVER"]},"refresh_period_days_for_replica_os_disk":{"type":"integer","description":"Regular interval at which to refresh the OS disk. Will be set when refresh_os_disk_after_logoff set to EVERY.\nThis property can be used for sorting.","format":"int32","example":20},"refresh_threshold_percentage_for_replica_os_disk":{"type":"integer","description":"With the 'AT_SIZE' option for refreshOsDiskAfterLogoff, the size of the linked clone's OS diskin the datastore is compared to its maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.Will be set when refresh_os_disk_after_logoff set to AT_SIZE.\nThis property can be used for sorting.","format":"int32","example":30},"session_timeout_policy":{"type":"string","description":"Session timeout policy.\nThis property can be used for sorting.\n* DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.\n* NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.","example":"DEFAULT","enum":["DEFAULT","NEVER"]}},"description":"Machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare."},"DesktopPoolSessionSettingsV4":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false.\nThis property can be used for sorting.","example":false},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false.\nThis property can be used for sorting.","example":false},"delete_or_refresh_machine_after_logoff":{"type":"string","description":"Whether machines are to be deleted or refreshed after logoff in case of Floating User Assignment.This is applicable for automated desktops with virtual machines names based onpattern naming. This is not applicable for desktops that are using specified naming since dynamic creation and deletion of VMs is not supported.For Instant clone desktops this setting can only be set to DELETE. Default value is NEVER.\nThis property can be used for sorting.\n* DELETE: Delete the machine after user logoff.\n* NEVER: Never delete or refresh the machine in the desktop pool.\n* REFRESH: Refresh the machine after user logoff.","example":"NEVER","enum":["DELETE","NEVER","REFRESH"]},"disconnected_session_timeout_minutes":{"type":"integer","description":"Disconnected sessions timeout (in minutes). Will be set when disconnected_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER.\nThis property can be used for sorting.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-ablewindow) is disconnected after the timeout. Default value is 1.Will be set when the empty_session_timeout_policy set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy. Default value is AFTER.\nThis property can be used for sorting.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.Default value is false.\nThis property can be used for sorting.","example":false},"power_policy":{"type":"string","description":"Power policy for the machines in the desktop pool after logoff. This setting is only relevant for managed machines.Default value is TAKE_NO_POWER_ACTION.\nThis property can be used for sorting.\n* ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.\n* POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.","example":"ALWAYS_POWERED_ON","enum":["ALWAYS_POWERED_ON","POWER_OFF","SUSPEND","TAKE_NO_POWER_ACTION"]},"pre_launch_session_timeout_minutes":{"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. Default value is 10.Will be required when the pre-launch session timeout policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Application pre-launch session timeout policy. Default value is AFTER.\nThis property can be used for sorting.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","description":"Whether and when to refresh the OS disks for dedicated-assignment, linked-clone and instant-clone machines.Default value is NEVER.\nThis property can be used for sorting.\n* ALWAYS: The OS disk is refreshed every time the user logs off.\n* AT_SIZE: The OS disk is refreshed when its current size reaches a specified percentage of its maximum allowable size. The maximum size of a linked clone's OS disk is the size of the replica's OS disk. With this option, the size of the linked clone's OS disk in the datastore is compared to maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.\n* EVERY: The OS disk is refreshed at regular intervals of a specified number of days. The number of days is counted from the last refresh, or from the initial provisioning if no refresh has occurred yet. For example, if the specified value is 3 days, and three days have passed since the last refresh, the machine is refreshed after the user logs off.\n* NEVER: The OS disk is never refreshed.","example":"NEVER","enum":["ALWAYS","AT_SIZE","EVERY","NEVER"]},"refresh_period_days_for_replica_os_disk":{"type":"integer","description":"Regular interval at which to refresh the OS disk. Will be set when refresh_os_disk_after_logoff set to EVERY.\nThis property can be used for sorting.","format":"int32","example":20},"refresh_threshold_percentage_for_replica_os_disk":{"type":"integer","description":"With the 'AT_SIZE' option for refreshOsDiskAfterLogoff, the size of the linked clone's OS diskin the datastore is compared to its maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.Will be set when refresh_os_disk_after_logoff set to AT_SIZE.\nThis property can be used for sorting.","format":"int32","example":30},"session_timeout_policy":{"type":"string","description":"Session timeout policy.\nThis property can be used for sorting.\n* DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.\n* NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.","example":"DEFAULT","enum":["DEFAULT","NEVER"]},"used_vm_policy":{"type":"string","description":"Specifies the cleanup action to be taken in the event of not cleanly logged off for VMs within a pool that is configured with either a 'Refresh machine after logoff' or 'Delete machine after logoff' policy, or to block user access in case of uncleaned logoff. This is applicable for automated desktop pools with floating user assignment.\nThis property can be used for sorting.\n* ALLOW_WITHOUT_REFRESH: Allow virtual machines that were not cleanly logged off to become available without being refreshed.\n* AUTO_REFRESH: Automatically refresh virtual machines that were not cleanly logged off. Users can access these virtual machines after the refresh operation is completed.\n* BLOCK_ACCESS: Mark virtual machines that were not cleanly logged off as \"Already used\" and block user access to them.","example":"BLOCK_ACCESS","enum":["ALLOW_WITHOUT_REFRESH","AUTO_REFRESH","BLOCK_ACCESS"]}},"description":"Machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare."},"DesktopPoolSettings":{"type":"object","properties":{"allow_mutilple_sessions_per_user":{"type":"boolean","description":"Whether multiple sessions are allowed per user for this pool. This is valid for RDS desktop pools.For other Desktops, allow_multiple_sessions_per_user in settings will be applicable.Default value is false.","example":false},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\dir2, dir1\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services. Default value is false.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false. Default value is false.","example":false},"cs_restriction_tags":{"type":"array","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"delete_in_progress":{"type":"boolean","description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.","example":false},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","description":"Client restrictions to be applied to the desktop pool.Currently it is valid for RDS desktop pools only. Default value is false.","example":false},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettings"},"session_type":{"type":"string","description":"Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.The value will be present if categoryFolderName is set.","example":["Desktop"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.The value will be present if categoryFolderName is set.","example":"[\"Desktop\"]"}}},"description":"Information related to Desktop Pool Settings."},"DesktopPoolStorageSettings":{"type":"object","properties":{"datastores":{"type":"array","description":"Datastores to store the machine (or the OS disk using other options for linked clone or instant clone machine storage)","items":{"$ref":"#/components/schemas/DesktopPoolDatastoreSettings"}},"non_persistent_disk_drive_letter":{"type":"string","description":"Non persistent disk drive letter.\nThis property can be used for sorting.","example":"Auto"},"non_persistent_disk_size_mb":{"type":"integer","description":"Size of the non persistent disk in MB.\nThis property can be used for sorting.","format":"int32","example":4096},"non_persistent_redirect_disposable_files":{"type":"boolean","description":"Redirect disposable files to a non-persistent disk that will be deleted automatically when a user's session ends.\nThis property can be used for sorting.","example":true},"persistent_disk_datastores":{"type":"array","description":"Datastores to store persistent disks for linked clone machines.","items":{"$ref":"#/components/schemas/DesktopPoolDatastoreSettings"}},"persistent_disk_drive_letter":{"type":"string","description":"Persistent disk drive letter.\nThis property can be used for sorting.","example":"D"},"persistent_disk_size_mb":{"type":"integer","description":"Size of the persistent disk in MB.\nThis property can be used for sorting.","format":"int32","example":2048},"reclaim_vm_disk_space":{"type":"boolean","description":"With vSphere 5.x, virtual machines can be configured to use a space efficient disk format that supports reclamation of unused disk space (such as deleted files). This option reclaims unused disk space on each virtual machine. The operation is initiated when an estimate of used disk space exceeds the specified threshold.\nThis property can be used for sorting.","example":false},"reclamation_threshold_mb":{"type":"integer","description":"Initiate reclamation when unused space on virtual machine exceeds the threshold in MB.\nThis property can be used for sorting.","format":"int64","example":1024},"redirect_windows_profile":{"type":"boolean","description":"Windows profiles will be redirected to persistent disks, which are not affected by View Composer operations such as refresh, recompose and rebalance.\nThis property can be used for sorting.","example":false},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks for linked clone and instant clone machines.","example":"datastore-1"},"use_native_snapshots":{"type":"boolean","description":"Applicable To: Linked/instant clone automated desktop pool.<br>Native NFS Snapshots (VAAI - vStorage API for Array Integration) is a hardware feature of certain storage arrays. It uses native snapshotting technology to provide linked clone functionality.\nThis property can be used for sorting.","example":false},"use_separate_datastores_persistent_and_os_disks":{"type":"boolean","description":"Whether to use separate datastores for persistent and OS disks.\nThis property can be used for sorting.","example":false},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Whether to use separate datastores for replica and OS disks.\nThis property can be used for sorting.","example":false},"use_vsan":{"type":"boolean","description":"Whether to use vSphere vSAN.\nThis property can be used for sorting.","example":false}},"description":"Virtual Center storage settings for the automated desktop pool."},"DesktopPoolStorageSettingsCreateSpec":{"required":["datastores"],"type":"object","properties":{"datastores":{"type":"array","description":"Datastores to store the machine.","items":{"$ref":"#/components/schemas/DesktopPoolDatastoreSettingsCreateSpec"}},"reclaim_vm_disk_space":{"type":"boolean","description":"With vSphere 5.x, virtual machines can be configured to use a space efficient disk format that supports reclamation of unused diskspace (such as deleted files). This option reclaims unused diskspace on each virtual machine. The operation is initiated when an estimate of used disk space exceeds the specified threshold. <br> Default value is false.","example":false},"reclamation_threshold_mb":{"minimum":1,"type":"integer","description":"Initiate reclamation when unused space on virtual machine exceeds the threshold in MB. <br> This property is required if reclaim_vm_disk_space is set to true.","format":"int64","example":1024},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks for instant clone machines. <br> This property is required if use_separate_datastores_replica_and_os_disks is set to true. <br>","example":"datastore-1"},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Indicates whether to use separate datastores for replica and OS disks. <br> Default value is false.","example":false},"use_vsan":{"type":"boolean","description":"Indicates whether to use vSphere vSAN. <br> Default value is false.","example":false}},"description":"Applicable To: Automated desktop pool. <br>Virtual center storage settings for Automated desktop pool."},"DesktopPoolStorageSettingsCreateSpecV2":{"required":["datastores"],"type":"object","properties":{"datastores":{"type":"array","description":"Datastores to store the machine.","items":{"$ref":"#/components/schemas/DesktopPoolDatastoreSettingsCreateSpec"}},"persistent_disk_drive_letter":{"type":"string","description":"Indicates the persistent disk drive letter.This property is required if redirect_Windows_Profile is set to True","example":"D"},"persistent_disk_size_mb":{"minimum":128,"type":"integer","description":"Indicates the size of the persistent disk in MB.This property is required if redirect_Windows_Profile is set to True","format":"int32","example":2048},"reclaim_vm_disk_space":{"type":"boolean","description":"With vSphere 5.x, virtual machines can be configured to use a space efficient disk format that supports reclamation of unused diskspace (such as deleted files). This option reclaims unused diskspace on each virtual machine. The operation is initiated when an estimate of used disk space exceeds the specified threshold. <br> Default value is false.","example":false},"reclamation_threshold_mb":{"minimum":1,"type":"integer","description":"Initiate reclamation when unused space on virtual machine exceeds the threshold in MB. <br> This property is required if reclaim_vm_disk_space is set to true.","format":"int64","example":1024},"redirect_windows_profile":{"type":"boolean","description":"Indicates that windows profiles will be redirected to persistent disks.","example":false},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks for instant clone machines. <br> This property is required if use_separate_datastores_replica_and_os_disks is set to true. <br>","example":"datastore-1"},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Indicates whether to use separate datastores for replica and OS disks. <br> Default value is false.","example":false},"use_vsan":{"type":"boolean","description":"Indicates whether to use vSphere vSAN. <br> Default value is false.","example":false}},"description":"Virtual center storage settings for automated desktop pool."},"DesktopPoolStorageSettingsUpdateSpec":{"required":["datastores","use_vsan"],"type":"object","properties":{"datastores":{"type":"array","description":"Datastores to store the machine (or the OS disk using other options for instant clone machine storage)","items":{"$ref":"#/components/schemas/DesktopPoolDatastoreSettingsUpdateSpec"}},"reclaim_vm_disk_space":{"type":"boolean","description":"With vSphere 5.x, virtual machines can be configured to use a space efficient disk format that supports reclamation of unused disk space (such as deleted files). This option reclaims unused disk space on each virtual machine. The operation is initiated when an estimate of used disk space exceeds the specified threshold.","example":false},"reclamation_threshold_mb":{"minimum":1,"type":"integer","description":"Initiate reclamation when unused space on virtual machine exceeds the threshold in MB. Default value is 1.","format":"int64","example":1024},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks for instant clone machines.","example":"datastore-1"},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Indicates whether to use separate datastores for replica and OS disks.","example":false},"use_vsan":{"type":"boolean","description":"Indicates whether to use vSphere vSAN.","example":false}},"description":"Applicable To: Automated desktop pool. <br>Virtual Center storage settings for Automated desktop pool."},"DesktopPoolStorageSettingsUpdateSpecV2":{"required":["datastores","use_vsan"],"type":"object","properties":{"datastores":{"type":"array","description":"Datastores to store the machine (or the OS disk using other options for instant clone machine storage)","items":{"$ref":"#/components/schemas/DesktopPoolDatastoreSettingsUpdateSpec"}},"persistent_disk_drive_letter":{"type":"string","description":"Indicates the persistent disk drive letter.This property is required if redirectWindowsProfile is set to True","example":"D"},"persistent_disk_size_mb":{"minimum":128,"type":"integer","description":"Indicates the size of the persistent disk in MB.This property is required if redirectWindowsProfile is set to True","format":"int32","example":2048},"reclaim_vm_disk_space":{"type":"boolean","description":"With vSphere 5.x, virtual machines can be configured to use a space efficient disk format that supports reclamation of unused disk space (such as deleted files). This option reclaims unused disk space on each virtual machine. The operation is initiated when an estimate of used disk space exceeds the specified threshold.","example":false},"reclamation_threshold_mb":{"minimum":1,"type":"integer","description":"Initiate reclamation when unused space on virtual machine exceeds the threshold in MB. Default value is 1.","format":"int64","example":1024},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks for instant clone machines.","example":"datastore-1"},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Indicates whether to use separate datastores for replica and OS disks.","example":false},"use_vsan":{"type":"boolean","description":"Indicates whether to use vSphere vSAN.","example":false}},"description":"Virtual center storage settings for automated desktop pool."},"DesktopPoolTaskInfo":{"type":"object","properties":{"cancelled_vmtask_count":{"type":"integer","description":"Number of VMs whose task is in cancelled state.","format":"int32","example":3},"description":{"type":"string","description":"Description of the desktop pool task.","example":"Changing 10 user(s) to image /Datacenter/vm/VMs/Win10 - Snapshot1. This task will start at Jan 12, 2021 12:00 AM and will wait for users to log off before the push operation is started."},"error_vmtask_count":{"type":"integer","description":"Number of VMs whose task is in fault state.","format":"int32","example":2},"halted_vmtask_count":{"type":"integer","description":"Number of VMs whose task is in holding state.","format":"int32","example":1},"id":{"type":"string","description":"Unique ID representing Desktop Pool Task.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"operation":{"type":"string","description":"The current desktop pool operation.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"PUSH_IMAGE","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"remaining_vmtask_count":{"type":"integer","description":"Number of VMs whose task is scheduled or running.","format":"int32","example":10},"schedule_time":{"type":"integer","description":"Time at which desktop pool task is scheduled to start.","format":"int64","example":1587081283000}},"description":"Information related to Desktop Pool Task."},"DesktopPoolUpdateSpec":{"required":["cloud_assigned","cloud_managed","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools. with manual user assignment.<br>Indicates whether assignment of multiple users to a single machine is allowed. This is required for Dedicated manual and automated desktop pools<br>","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Indicates whether multiple sessions are allowed per user for this pool. This is required for RDS desktop pool. For other desktop pools, allow_multiple_sessions_per_user in session_settings will be applicable.","example":false},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>","example":false},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON\\\\.*|PRN\\\\.*|AUX\\\\.*|NUL\\\\.*|COM[1-9]\\\\.*|LPT[1-9]\\\\.*)$)(?!(?:.*\\\\CON|.*\\\\PRN|.*\\\\AUX|.*\\\\NUL|.*\\\\COM[1-9]|.*\\\\LPT[1-9])$)(?!(?:.*\\\\CON\\\\.*|.*\\\\PRN\\\\.*|.*\\\\AUX\\\\.*|.*\\\\NUL\\\\.*|.*\\\\COM[1-9]\\\\.*|.*\\\\LPT[1-9]\\\\.*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.This property will not be set if the desktop pool does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop pool is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is true.This can be changed to false only if there are no entitlements.","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools. <br>This is required for RDS Desktop Pools.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop pool is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>This cannot be set to true, if any of the conditions are satisfied:<br>1. user is provided.<br>2. enabled is false.<br>3. session_type is not DESKTOP.<br>4. global_entitlement is set.<br>5. user_assignment is DEDICATED.<br>6. automatic_user_assignment is false.<br>7. Local entitlements are configured.<br>8. Any of the machines in the pool have users assigned.<br>9. cs_restriction_tags is not set.<br>10. type is MANUAL.<br>","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsUpdateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop Pool Description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the machine alias of the machine assigned to them instead of displayName when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":true},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsUpdateSpec"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to desktop pool. ","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning is enabled. This is required for Automated desktop pools.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering.","example":true},"nics":{"type":"array","description":"Applicable To: Instant Clone desktop pools.<br>Network interface card settings for machines provisioned for this desktop pool. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. If value is not configured than will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsUpdateSpec"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsUpdateSpec"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools.<br>Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. This is required for managed desktop pools.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning on all machines stops on error. This is required for Automated desktop pools.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsUpdateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools.<br>The transparent page sharing scope. This is required for Manual and Automated desktop pools.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsUpdateSpec"}},"description":"Desktop Pool object to be updated."},"DesktopPoolUpdateSpecV2":{"required":["cloud_assigned","cloud_managed","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools. with manual user assignment.<br>Indicates whether assignment of multiple users to a single machine is allowed. This is required for Dedicated manual and automated desktop pools<br>","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Indicates whether multiple sessions are allowed per user for this pool. This is required for RDS desktop pool. For other desktop pools, allow_multiple_sessions_per_user in session_settings will be applicable.","example":false},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>","example":false},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON\\\\.*|PRN\\\\.*|AUX\\\\.*|NUL\\\\.*|COM[1-9]\\\\.*|LPT[1-9]\\\\.*)$)(?!(?:.*\\\\CON|.*\\\\PRN|.*\\\\AUX|.*\\\\NUL|.*\\\\COM[1-9]|.*\\\\LPT[1-9])$)(?!(?:.*\\\\CON\\\\.*|.*\\\\PRN\\\\.*|.*\\\\AUX\\\\.*|.*\\\\NUL\\\\.*|.*\\\\COM[1-9]\\\\.*|.*\\\\LPT[1-9]\\\\.*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.This property will not be set if the desktop pool does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop pool is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is true.This can be changed to false only if there are no entitlements.","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools. <br>This is required for RDS Desktop Pools.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop pool is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>This cannot be set to true, if any of the conditions are satisfied:<br>1. user is provided.<br>2. enabled is false.<br>3. session_type is not DESKTOP.<br>4. global_entitlement is set.<br>5. user_assignment is DEDICATED.<br>6. automatic_user_assignment is false.<br>7. Local entitlements are configured.<br>8. Any of the machines in the pool have users assigned.<br>9. cs_restriction_tags is not set.<br>10. type is MANUAL.<br>","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsUpdateV2"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop Pool Description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the machine alias of the machine assigned to them instead of displayName when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":true},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsUpdateSpec"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to desktop pool. ","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning is enabled. This is required for Automated desktop pools.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering.","example":true},"nics":{"type":"array","description":"Applicable To: Instant Clone desktop pools.<br>Network interface card settings for machines provisioned for this desktop pool. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. If value is not configured than will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsUpdateSpec"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsUpdateSpec"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools.<br>Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. This is required for managed desktop pools.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning on all machines stops on error. This is required for Automated desktop pools.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsUpdateSpecV2"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools.<br>The transparent page sharing scope. This is required for Manual and Automated desktop pools.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsUpdateSpec"}},"description":"Desktop Pool object to be updated."},"DesktopPoolUpdateSpecV3":{"required":["cloud_assigned","cloud_managed","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools. with manual user assignment.<br>Indicates whether assignment of multiple users to a single machine is allowed. This is required for Dedicated manual and automated desktop pools<br>","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Indicates whether multiple sessions are allowed per user for this pool. This is required for RDS desktop pool. For other desktop pools, allow_multiple_sessions_per_user in session_settings will be applicable.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment, mandatory for floating user assignment.","example":true},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>","example":false},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON\\\\.*|PRN\\\\.*|AUX\\\\.*|NUL\\\\.*|COM[1-9]\\\\.*|LPT[1-9]\\\\.*)$)(?!(?:.*\\\\CON|.*\\\\PRN|.*\\\\AUX|.*\\\\NUL|.*\\\\COM[1-9]|.*\\\\LPT[1-9])$)(?!(?:.*\\\\CON\\\\.*|.*\\\\PRN\\\\.*|.*\\\\AUX\\\\.*|.*\\\\NUL\\\\.*|.*\\\\COM[1-9]\\\\.*|.*\\\\LPT[1-9]\\\\.*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.This property will not be set if the desktop pool does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop pool is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is true.This can be changed to false only if there are no entitlements.","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools. <br>This is required for RDS Desktop Pools.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop pool is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>This cannot be set to true, if any of the conditions are satisfied:<br>1. user is provided.<br>2. enabled is false.<br>3. session_type is not DESKTOP.<br>4. global_entitlement is set.<br>5. user_assignment is DEDICATED.<br>6. automatic_user_assignment is false.<br>7. Local entitlements are configured.<br>8. Any of the machines in the pool have users assigned.<br>9. cs_restriction_tags is not set.<br>10. type is MANUAL.<br>","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsUpdateV3"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop Pool Description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the machine alias of the machine assigned to them instead of displayName when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":true},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsUpdateSpec"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to desktop pool. ","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning is enabled. This is required for Automated desktop pools.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering.","example":true},"nics":{"type":"array","description":"Applicable To: Instant Clone desktop pools.<br>Network interface card settings for machines provisioned for this desktop pool. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. If value is not configured than will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsUpdateSpec"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsUpdateSpecV2"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools.<br>Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. This is required for managed desktop pools.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning on all machines stops on error. This is required for Automated desktop pools.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsUpdateSpecV2"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools.<br>The transparent page sharing scope. This is required for Manual and Automated desktop pools.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsUpdateSpec"}},"description":"Desktop Pool object to be updated."},"DesktopPoolUpdateSpecV4":{"required":["cloud_assigned","cloud_managed","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools. with manual user assignment.<br>Indicates whether assignment of multiple users to a single machine is allowed. This is required for Dedicated manual and automated desktop pools<br>","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Indicates whether multiple sessions are allowed per user for this pool. This is required for RDS desktop pool. For other desktop pools, allow_multiple_sessions_per_user in session_settings will be applicable.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment, mandatory for floating user assignment.","example":true},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>","example":false},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON\\\\.*|PRN\\\\.*|AUX\\\\.*|NUL\\\\.*|COM[1-9]\\\\.*|LPT[1-9]\\\\.*)$)(?!(?:.*\\\\CON|.*\\\\PRN|.*\\\\AUX|.*\\\\NUL|.*\\\\COM[1-9]|.*\\\\LPT[1-9])$)(?!(?:.*\\\\CON\\\\.*|.*\\\\PRN\\\\.*|.*\\\\AUX\\\\.*|.*\\\\NUL\\\\.*|.*\\\\COM[1-9]\\\\.*|.*\\\\LPT[1-9]\\\\.*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.This property will not be set if the desktop pool does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop pool is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is true.This can be changed to false only if there are no entitlements.","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools. <br>This is required for RDS Desktop Pools.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop pool is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>This cannot be set to true, if any of the conditions are satisfied:<br>1. user is provided.<br>2. enabled is false.<br>3. session_type is not DESKTOP.<br>4. global_entitlement is set.<br>5. user_assignment is DEDICATED.<br>6. automatic_user_assignment is false.<br>7. Local entitlements are configured.<br>8. Any of the machines in the pool have users assigned.<br>9. cs_restriction_tags is not set.<br>10. type is MANUAL.<br>","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsUpdateV3"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop Pool Description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the machine alias of the machine assigned to them instead of displayName when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":true},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsUpdateSpecV2"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to desktop pool. ","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning is enabled. This is required for Automated desktop pools.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering.","example":true},"nics":{"type":"array","description":"Applicable To: Instant Clone desktop pools.<br>Network interface card settings for machines provisioned for this desktop pool. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. If value is not configured than will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsUpdateSpec"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsUpdateSpecV2"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools.<br>Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. This is required for managed desktop pools.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning on all machines stops on error. This is required for Automated desktop pools.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsUpdateSpecV2"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools.<br>The transparent page sharing scope. This is required for Manual and Automated desktop pools.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsUpdateSpec"}},"description":"Desktop Pool object to be updated."},"DesktopPoolUpdateSpecV5":{"required":["cloud_assigned","cloud_managed","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools. with manual user assignment.<br>Indicates whether assignment of multiple users to a single machine is allowed. This is required for Dedicated manual and automated desktop pools<br>","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Indicates whether multiple sessions are allowed per user for this pool. This is required for RDS desktop pool. For other desktop pools, allow_multiple_sessions_per_user in session_settings will be applicable.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment, mandatory for floating user assignment.","example":true},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>","example":false},"aws_core_desktop_settings":{"$ref":"#/components/schemas/AwsCoreDesktopSettingsUpdateSpec"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON\\\\.*|PRN\\\\.*|AUX\\\\.*|NUL\\\\.*|COM[1-9]\\\\.*|LPT[1-9]\\\\.*)$)(?!(?:.*\\\\CON|.*\\\\PRN|.*\\\\AUX|.*\\\\NUL|.*\\\\COM[1-9]|.*\\\\LPT[1-9])$)(?!(?:.*\\\\CON\\\\.*|.*\\\\PRN\\\\.*|.*\\\\AUX\\\\.*|.*\\\\NUL\\\\.*|.*\\\\COM[1-9]\\\\.*|.*\\\\LPT[1-9]\\\\.*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.This property will not be set if the desktop pool does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop pool is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is true.This can be changed to false only if there are no entitlements.","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools. <br>This is required for RDS Desktop Pools.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop pool is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>This cannot be set to true, if any of the conditions are satisfied:<br>1. user is provided.<br>2. enabled is false.<br>3. session_type is not DESKTOP.<br>4. global_entitlement is set.<br>5. user_assignment is DEDICATED.<br>6. automatic_user_assignment is false.<br>7. Local entitlements are configured.<br>8. Any of the machines in the pool have users assigned.<br>9. cs_restriction_tags is not set.<br>10. type is MANUAL.<br>","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsUpdateV3"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop Pool Description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the machine alias of the machine assigned to them instead of displayName when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":true},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsUpdateSpecV2"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to desktop pool. ","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning is enabled. This is required for Automated desktop pools.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering.","example":true},"nics":{"type":"array","description":"Applicable To: Instant Clone desktop pools.<br>Network interface card settings for machines provisioned for this desktop pool. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. If value is not configured than will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsUpdateSpec"},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsUpdateSpecV2"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools.<br>Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. This is required for managed desktop pools.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning on all machines stops on error. This is required for Automated desktop pools.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsUpdateSpecV2"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools.<br>The transparent page sharing scope. This is required for Manual and Automated desktop pools.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsUpdateSpec"}},"description":"Desktop Pool object to be updated."},"DesktopPoolUpdateSpecV6":{"required":["cloud_assigned","cloud_managed","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools. with manual user assignment.<br>Indicates whether assignment of multiple users to a single machine is allowed. This is required for Dedicated manual and automated desktop pools<br>","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Indicates whether multiple sessions are allowed per user for this pool. This is required for RDS desktop pool. For other desktop pools, allow_multiple_sessions_per_user in session_settings will be applicable.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment, mandatory for floating user assignment.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nDefault value - BOTH.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>","example":false},"aws_core_desktop_settings":{"$ref":"#/components/schemas/AwsCoreDesktopSettingsUpdateSpec"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON\\\\.*|PRN\\\\.*|AUX\\\\.*|NUL\\\\.*|COM[1-9]\\\\.*|LPT[1-9]\\\\.*)$)(?!(?:.*\\\\CON|.*\\\\PRN|.*\\\\AUX|.*\\\\NUL|.*\\\\COM[1-9]|.*\\\\LPT[1-9])$)(?!(?:.*\\\\CON\\\\.*|.*\\\\PRN\\\\.*|.*\\\\AUX\\\\.*|.*\\\\NUL\\\\.*|.*\\\\COM[1-9]\\\\.*|.*\\\\LPT[1-9]\\\\.*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.This property will not be set if the desktop pool does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop pool is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is true.This can be changed to false only if there are no entitlements.","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools. <br>This is required for RDS Desktop Pools.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop pool is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>This cannot be set to true, if any of the conditions are satisfied:<br>1. user is provided.<br>2. enabled is false.<br>3. session_type is not DESKTOP.<br>4. global_entitlement is set.<br>5. user_assignment is DEDICATED.<br>6. automatic_user_assignment is false.<br>7. Local entitlements are configured.<br>8. Any of the machines in the pool have users assigned.<br>9. cs_restriction_tags is not set.<br>10. type is MANUAL.<br>","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsUpdateV3"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop Pool Description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the machine alias of the machine assigned to them instead of displayName when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":true},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsUpdateSpecV2"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to desktop pool. ","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning is enabled. This is required for Automated desktop pools.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering.","example":true},"nics":{"type":"array","description":"Applicable To: Instant Clone desktop pools.<br>Network interface card settings for machines provisioned for this desktop pool. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. If value is not configured than will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsUpdateSpec"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect.\nDefault value - false."},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsUpdateSpecV2"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools.<br>Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. This is required for managed desktop pools.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning on all machines stops on error. This is required for Automated desktop pools.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsUpdateSpecV2"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools.<br>The transparent page sharing scope. This is required for Manual and Automated desktop pools.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsUpdateSpec"}},"description":"Desktop Pool object to be updated."},"DesktopPoolUpdateSpecV7":{"required":["cloud_assigned","cloud_managed","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled","entra_sso_enabled"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration. <br> This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"allow_multiple_user_assignments":{"type":"boolean","description":"Applicable To: Dedicated manual and automated desktop pools. with manual user assignment.<br>Indicates whether assignment of multiple users to a single machine is allowed. This is required for Dedicated manual and automated desktop pools<br>","example":true},"allow_rds_pool_multi_session_per_user":{"type":"boolean","description":"Applicable To: RDS desktop pools.<br>Indicates whether multiple sessions are allowed per user for this pool. This is required for RDS desktop pool. For other desktop pools, allow_multiple_sessions_per_user in session_settings will be applicable.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment, mandatory for floating user assignment.","example":true},"allowed_access_path":{"type":"string","description":"Indicates path to which this pool allows access.\nDefault value - BOTH.\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","example":"INTERNAL","enum":["BOTH","INTERNAL","EXTERNAL"]},"automatic_user_assignment":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Automatic assignment of a user the first time they access the machine.<br>","example":false},"aws_core_desktop_settings":{"$ref":"#/components/schemas/AwsCoreDesktopSettingsUpdateSpecV2"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON\\\\.*|PRN\\\\.*|AUX\\\\.*|NUL\\\\.*|COM[1-9]\\\\.*|LPT[1-9]\\\\.*)$)(?!(?:.*\\\\CON|.*\\\\PRN|.*\\\\AUX|.*\\\\NUL|.*\\\\COM[1-9]|.*\\\\LPT[1-9])$)(?!(?:.*\\\\CON\\\\.*|.*\\\\PRN\\\\.*|.*\\\\AUX\\\\.*|.*\\\\NUL\\\\.*|.*\\\\COM[1-9]\\\\.*|.*\\\\LPT[1-9]\\\\.*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the desktop pool.This property will not be set if the desktop pool does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\\dir2\\dir3\\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\\dir1, dir1\\dir2\\, dir1\\\\\\dir2, dir1\\\\\\\\\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.","example":"dir1"},"cloud_assigned":{"type":"boolean","description":"Indicates whether this desktop pool is assigned to a workspace in Horizon Cloud Services.<br>This can be set to true from cloud session only and only when cloud_managed is true.This can be changed to false only if there are no entitlements.","example":false},"cloud_brokered":{"type":"boolean","description":"Applicable To: RDS Desktop Pools. <br>This is required for RDS Desktop Pools.","example":false},"cloud_managed":{"type":"boolean","description":"Indicates whether this desktop pool is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.<br>This cannot be set to true, if any of the conditions are satisfied:<br>1. user is provided.<br>2. enabled is false.<br>3. session_type is not DESKTOP.<br>4. global_entitlement is set.<br>5. user_assignment is DEDICATED.<br>6. automatic_user_assignment is false.<br>7. Local entitlements are configured.<br>8. Any of the machines in the pool have users assigned.<br>9. cs_restriction_tags is not set.<br>10. type is MANUAL.<br>","example":false},"cs_restriction_tags":{"type":"array","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":["CS1_TAG1"],"items":{"type":"string","description":"List of Connection server restriction tags for which the access to the desktop pool is restricted to. If this property is not set then it indicates that desktop pool can be accessed from any connection server.","example":"[\"CS1_TAG1\"]"}},"customization_settings":{"$ref":"#/components/schemas/DesktopPoolCustomizationSettingsUpdateV3"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the desktop pool.","example":"Desktop Pool Description"},"display_assigned_machine_name":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.","example":false},"display_machine_alias":{"type":"boolean","description":"Applicable To: Dedicated desktop pools.<br>Indicates whether users should see the machine alias of the machine assigned to them instead of displayName when they connect using Horizon Client. If no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. If both display_assigned_machine_name and this property is set to true, machine alias of the assigned machine is displayed if the user has machine alias set. Otherwise hostname will be displayed.","example":true},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the desktop pool.","example":"pool"},"display_protocol_settings":{"$ref":"#/components/schemas/DesktopPoolDisplayProtocolSettingsUpdateSpecV2"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions are to be applied to desktop pool. ","example":false},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning is enabled. This is required for Automated desktop pools.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the desktop pool is enabled for brokering.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled for the desktop pool","example":true},"nics":{"type":"array","description":"Applicable To: Instant Clone desktop pools.<br>Network interface card settings for machines provisioned for this desktop pool. A NIC may appear at most once in these settings and must be present on this desktop pool's parent's snapshot or template. Not all NICs need be configured. If value is not configured than will use default settings.","items":{"$ref":"#/components/schemas/DesktopPoolNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/DesktopPoolProvisioningSettingsUpdateSpec"},"require_strong_auth":{"type":"boolean","description":"Indicates whether this pool requires strong authentication to connect.\nDefault value - false."},"session_settings":{"$ref":"#/components/schemas/DesktopPoolSessionSettingsUpdateSpecV2"},"session_type":{"type":"string","description":"Applicable To: Managed desktop pools.<br>Supported session types for this desktop pool. If this property is set to APPLICATION then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. This is required for managed desktop pools.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP: Only desktop sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","example":"DESKTOP","enum":["APPLICATION","DESKTOP","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool. This is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopPoolVirtualMachineSpecifiedNamingSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable To: Automated desktop pools.<br>Indicates whether provisioning on all machines stops on error. This is required for Automated desktop pools.","example":true},"storage_settings":{"$ref":"#/components/schemas/DesktopPoolStorageSettingsUpdateSpecV2"},"transparent_page_sharing_scope":{"type":"string","description":"Applicable To: Managed Manual and Automated desktop pools.<br>The transparent page sharing scope. This is required for Manual and Automated desktop pools.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["DESKTOP_POOL","GLOBAL","POD","VM"]},"uem_server_id":{"type":"string","description":"UEM Server Id.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"view_storage_accelerator_settings":{"$ref":"#/components/schemas/DesktopPoolViewStorageAcceleratorSettingsUpdateSpec"}},"description":"Desktop Pool object to be updated."},"DesktopPoolViewStorageAcceleratorSettings":{"type":"object","properties":{"blackout_times":{"type":"array","description":"A list of blackout times. Storage accelerator regeneration and machine disk space reclamation do not occur during blackout times. The same blackout policy applies to both operations. If unset, no blackout times are used.","items":{"$ref":"#/components/schemas/ViewStorageAcceleratorBlackoutTimeSettings"}},"regenerate_view_storage_accelerator_days":{"type":"integer","description":"How often to regenerate the View Storage Accelerator cache. Measured in Days.\nThis property can be used for sorting.","format":"int32","example":7},"use_view_storage_accelerator":{"type":"boolean","description":"Whether to use View Storage Accelerator.\nThis property can be used for sorting.","example":false},"view_storage_accelerator_disk_types":{"type":"string","description":"Disk types to enable for the View Storage Accelerator feature. This is only applicable to linked clone desktop pools.\nThis property can be used for sorting.\n* OS_DISKS: OS disks.\n* OS_AND_PERSISTENT_DISKS: OS and persistent disks.","example":"OS_DISKS","enum":["OS_DISKS","OS_AND_PERSISTENT_DISKS"]}},"description":"Settings related to the View Storage Accelerator feature."},"DesktopPoolViewStorageAcceleratorSettingsCreateSpec":{"type":"object","properties":{"blackout_times":{"type":"array","description":"A list of blackout times.","items":{"$ref":"#/components/schemas/ViewStorageAcceleratorBlackoutTimeSettingsCreateSpec"}},"regenerate_view_storage_accelerator_days":{"maximum":999,"minimum":1,"type":"integer","description":"How often to regenerate the View Storage Accelerator cache. Measured in Days. <br> This property is required if useViewStorageAccelerator is set to true. <br> Default value is 7.","format":"int32","example":7},"use_view_storage_accelerator":{"type":"boolean","description":"Indicates whether to use View Storage Accelerator. <br> Default value is false.","example":false}},"description":"Applicable To: Managed Desktop Pool. <br>View Storage Accelerator settings for Managed desktop pool."},"DesktopPoolViewStorageAcceleratorSettingsUpdateSpec":{"required":["use_view_storage_accelerator"],"type":"object","properties":{"blackout_times":{"type":"array","description":"A list of blackout times.","items":{"$ref":"#/components/schemas/ViewStorageAcceleratorBlackoutTimeSettingsUpdateSpec"}},"regenerate_view_storage_accelerator_days":{"maximum":999,"minimum":1,"type":"integer","description":"How often to regenerate the View Storage Accelerator cache. Measured in Days. This property has a default value of 7.","format":"int32","example":7},"use_view_storage_accelerator":{"type":"boolean","description":"Indicates whether to use View Storage Accelerator.","example":false}},"description":"Applicable To: Managed desktop pool. <br>Settings related to the View Storage Accelerator for Managed desktop pool. "},"DesktopPoolVirtualMachinePatternNamingSettings":{"type":"object","properties":{"max_number_of_machines":{"type":"integer","description":"Maximum number of machines in the desktop pool.\nThis property can be used for sorting.","format":"int32","example":100},"min_number_of_machines":{"type":"integer","description":"The minimum number of machines to have provisioned if on demand provisioning is selected.\nThis property can be used for sorting.","format":"int32","example":10},"naming_pattern":{"type":"string","description":"Virtual machines will be named according to the specified naming pattern.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":"vm-{n}-sales"},"number_of_spare_machines":{"type":"integer","description":"Number of spare powered on machines.\nThis property can be used for sorting.","format":"int32","example":10},"provisioning_time":{"type":"string","description":"Determines when the machines are provisioned.\nThis property can be used for sorting.\n* ON_DEMAND: Provision machines on demand.\n* UP_FRONT: Provision all machines up-front.","example":"ON_DEMAND","enum":["ON_DEMAND","UP_FRONT"]}},"description":"Settings related to specification of VMs with a naming pattern."},"DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec":{"required":["naming_pattern"],"type":"object","properties":{"max_number_of_machines":{"minimum":1,"type":"integer","description":"Maximum number of machines in the desktop pool. <br> Default value is 1.","format":"int32","example":100},"min_number_of_machines":{"minimum":0,"type":"integer","description":"This is applicable if provisioning_time is set to ON_DEMAND with default value of 0. <br>","format":"int32","example":10},"naming_pattern":{"type":"string","description":"Virtual machines will be named according to the specified naming pattern.<br> By default, view manager appends a unique number to the specified pattern to provide a unique name for each virtual machine. To place this unique number elsewhere in the pattern, use '{n}'. (For example: vm-{n}-sales.) The unique number can also be made a fixed length. (For example: vm-{n:fixed=3}-sales will name VMs from vm-001-sales to vm-999-sales). <br>Machine names are constrained to a maximum size of 15 characters including the unique number for Windows VMs. For non-Windows VMs, the maximum size is 60 characters. Therefore, care must be taken when choosing a pattern. Examples for Windows machines (15 characters): If the maximum desktop size is 9 machines, the pattern must be at most 14 characters. For 99 machines, 13 characters, for 999 machines, 12 characters. For 9999 machines, 11 characters. If using a fixed size token, use a maximum of 14 characters for \"n=1\", 13 characters for \"n=2\", 12 characters for \"n=3\", and 11 characters for \"n=4\".<br>If {n} is specified with no size, a size of 2 is automatically used and if no {} is specified, {n=2} is automatically appended to the end of the pattern.","example":"vm-{n}-sales"},"number_of_spare_machines":{"minimum":0,"type":"integer","description":"Number of spare powered on machines. <br> Default value is 1.","format":"int32","example":10},"provisioning_time":{"type":"string","description":"Determines when the machines are provisioned. <br> Default value is UP_FRONT\n* ON_DEMAND: Provision machines on demand.\n* UP_FRONT: Provision all machines up-front.","example":"UP_FRONT","enum":["ON_DEMAND","UP_FRONT"]}},"description":"Applicable To: Automated desktop pool. <br>Naming pattern settings for Automated desktop pool."},"DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec":{"required":["max_number_of_machines","naming_pattern","number_of_spare_machines","provisioning_time"],"type":"object","properties":{"max_number_of_machines":{"minimum":1,"type":"integer","description":"Maximum number of machines in the desktop pool.","format":"int32","example":100},"min_number_of_machines":{"minimum":0,"type":"integer","description":"The minimum number of machines to have provisioned if on demand provisioning is selected. This property is required if provisioning_time is set to \"ON_DEMAND\" .","format":"int32","example":10},"naming_pattern":{"type":"string","description":"Virtual machines will be named according to the specified naming pattern. Horizon appends a unique number to the specified pattern to provide a unique name for each virtual machine. To place this unique number elsewhere in the pattern, use '{n}'. (For example: vm-{n}-sales.) The unique number can also be made a fixed length. (For example: vm-{n:fixed=3}-sales will name VMs from vm-001-sales to vm-999-sales).\nMachine names are constrained to a maximum size of 15 characters including the unique number, for Windows VMs. For non-Windows VMs, the maximum size is 60 characters. Therefore, care must be taken when choosing a pattern. Examples for Windows machines (15 characters): If the maximum desktop pool size is 9 machines, the pattern must be at most 14 characters. For 99 machines, 13 characters, for 999 machines, 12 characters. For 9999 machines, 11 characters. If using a fixed size token, use a maximum of 14 characters for \"n=1\", 13 characters for \"n=2\", 12 characters for \"n=3\", and 11 characters for \"n=4\".If {n} is specified with no size, a size of 2 is automatically used and if no {} is specified, {n=2} is automatically appended to the end of the pattern. This property must contain only alphanumerics and dashes. It must contain at least one alpha character. It may also optionally contain a numeric placement token {n} or {n:fixed=#}. If the pattern does not specify the numeric placement token, the maximum length is 14 characters.","example":"vm-{n}-sales"},"number_of_spare_machines":{"minimum":0,"type":"integer","description":"Number of spare powered on machines.","format":"int32","example":10},"provisioning_time":{"type":"string","description":"Determines when the machines are provisioned.\n* ON_DEMAND: Provision machines on demand.\n* UP_FRONT: Provision all machines up-front.","example":"ON_DEMAND","enum":["ON_DEMAND","UP_FRONT"]}},"description":"Applicable To: Automated desktop pool. <br>Naming pattern settings for Automated desktop pool."},"DesktopPoolVirtualMachineSpecifiedNamingSettings":{"type":"object","properties":{"num_machines":{"type":"integer","description":"Number of machines in the pool.","format":"int32","example":10},"num_unassigned_machines_kept_powered_on":{"type":"integer","description":"Number of unassigned machines kept powered on. This value must be less than or equal to the number of specified names.\nThis property can be used for sorting.","format":"int32","example":1},"start_machines_in_maintenance_mode":{"type":"boolean","description":"Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited manually.\nThis property can be used for sorting.","example":false}},"description":"Settings related to specified naming of machines."},"DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec":{"type":"object","properties":{"num_unassigned_machines_kept_powered_on":{"minimum":1,"type":"integer","description":"Number of unassigned machines kept powered on. This property must be lesser than or equal to the number of specified names.<br> Default value is 1.","format":"int32","example":1},"specified_names":{"type":"array","description":"Specified names for the virtual machines.","items":{"$ref":"#/components/schemas/MachineSpecifiedName"}},"start_machines_in_maintenance_mode":{"type":"boolean","description":"Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited manually. <br> Default value is false.","example":false}},"description":"Applicable To: Automated Desktop Pool. <br>Settings related to specified naming of machines for Automated desktop pool."},"DesktopPoolVirtualMachineSpecifiedNamingSettingsUpdateSpec":{"required":["num_unassigned_machines_kept_powered_on","start_machines_in_maintenance_mode"],"type":"object","properties":{"num_unassigned_machines_kept_powered_on":{"minimum":1,"type":"integer","description":"Number of unassigned machines kept powered on. This value must be lesser than or equal to the number of specified names.","format":"int32","example":1},"specified_names":{"type":"array","description":"Initial specified names of machines in the desktop pool.","items":{"$ref":"#/components/schemas/MachineSpecifiedName"}},"start_machines_in_maintenance_mode":{"type":"boolean","description":"Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited manually.","example":false}},"description":"Applicable To: Automated desktop pool. <br>Specified naming setting for Automated desktop pool."},"DesktopPowerScheduleCreateSpec":{"required":["name","resume_time","suspend_time","timezone"],"type":"object","properties":{"days_of_the_week":{"type":"array","description":"Days of the week","example":["MONDAY","TUESDAY"],"items":{"type":"string","description":"Days of the week","example":"[\"MONDAY\",\"TUESDAY\"]"}},"name":{"type":"string","description":"Name of the schedule","example":"weekday"},"resume_time":{"type":"string","description":"Machine resume time, This property must contain the time in 24 hours format.","example":"09:30"},"suspend_time":{"type":"string","description":"Machine suspend time, This property must contain the time in 24 hours format.","example":"17:30"},"timezone":{"type":"string","description":"Timezone of the schedule","example":"Asia/Kolkata"}},"description":"The Schedules for the machines. This can only be set when the power_policy is set to SCHEDULED"},"DesktopProvisioningSettingsCreateSpec":{"type":"object","properties":{"desktop_name_pattern_settings":{"$ref":"#/components/schemas/DesktopNamePatternSettingsCreateSpec"},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as true.<br>Indicates whether provisioning is enabled.<br>","example":true},"naming_method":{"type":"string","description":"Applicable To: Automated desktop pool.<br>Naming method for the desktop pool. This is required for Automated desktop pools.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"PATTERN","enum":["SPECIFIED","PATTERN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopSpecifiedNamingSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable for Automated pools only with default value as true.","example":true}},"description":"Applicable To: Automated desktop pool. <br>Capacity provider provisioning settings for Automated desktop pool."},"DesktopProvisioningSettingsUpdateSpec":{"type":"object","properties":{"desktop_name_pattern_settings":{"$ref":"#/components/schemas/DesktopNamePatternSettingsUpdateSpec"},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as true.<br>Indicates whether provisioning is enabled.<br>","example":true},"naming_method":{"type":"string","description":"Applicable To: Automated desktop pool.<br>Naming method for the desktop pool. This is required for Automated desktop pools.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"PATTERN","enum":["SPECIFIED","PATTERN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopSpecifiedNamingSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable for Automated pools only with default value as true.","example":true}},"description":"Applicable To: Automated desktop pool. <br>Capacity provider provisioning settings for Automated desktop pool."},"DesktopSessionSettings":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment. Default value is false.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false.\nThis property can be used for sorting.","example":false},"bypass_session_timeout":{"type":"boolean","description":"Session timeout policy. Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION with default value as false.","example":true},"empty_session_timeout_minutes":{"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. This is required if the empty_session_timeout_policy set to AFTER. Default value is 1.\nThis property can be used for sorting.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Application empty session timeout policy. Default value is AFTER.\nThis property can be used for sorting.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"log_off_after_disconnect":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER.\nThis property can be used for sorting.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"log_off_after_disconnect_timeout_minutes":{"type":"integer","description":"Disconnected sessions timeout (in minutes). This is required if logOff_after_disconnect is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"logoff_after_timeout":{"type":"boolean","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. Default value is false.\nThis property can be used for sorting.","example":false},"pre_launch_session_timeout_minutes":{"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. This is required if pre_launch_session_timeout_policy is set to AFTER. Default value is 10.\nThis property can be used for sorting.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Application pre-launch session timeout policy. Default value is AFTER.\nThis property can be used for sorting.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","description":"Indicates whether and when to refresh the OS disks. Applicable To: dedicated desktop pools with default value as NEVER.\nThis property can be used for sorting.\n* ALWAYS: The OS disk is refreshed every time the user logs off.\n* AT_SIZE: The OS disk is refreshed when its current size reaches a specified percentage of its maximum allowable size. The maximum size of a linked clone's OS disk is the size of the replica's OS disk. With this option, the size of the linked clone's OS disk in the datastore is compared to maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.\n* EVERY: The OS disk is refreshed at regular intervals of a specified number of days. The number of days is counted from the last refresh, or from the initial provisioning if no refresh has occurred yet. For example, if the specified value is 3 days, and three days have passed since the last refresh, the machine is refreshed after the user logs off.\n* NEVER: The OS disk is never refreshed.","example":"NEVER","enum":["ALWAYS","AT_SIZE","EVERY","NEVER"]},"refresh_period_days_for_replica_os_disk":{"type":"integer","description":"Regular interval at which to refresh the OS disk. Will be set when refresh_os_disk_after_logoff set to EVERY.\nThis property can be used for sorting.","format":"int32","example":20},"refresh_threshold_percentage_for_replica_os_disk":{"type":"integer","description":"With the 'AT_SIZE' option for refreshOsDiskAfterLogoff, the size of the linked clone's OS diskin the datastore is compared to its maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.Will be set when refresh_os_disk_after_logoff set to AT_SIZE.\nThis property can be used for sorting.","format":"int32","example":30},"session_collaboration_enabled":{"type":"boolean","description":" Enable session collaboration feature. Session collaboration allows a user to share their remote session with other users. BLAST must be configured as a supported protocol \nThis property can be used for sorting.","example":false},"used_vm_policy":{"type":"string","description":"Specifies the cleanup action to be taken in the event of not cleanly logged off for VMs within a pool that is configured with either a 'Refresh machine after logoff' or 'Delete machine after logoff' policy, or to block user access in case of uncleaned logoff. This is applicable for automated desktop pools with floating user assignment.\nThis property can be used for sorting.\n* ALLOW_WITHOUT_REFRESH: Allow virtual machines that were not cleanly logged off to become available without being refreshed.\n* AUTO_REFRESH: Automatically refresh virtual machines that were not cleanly logged off. Users can access these virtual machines after the refresh operation is completed.\n* BLOCK_ACCESS: Mark virtual machines that were not cleanly logged off as \"Already used\" and block user access to them.","example":"BLOCK_ACCESS","enum":["ALLOW_WITHOUT_REFRESH","AUTO_REFRESH","BLOCK_ACCESS"]}},"description":"Applicable To: Automated and Manual desktop pool. <br>Desktop session settings for Automated and Manual desktop pool."},"DesktopSessionSettingsCreateSpec":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment. Default value is false.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false.","example":false},"bypass_session_timeout":{"type":"boolean","description":"Session timeout policy. Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION with default value as false.","example":true},"empty_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. This is required if the empty_session_timeout_policy set to AFTER. Default value is 1.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Application empty session timeout policy. Default value is AFTER.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"log_off_after_disconnect_policy":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"log_off_after_disconnect_timeout_minutes":{"minimum":1,"type":"integer","description":"Disconnected sessions timeout (in minutes). This is required if logOff_after_disconnect is set to AFTER.<br>","format":"int32","example":5},"logoff_after_timeout":{"type":"boolean","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. Default value is false.","example":false},"pre_launch_session_timeout_minutes":{"minimum":10,"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. This is required if pre_launch_session_timeout_policy is set to AFTER. Default value is 10.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Application pre-launch session timeout policy. Default value is AFTER.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","description":"Indicates whether and when to refresh the OS disks. Applicable To: dedicated desktop pools with default value as NEVER.\n* ALWAYS: The OS disk is refreshed every time the user logs off.\n* EVERY: The OS disk is refreshed at regular intervals of a specified number of days. The number of days is counted from the last refresh, or from the initial provisioning if no refresh has occurred yet. For example, if the specified value is 3 days, and three days have passed since the last refresh, the machine is refreshed after the user logs off.\n* NEVER: The OS disk is never refreshed.","example":"NEVER","enum":["ALWAYS","EVERY","NEVER"]},"refresh_period_days_for_replica_os_disk":{"minimum":1,"type":"integer","description":"Regular interval at which to refresh the OS disk. This is required if when refresh_os_disk_after_logoff set to EVERY.","format":"int32","example":20},"session_collaboration_enabled":{"type":"boolean","description":"Applicable To: Automated and Manual pools with default value of false. <br> Enable session collaboration feature. Session collaboration allows a user to share their remote session with other users. BLAST must be configured as a supported protocol ","example":false},"used_vm_policy":{"type":"string","description":"Specifies the cleanup action to be taken in the event of not cleanly logged off for VMs within a pool that is configured with either a 'Refresh machine after logoff' or 'Delete machine after logoff' policy, or to block user access in case of uncleaned logoff. This is applicable for automated desktop pools with floating user assignment.\n* ALLOW_WITHOUT_REFRESH: Allow virtual machines that were not cleanly logged off to become available without being refreshed.\n* AUTO_REFRESH: Automatically refresh virtual machines that were not cleanly logged off. Users can access these virtual machines after the refresh operation is completed.\n* BLOCK_ACCESS: Mark virtual machines that were not cleanly logged off as \"Already used\" and block user access to them.","example":"BLOCK_ACCESS","enum":["ALLOW_WITHOUT_REFRESH","AUTO_REFRESH","BLOCK_ACCESS"]}},"description":"Applicable To: Automated and Manual desktop pool. <br>Desktop session settings for Automated and Manual desktop pool."},"DesktopSessionSettingsUpdateSpec":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false.","example":false},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the desktop pool supports session launch from user specified machines.Not applicable for dedicated user assignment. Default value is false.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false.","example":false},"bypass_session_timeout":{"type":"boolean","description":"Session timeout policy. Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION with default value as false.","example":true},"empty_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. This is required if the empty_session_timeout_policy set to AFTER. Default value is 1.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Application empty session timeout policy. Default value is AFTER.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logOffAfterDisconnectPolicy":{"type":"string","description":"\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","writeOnly":true,"enum":["AFTER","IMMEDIATELY","NEVER"]},"log_off_after_disconnect":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"log_off_after_disconnect_timeout_minutes":{"minimum":1,"type":"integer","description":"Disconnected sessions timeout (in minutes). This is required if logOff_after_disconnect is set to AFTER.<br>","format":"int32","example":5},"logoff_after_timeout":{"type":"boolean","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. Default value is false.","example":false},"pre_launch_session_timeout_minutes":{"minimum":10,"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. This is required if pre_launch_session_timeout_policy is set to AFTER. Default value is 10.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. <br>Application pre-launch session timeout policy. Default value is AFTER.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","description":"Indicates whether and when to refresh the OS disks. Applicable To: dedicated desktop pools with default value as NEVER.\n* ALWAYS: The OS disk is refreshed every time the user logs off.\n* EVERY: The OS disk is refreshed at regular intervals of a specified number of days. The number of days is counted from the last refresh, or from the initial provisioning if no refresh has occurred yet. For example, if the specified value is 3 days, and three days have passed since the last refresh, the machine is refreshed after the user logs off.\n* NEVER: The OS disk is never refreshed.","example":"NEVER","enum":["ALWAYS","EVERY","NEVER"]},"refresh_period_days_for_replica_os_disk":{"minimum":1,"type":"integer","description":"Regular interval at which to refresh the OS disk. This is required if when refresh_os_disk_after_logoff set to EVERY.","format":"int32","example":20},"session_collaboration_enabled":{"type":"boolean","description":"Applicable To: Automated and Manual pools with default value of false. <br> Enable session collaboration feature. Session collaboration allows a user to share their remote session with other users. BLAST must be configured as a supported protocol ","example":false},"used_vm_policy":{"type":"string","description":"Specifies the cleanup action to be taken in the event of not cleanly logged off for VMs within a pool that is configured with either a 'Refresh machine after logoff' or 'Delete machine after logoff' policy, or to block user access in case of uncleaned logoff. This is applicable for automated desktop pools with floating user assignment.\n* ALLOW_WITHOUT_REFRESH: Allow virtual machines that were not cleanly logged off to become available without being refreshed.\n* AUTO_REFRESH: Automatically refresh virtual machines that were not cleanly logged off. Users can access these virtual machines after the refresh operation is completed.\n* BLOCK_ACCESS: Mark virtual machines that were not cleanly logged off as \"Already used\" and block user access to them.","example":"BLOCK_ACCESS","enum":["ALLOW_WITHOUT_REFRESH","AUTO_REFRESH","BLOCK_ACCESS"]}},"description":"Applicable To: Automated and Manual desktop pool. <br>Desktop session settings for Automated and Manual desktop pool."},"DesktopSpecifiedNamingSettings":{"type":"object","properties":{"num_machines":{"type":"integer","description":"Number of machines in the pool.","format":"int32","example":10},"num_unassigned_machines_kept_powered_on":{"type":"integer","description":"Number of unassigned machines kept powered on. This property must be lesser than or equal to the number of specified names.\nThis property can be used for sorting.","format":"int32","example":1},"start_machines_in_maintenance_mode":{"type":"boolean","description":"Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited \nThis property can be used for sorting.","example":false}},"description":"Applicable To: Automated Desktop Pool. <br>Settings related to specified naming of machines for Automated desktop pool."},"DesktopSpecifiedNamingSettingsCreateSpec":{"type":"object","properties":{"num_unassigned_machines_kept_powered_on":{"minimum":1,"type":"integer","description":"Number of unassigned machines kept powered on. This property must be lesser than or equal to the number of specified names.<br> Default value is 1.","format":"int32","example":1},"specified_names":{"type":"array","description":"Specified names for the machines.","items":{"$ref":"#/components/schemas/MachineSpecifiedName"}},"start_machines_in_maintenance_mode":{"type":"boolean","description":"Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited manually. <br> Default value is false.","example":false}},"description":"Applicable To: Automated Desktop Pool. <br>Settings related to specified naming of machines for Automated desktop pool."},"DesktopSpecifiedNamingSettingsUpdateSpec":{"type":"object","properties":{"num_unassigned_machines_kept_powered_on":{"minimum":1,"type":"integer","description":"Number of unassigned machines kept powered on. This property must be lesser than or equal to the number of specified names.<br> Default value is 1.","format":"int32","example":1},"specified_names":{"type":"array","description":"Specified names for the machines.","items":{"$ref":"#/components/schemas/MachineSpecifiedName"}},"start_machines_in_maintenance_mode":{"type":"boolean","description":"Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited manually. <br> Default value is false.","example":false}},"description":"Applicable To: Automated Desktop Pool. <br>Settings related to specified naming of machines for Automated desktop pool."},"DisplayProtocolPerformanceInfo":{"type":"object","properties":{"blast_performance_data":{"$ref":"#/components/schemas/BlastPerformanceData"},"pcoip_performance_data":{"$ref":"#/components/schemas/PcoipPerformanceData"}},"description":"Information about display protocol performance."},"DisplayProtocolPerformanceInfoV2":{"type":"object","properties":{"blast_performance_data_v2":{"$ref":"#/components/schemas/BlastPerformanceDataV2"},"pcoip_performance_data":{"$ref":"#/components/schemas/PcoipPerformanceData"}},"description":"Information about display protocol performance."},"DisplayTopology":{"type":"object","properties":{"dpi":{"type":"integer","description":"DPI Value.","format":"int32","example":240},"getxCoordinate":{"type":"integer","description":"x value.","format":"int32","example":0},"getyCoordinate":{"type":"integer","description":"y value.","format":"int32","example":0},"hdr":{"type":"object","description":"HDR Value.","example":"Enabled"},"height":{"type":"integer","description":"Display Height.","format":"int32","example":2081},"refresh_rate":{"type":"integer","description":"Refresh Rate.","format":"int32","example":60},"width":{"type":"integer","description":"Display Width.","format":"int32","example":3808}},"description":"The Display Topology."},"EndsWithFilter":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseFilter"},{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"object"}}}],"required":["name","type","value"]},"EnrollmentServerDetails":{"type":"object","properties":{"dns_name":{"type":"string","description":"Enrollment server dns name.","example":"enrollment-server.example.com"},"id":{"type":"string","description":"Unique ID of the Enrollment Server.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"status":{"type":"string","description":"Enrollment server status.\n* OK: The state of enrollment server is OK.\n* ERROR: The enrollment server has an error.","example":"OK","enum":["OK","ERROR"]}},"description":"The secondary enrollment server details."},"EnrollmentServerDetailsV2":{"type":"object","properties":{"dns_name":{"type":"string","description":"Enrollment server dns name.","example":"enrollment-server.example.com"},"id":{"type":"string","description":"Unique ID of the Enrollment Server.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"state_reasons":{"type":"array","description":"Error state reasons.","example":"UNREACHABLE_ON_LOCAL_BROKER","items":{"type":"string","description":"* UNREACHABLE_ON_POD: Error: The enrollment server cannot be contacted by the pod.\n* UNREACHABLE_ON_LOCAL_BROKER: Error: The enrollment server cannot be contacted by the local broker.","example":"UNREACHABLE_ON_LOCAL_BROKER","enum":["UNREACHABLE_ON_POD","UNREACHABLE_ON_LOCAL_BROKER"]}},"status":{"type":"string","description":"Enrollment server status.\n* OK: The state of enrollment server is OK.\n* ERROR: The enrollment server has an error.","example":"OK","enum":["OK","ERROR"]}},"description":"The secondary enrollment server details."},"EntitlementInfo":{"type":"object","properties":{"ad_user_or_group_ids":{"type":"array","description":"List of ad-user-or-group SIDs which are entitled to the given resource.","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"items":{"type":"string","description":"List of ad-user-or-group SIDs which are entitled to the given resource.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\",\"S-1-2-3-3123456786-1012345398-3123456784-124\"]"}},"id":{"type":"string","description":"Unique ID representing the resource.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"}},"description":"Entitlement Information related to the resource.<br>List API returning this summary information can use search filter queryto filter on specific fields supported by filters.<br>Supported Filters : 'Or','Equals'.<br>See the field description to know the filter types it supports."},"EntitlementResponseInfo":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","description":"Unique SID representing the ad-user-or-group","example":"S-1-5-21-2898529287-1016622242-505487308-500"},"error_messages":{"type":"array","description":"Reasons for the failure of the operation. This field is deprecated since 2203 release.","example":["Entity does not exists.","Property is mandatory."],"deprecated":true,"items":{"type":"string","description":"Reasons for the failure of the operation. This field is deprecated since 2203 release.","example":"[\"Entity does not exists.\",\"Property is mandatory.\"]"}},"errors":{"type":"array","description":"List of error objects containing error key and error message.","items":{"$ref":"#/components/schemas/APIError"}},"status_code":{"type":"integer","description":"Response HTTP status code of the operation.","format":"int32","example":200},"timestamp":{"type":"integer","description":"Timestamp in milliseconds when the operation failed. Measured as epoch time.","format":"int64","example":1561939200000}},"description":"Entitlement response info object corresponding to the given ad-user-or-group SID for the entitlement operation."},"EntitlementSpec":{"required":["id"],"type":"object","properties":{"ad_user_or_group_ids":{"uniqueItems":true,"type":"array","description":"List of ad-user-or-group SIDs for the entitlement operations on the given resource.","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"items":{"type":"string","description":"List of ad-user-or-group SIDs for the entitlement operations on the given resource.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\",\"S-1-2-3-3123456786-1012345398-3123456784-124\"]"}},"id":{"type":"string","description":"Unique ID representing the resource.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"}},"description":"Specification for entitlement operations on a given resource id."},"EnvironmentInfo":{"type":"object","properties":{"cluster_guid":{"type":"string","description":"The GUID of a group of Connection Servers sharing the same configuration.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"cluster_name":{"type":"string","description":"The name of a group of Connection Servers sharing the same configuration.","example":"master-cluster"},"fips_mode_enabled":{"type":"boolean","description":"Indicates if FIPS mode is enabled.","example":false},"ip_mode":{"type":"string","description":"Indicates the IP mode of the environment.\n* IPv4: The ip mode is IPv4.\n* IPv6: The ip mode is IPv6.","example":"IPv4","enum":["IPv4","IPv6"]},"local_pod_name":{"type":"string","description":"The name of the current pod in the Multi-DataCenter Horizon Pod, the value will be null when PodFederation is not initialized.","example":"master-pod"},"timezone_offset":{"type":"integer","description":"Represents the clusters time zone offset from UTC in seconds.","format":"int32","example":19800}},"description":"Information related to Environment Settings."},"EnvironmentInfoV2":{"type":"object","properties":{"cluster_guid":{"type":"string","description":"The GUID of a group of Connection Servers sharing the same configuration.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"cluster_name":{"type":"string","description":"The name of a group of Connection Servers sharing the same configuration.","example":"master-cluster"},"deployment_type":{"type":"string","description":"Indicates different environments that Horizon can be deployed into.\n* GENERAL: Horizon is deployed on On-premises.\n* AZURE: Horizon is deployed on Azure.\n* AWS: Horizon is deployed on AWS.\n* DELL_EMC: Horizon is deployed on Dell EMC.\n* GOOGLE: Horizon is deployed on Google Cloud.\n* ORACLE: Horizon is deployed on Oracle Cloud.","enum":["GENERAL","AZURE","AWS","DELL_EMC","GOOGLE","ORACLE"]},"fips_mode_enabled":{"type":"boolean","description":"Indicates if FIPS mode is enabled.","example":false},"ip_mode":{"type":"string","description":"Indicates the IP mode of the environment.\n* IPv4: The ip mode is IPv4.\n* IPv6: The ip mode is IPv6.","example":"IPv4","enum":["IPv4","IPv6"]},"local_connection_server_build":{"type":"string","description":"Local connection Server build number.","example":"12345678"},"local_connection_server_version":{"type":"string","description":"Local connection Server version number.","example":"8.1.0"},"local_pod_name":{"type":"string","description":"The name of the current pod in the Multi-DataCenter Horizon Pod, the value will be null when PodFederation is not initialized.","example":"master-pod"},"timezone_offset":{"type":"integer","description":"Represents the clusters time zone offset from UTC in seconds.","format":"int32","example":19800}},"description":"Information related to Environment Settings."},"EnvironmentInfoV3":{"type":"object","properties":{"cluster_guid":{"type":"string","description":"The GUID of a group of Connection Servers sharing the same configuration.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"cluster_name":{"type":"string","description":"The name of a group of Connection Servers sharing the same configuration.","example":"master-cluster"},"deployment_type":{"type":"string","description":"Indicates different environments that Horizon can be deployed into.\n* GENERAL: Horizon is deployed on On-premises.\n* AZURE: Horizon is deployed on Azure.\n* AWS: Horizon is deployed on AWS.\n* DELL_EMC: Horizon is deployed on Dell EMC.\n* GOOGLE: Horizon is deployed on Google Cloud.\n* ORACLE: Horizon is deployed on Oracle Cloud.","enum":["GENERAL","AZURE","AWS","DELL_EMC","GOOGLE","ORACLE"]},"fips_mode_enabled":{"type":"boolean","description":"Indicates if FIPS mode is enabled.","example":false},"has_new_data_partition":{"type":"boolean","description":"Indicates if connection Server has new data partition."},"ip_mode":{"type":"string","description":"Indicates the IP mode of the environment.\n* IPv4: The ip mode is IPv4.\n* IPv6: The ip mode is IPv6.","example":"IPv4","enum":["IPv4","IPv6"]},"local_connection_server_build":{"type":"string","description":"Local connection Server build number.","example":"12345678"},"local_connection_server_version":{"type":"string","description":"Local connection Server version number.","example":"8.1.0"},"local_pod_name":{"type":"string","description":"The name of the current pod in the Multi-DataCenter Horizon Pod, the value will be null when PodFederation is not initialized.","example":"master-pod"},"timezone_offset":{"type":"integer","description":"Represents the clusters time zone offset from UTC in seconds.","format":"int32","example":19800}}},"EqualsFilter":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseFilter"},{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"object"}}}],"required":["name","type"]},"EventDatabaseInfo":{"type":"object","properties":{"admin_events_count":{"type":"integer","description":"The number of events administrator can see in the admin console.","format":"int32","example":2000},"classify_events_as_new_for_days":{"type":"integer","description":"Events will be marked as new for a time based on the value.","format":"int32","example":3},"database_name":{"type":"string","description":"Name of the database on the database server to use for storing events. Note that this database must exist on the server or the values cannot be saved.","example":"eventdb"},"event_database_configured":{"type":"boolean","description":"Indicates if the event database has been configured or not.","example":true},"port":{"type":"integer","description":"Port number on the database server to which Horizon will send events.","format":"int32","example":1433},"query_timeout_seconds":{"type":"integer","description":"Query execution timeout in seconds.","format":"int32","example":120},"server_name":{"type":"string","description":"The server that hosts the database which will be used to store events.","example":"eventdb.horizon.com"},"show_events_for_time":{"type":"string","description":"Events will be shown in the Horizon Admin console for a time based on this value.\n* ONE_WEEK: One week.\n* TWO_WEEKS: Two weeks.\n* THREE_WEEKS: Three weeks.\n* ONE_MONTH: One month.\n* TWO_MONTHS: Two months.\n* THREE_MONTHS: Three months.\n* SIX_MONTHS: Six months.","example":"THREE_MONTHS","enum":["ONE_WEEK","TWO_WEEKS","THREE_WEEKS","ONE_MONTH","TWO_MONTHS","THREE_MONTHS","SIX_MONTHS"]},"table_prefix":{"type":"string","description":"If present, all tables for this instance will start with this prefix. This allows multiple brokers to use the same events database without trampling on other broker data.","example":"tab_"},"timing_profiler_data_longevity_days":{"type":"integer","description":"Timing Profiler data will be kept in database for a time based on the value. Timing Profiler Data will not be stored in Event DB.","format":"int32","example":7},"type":{"type":"string","description":"The type of database to use for the event database.\n* ORACLE: An Oracle database.\n* SQL_SERVER: A SQL server database.\n* POSTGRESQL: A PostgreSQL database.","example":"SQL_SERVER","enum":["ORACLE","SQL_SERVER","POSTGRESQL"]},"username":{"type":"string","description":"Username to use for the connection to the event database.","example":"administrator"}},"description":"Information about event database."},"EventDatabaseInfoV2":{"type":"object","properties":{"admin_events_count":{"type":"integer","description":"The number of events administrator can see in the admin console.","format":"int32","example":2000},"classify_events_as_new_for_days":{"type":"integer","description":"Events will be marked as new for a time based on the value.","format":"int32","example":3},"database_auth_mode":{"type":"string","description":"Indicates the type of event db authentication method.","example":"SQL_USER_AUTH"},"database_name":{"type":"string","description":"Name of the database on the database server to use for storing events. Note that this database must exist on the server or the values cannot be saved.","example":"eventdb"},"event_database_configured":{"type":"boolean","description":"Indicates if the event database has been configured or not.","example":true},"port":{"type":"integer","description":"Port number on the database server to which Horizon will send events.","format":"int32","example":1433},"query_timeout_seconds":{"type":"integer","description":"Query execution timeout in seconds.","format":"int32","example":120},"server_name":{"type":"string","description":"The server that hosts the database which will be used to store events.","example":"eventdb.horizon.com"},"show_events_for_time":{"type":"string","description":"Events will be shown in the Horizon Admin console for a time based on this value.\n* ONE_WEEK: One week.\n* TWO_WEEKS: Two weeks.\n* THREE_WEEKS: Three weeks.\n* ONE_MONTH: One month.\n* TWO_MONTHS: Two months.\n* THREE_MONTHS: Three months.\n* SIX_MONTHS: Six months.","example":"THREE_MONTHS","enum":["ONE_WEEK","TWO_WEEKS","THREE_WEEKS","ONE_MONTH","TWO_MONTHS","THREE_MONTHS","SIX_MONTHS"]},"table_prefix":{"type":"string","description":"If present, all tables for this instance will start with this prefix. This allows multiple brokers to use the same events database without trampling on other broker data.","example":"tab_"},"timing_profiler_data_longevity_days":{"type":"integer","description":"Timing Profiler data will be kept in database for a time based on the value. Timing Profiler Data will not be stored in Event DB.","format":"int32","example":7},"type":{"type":"string","description":"The type of database to use for the event database.\n* ORACLE: An Oracle database.\n* SQL_SERVER: A SQL server database.\n* POSTGRESQL: A PostgreSQL database.","example":"SQL_SERVER","enum":["ORACLE","SQL_SERVER","POSTGRESQL"]},"username":{"type":"string","description":"Username to use for the connection to the event database.","example":"administrator"}},"description":"Information about event database."},"EventDatabaseMonitorDetails":{"type":"object","properties":{"database_name":{"type":"string","description":"The name of the database.","example":"HorizonEventDB"},"port":{"type":"integer","description":"The port of the database server.","format":"int32","example":1433},"prefix":{"type":"string","description":"The prefix for event tables in the database.","example":"view_"},"server_name":{"type":"string","description":"The name or ip address of the database server.","example":"event-db.example.com"},"type":{"type":"string","description":"The type of the database.\n* ORACLE: An Oracle database.\n* SQL_SERVER: A SQL server database.\n* POSTGRESQL: A PostgreSQL database.","example":"SQL_SERVER","enum":["ORACLE","SQL_SERVER","POSTGRESQL"]},"user_name":{"type":"string","description":"The username used to connect to the database.","example":"sa"}},"description":"The basic details of the event database"},"EventDatabaseMonitorInfo":{"type":"object","properties":{"details":{"$ref":"#/components/schemas/EventDatabaseMonitorDetails"},"event_count":{"type":"integer","description":"Number of events recorded in the database","format":"int32","example":10000},"status":{"type":"string","description":"State of the database.\n* CONNECTED: Connection Server is connected to the database.\n* CONNECTING: Connection Server is connecting to the database.\n* DISCONNECTED: Connection Server is disconnected from the database.\n* RECONNECTING: Connection Server is reconnecting to the database.\n* ERROR: Error in connecting to the database from Connection Server.\n* NOT_CONFIGURED: Database is not configured.\n* UNKNOWN: Unknown state.","example":"CONNECTED","enum":["CONNECTED","CONNECTING","DISCONNECTED","RECONNECTING","ERROR","NOT_CONFIGURED","UNKNOWN"]}},"description":"Event Database Monitor Information"},"EventDatabaseMonitorInfoV2":{"type":"object","properties":{"details":{"$ref":"#/components/schemas/EventDatabaseMonitorDetails"},"error":{"type":"string","description":"Number of events that are going to be shown in admin console","example":"10000"},"event_count":{"type":"integer","description":"Number of events recorded in the database","format":"int32","example":10000},"status":{"type":"string","description":"State of the database.\n* CONNECTED: Connection Server is connected to the database.\n* CONNECTING: Connection Server is connecting to the database.\n* DISCONNECTED: Connection Server is disconnected from the database.\n* RECONNECTING: Connection Server is reconnecting to the database.\n* ERROR: Error in connecting to the database from Connection Server.\n* NOT_CONFIGURED: Database is not configured.\n* UNKNOWN: Unknown state.","example":"CONNECTED","enum":["CONNECTED","CONNECTING","DISCONNECTED","RECONNECTING","ERROR","NOT_CONFIGURED","UNKNOWN"]}},"description":"Event Database Monitor Information"},"EventDatabaseMonitorInfoV3":{"type":"object","properties":{"database_auth_mode":{"type":"string","description":"Indicates the type of event db authentication method.\n","example":"SQL_USER_AUTH","enum":["SQL_USER_AUTH","MANAGED_SA_AUTH","DOMAIN_USER_AUTH"]},"details":{"$ref":"#/components/schemas/EventDatabaseMonitorDetails"},"error":{"type":"string","description":"Number of events that are going to be shown in admin console","example":"10000"},"event_count":{"type":"integer","description":"Number of events recorded in the database","format":"int32","example":10000},"status":{"type":"string","description":"State of the database.\n* CONNECTED: Connection Server is connected to the database.\n* CONNECTING: Connection Server is connecting to the database.\n* DISCONNECTED: Connection Server is disconnected from the database.\n* RECONNECTING: Connection Server is reconnecting to the database.\n* ERROR: Error in connecting to the database from Connection Server.\n* NOT_CONFIGURED: Database is not configured.\n* UNKNOWN: Unknown state.","example":"CONNECTED","enum":["CONNECTED","CONNECTING","DISCONNECTED","RECONNECTING","ERROR","NOT_CONFIGURED","UNKNOWN"]}},"description":"Event Database Monitor Information"},"EventDatabaseUpdateSpec":{"required":["database_name","port","server_name","type","username"],"type":"object","properties":{"admin_events_count":{"type":"integer","description":"The number of events administrator can see in the admin console. It has a default value of 2000.","format":"int32","example":2000},"classify_events_as_new_for_days":{"maximum":3,"minimum":1,"type":"integer","description":"Events will be marked as new for a time based on the value. Must be between 1 and 3 days.","format":"int32","example":3},"database_name":{"type":"string","description":"Name of the database on the database server to use for storing events. Note that this database must exist on the server or the values cannot be saved.","example":"eventdb"},"password":{"type":"array","description":"Password to use for the event database connection.","example":"<password>","items":{"type":"string","description":"Password to use for the event database connection.","example":"<password>"}},"port":{"type":"integer","description":"Port number on the database server to which Horizon will send events.","format":"int32","example":1443},"query_timeout_seconds":{"type":"integer","description":"Query execution timeout in seconds. It has a default value of 120 seconds.","format":"int32","example":120},"server_name":{"type":"string","description":"The server that hosts the database which will be used to store events.","example":"eventdb.horizon.com"},"show_events_for_time":{"type":"string","description":"Events will be shown in the Horizon Admin console for a time based on this value. It has a default value of 3 months.\n* ONE_WEEK: One week.\n* TWO_WEEKS: Two weeks.\n* THREE_WEEKS: Three weeks.\n* ONE_MONTH: One month.\n* TWO_MONTHS: Two months.\n* THREE_MONTHS: Three months.\n* SIX_MONTHS: Six months.","example":"THREE_MONTHS","enum":["ONE_WEEK","TWO_WEEKS","THREE_WEEKS","ONE_MONTH","TWO_MONTHS","THREE_MONTHS","SIX_MONTHS"]},"table_prefix":{"pattern":"[a-zA-Z][a-zA-Z0-9_@$#]{1,6}","type":"string","description":"If present, all tables for this instance will start with this prefix. This allows multiple brokers to use the same events database without trampling on other broker data. This property must start with a letter, may only contain letters, numbers, and the characters @, $, #, and _, and may not be longer than 6 characters.","example":"tab_"},"timing_profiler_data_longevity_days":{"maximum":7,"minimum":1,"type":"integer","description":"Timing Profiler data will be kept in database for a time based on the value. Must be between 1 and 7 days. Timing Profiler Data will not be stored in Event DB. It has a default value of 7.","format":"int32","example":7},"type":{"type":"string","description":"The type of database to use for the event database.\n* ORACLE: An Oracle database.\n* SQL_SERVER: A SQL server database.\n* POSTGRESQL: A PostgreSQL database.","example":"SQL_SERVER","enum":["ORACLE","SQL_SERVER","POSTGRESQL"]},"username":{"type":"string","description":"Username to use for the connection to the event database.","example":"administrator"}},"description":"Event database configuration to be updated."},"EventDatabaseUpdateSpecV2":{"required":["database_name","port","server_name","type","username"],"type":"object","properties":{"admin_events_count":{"type":"integer","description":"The number of events administrator can see in the admin console. It has a default value of 2000.","format":"int32","example":2000},"classify_events_as_new_for_days":{"maximum":3,"minimum":1,"type":"integer","description":"Events will be marked as new for a time based on the value. Must be between 1 and 3 days.","format":"int32","example":3},"database_auth_mode":{"type":"string","description":"Indicates the type of event db authentication method.","example":"SQL_USER_AUTH","enum":["SQL_USER_AUTH","MANAGED_SA_AUTH","DOMAIN_USER_AUTH"]},"database_name":{"type":"string","description":"Name of the database on the database server to use for storing events. Note that this database must exist on the server or the values cannot be saved.","example":"eventdb"},"password":{"type":"array","description":"Password to use for the event database connection.","example":"<password>","items":{"type":"string","description":"Password to use for the event database connection.","example":"<password>"}},"port":{"type":"integer","description":"Port number on the database server to which Horizon will send events.","format":"int32","example":1443},"query_timeout_seconds":{"type":"integer","description":"Query execution timeout in seconds. It has a default value of 120 seconds.","format":"int32","example":120},"server_name":{"type":"string","description":"The server that hosts the database which will be used to store events.","example":"eventdb.horizon.com"},"show_events_for_time":{"type":"string","description":"Events will be shown in the Horizon Admin console for a time based on this value. It has a default value of 3 months.\n* ONE_WEEK: One week.\n* TWO_WEEKS: Two weeks.\n* THREE_WEEKS: Three weeks.\n* ONE_MONTH: One month.\n* TWO_MONTHS: Two months.\n* THREE_MONTHS: Three months.\n* SIX_MONTHS: Six months.","example":"THREE_MONTHS","enum":["ONE_WEEK","TWO_WEEKS","THREE_WEEKS","ONE_MONTH","TWO_MONTHS","THREE_MONTHS","SIX_MONTHS"]},"table_prefix":{"pattern":"[a-zA-Z][a-zA-Z0-9_@$#]{1,6}","type":"string","description":"If present, all tables for this instance will start with this prefix. This allows multiple brokers to use the same events database without trampling on other broker data. This property must start with a letter, may only contain letters, numbers, and the characters @, $, #, and _, and may not be longer than 6 characters.","example":"tab_"},"timing_profiler_data_longevity_days":{"maximum":7,"minimum":1,"type":"integer","description":"Timing Profiler data will be kept in database for a time based on the value. Must be between 1 and 7 days. Timing Profiler Data will not be stored in Event DB. It has a default value of 7.","format":"int32","example":7},"type":{"type":"string","description":"The type of database to use for the event database.\n* ORACLE: An Oracle database.\n* SQL_SERVER: A SQL server database.\n* POSTGRESQL: A PostgreSQL database.","example":"SQL_SERVER","enum":["ORACLE","SQL_SERVER","POSTGRESQL"]},"username":{"type":"string","description":"Username to use for the connection to the event database.","example":"administrator"}},"description":"Event database configuration to be updated."},"ExportCertificateSpec":{"required":["certificate_usage"],"type":"object","properties":{"certificate_password":{"type":"array","description":"Password for exporting the certificate.","example":"password","items":{"type":"string","description":"Password for exporting the certificate.","example":"password"}},"certificate_usage":{"type":"string","description":"Indicates how the certificate would be used.\n* MACHINE: vdm certificates\n* CLUSTER: vdm.ec certificates\n* CLUSTER_ENCRYPTION: vdm.enc certificates\n* EXTERNAL: vdm.ext certificates\n* SAML_SIGNING: saml.sig certificates\n* SAML_ENCRYPTION: saml.enc certificates","example":"MACHINE","enum":["MACHINE","CLUSTER","CLUSTER_ENCRYPTION","EXTERNAL","SAML_SIGNING","SAML_ENCRYPTION"]}},"description":"Export certificate spec."},"ExportedCertificate":{"type":"object","properties":{"certificate_chain":{"type":"string","format":"byte"},"certificate_usage":{"type":"string","description":"Indicates how the certificate would be used.\n* MACHINE: vdm certificates\n* CLUSTER: vdm.ec certificates\n* CLUSTER_ENCRYPTION: vdm.enc certificates\n* EXTERNAL: vdm.ext certificates\n* SAML_SIGNING: saml.sig certificates\n* SAML_ENCRYPTION: saml.enc certificates","example":"MACHINE","enum":["MACHINE","CLUSTER","CLUSTER_ENCRYPTION","EXTERNAL","SAML_SIGNING","SAML_ENCRYPTION"]},"format":{"type":"string","description":"Certificate Type.\n","example":"pfx","enum":["pem","pfx"]}},"description":"Exported certificate of connection server."},"ExternalDeploymentCreateSpec":{"required":["label","pod_url","url"],"type":"object","properties":{"certificate":{"type":"string","description":"External deployment certificate.","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"domain":{"type":"string","description":"Domain of the account used to login to External Deployment.","example":"example.com"},"label":{"type":"string","description":"Label for external deployment.","example":"deployment-1"},"password":{"type":"array","description":"Password of the account used to login to External Deployment.","example":"<password>","items":{"type":"string","description":"Password of the account used to login to External Deployment.","example":"<password>"}},"pod_url":{"pattern":"^https://[\\w.-]+(:\\d+)?$","type":"string","description":"Connection server url to access admin APIs.","example":"https://pod1.example.com:443"},"url":{"pattern":"^https://[\\w.-]+(:\\d+)?$","type":"string","description":"UAG or Load Balancer url.","example":"https://uag.example.com:443"},"username":{"type":"string","description":"Username to login to External Deployment.","example":"administrator"}},"description":"External deployment object to be added."},"ExternalDeploymentInfo":{"type":"object","properties":{"certificate":{"type":"string","description":"External deployment certificate.","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"domain":{"type":"string","description":"Domain of the account used to login to External Deployment.","example":"example.com"},"id":{"type":"string","description":"Unique identifier for external deployment.","example":"abcaaaf2-d142-11e1-b3e4-080027620cdd"},"label":{"type":"string","description":"Label for external deployment.","example":"deployment-1"},"pod_url":{"type":"string","description":"Connection server url to access admin APIs.","example":"https://pod1.example.com:443"},"url":{"type":"string","description":"UAG or Load Balancer url.","example":"https://uag.example.com:443"},"username":{"type":"string","description":"Username to login to External Deployment.","example":"administrator"}},"description":"External Deployment Information."},"ExternalDeploymentUpdateSpec":{"required":["domain","label","pod_url","url","username"],"type":"object","properties":{"certificate":{"type":"string","description":"External deployment certificate.","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"domain":{"type":"string","description":"Domain of the account used to login to External Deployment.","example":"example.com"},"label":{"type":"string","description":"Label for external deployment.","example":"deployment-1"},"password":{"type":"array","description":"Password of the account used to login to External Deployment.","example":"<password>","items":{"type":"string","description":"Password of the account used to login to External Deployment.","example":"<password>"}},"pod_url":{"pattern":"^https://[\\w.-]+(:\\d+)?$","type":"string","description":"Connection server url to access admin APIs.","example":"https://pod1.example.com:443"},"url":{"pattern":"^https://[\\w.-]+(:\\d+)?$","type":"string","description":"UAG or Load Balancer url.","example":"https://uag.example.com:443"},"username":{"type":"string","description":"Username to login to External Deployment.","example":"administrator"}},"description":"External deployment object to be updated."},"FarmAutomatedSettingsCreateSpec":{"required":["customization_settings","max_session_type","pattern_naming_settings","provisioning_settings","storage_settings","vcenter_id"],"type":"object","properties":{"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsCreateSpec"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately. Default value is true.","example":true},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"min_ready_vms":{"minimum":0,"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm. Default value is 0.","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error. Default value is true.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm. Default value is VM.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"}},"description":"Settings for Automated farm. This is required if type is set to AUTOMATED."},"FarmAutomatedSettingsCreateSpecV2":{"required":["customization_settings","max_session_type","pattern_naming_settings","provisioning_settings","storage_settings","vcenter_id"],"type":"object","properties":{"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsCreateSpecV2"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately. Default value is true.","example":true},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"min_ready_vms":{"minimum":0,"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm. Default value is 0.","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error. Default value is true.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm. Default value is VM.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"}},"description":"Settings for Automated farm."},"FarmAutomatedSettingsCreateSpecV3":{"required":["customization_settings","max_session_type","pattern_naming_settings","provisioning_settings","storage_settings","vcenter_id"],"type":"object","properties":{"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsCreateSpecV2"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately. Default value is true.","example":true},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"min_ready_vms":{"minimum":0,"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm. Default value is 0.","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsCreateSpecV2"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error. Default value is true.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm. Default value is VM.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"}},"description":"Settings for Automated farm."},"FarmAutomatedSettingsCreateSpecV4":{"required":["customization_settings","max_session_type","pattern_naming_settings","provisioning_settings","storage_settings","vcenter_id"],"type":"object","properties":{"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsCreateSpecV3"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately. Default value is true.","example":true},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"min_ready_vms":{"minimum":0,"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm. Default value is 0.","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsCreateSpecV2"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error. Default value is true.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm. Default value is VM.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"}},"description":"Applicable To: Automated farms.<br>Settings for Automated farm."},"FarmAutomatedSettingsCreateV5":{"required":["customization_settings","max_session_type","pattern_naming_settings","provisioning_settings","storage_settings","vcenter_id"],"type":"object","properties":{"customization_script_settings":{"$ref":"#/components/schemas/FarmCustomizationScriptSettingsCreateV1"},"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsCreateSpecV3"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately. Default value is true.","example":true},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by dRefault.","example":true},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"min_ready_vms":{"minimum":0,"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm. Default value is 0.","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsCreateSpecV2"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error. Default value is true.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm. Default value is VM.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"}},"description":"Applicable To: Automated farms.<br>Settings for Automated farm."},"FarmAutomatedSettingsCreateV6":{"required":["customization_settings","max_session_type","pattern_naming_settings","provisioning_settings","storage_settings","vcenter_id"],"type":"object","properties":{"aws_core_farm_settings":{"$ref":"#/components/schemas/AwsCoreFarmSettingsCreateSpec"},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider<br>Supported Filters: 'Equals'.","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"customization_script_settings":{"$ref":"#/components/schemas/FarmCustomizationScriptSettingsCreateV1"},"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsCreateSpecV3"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately. Default value is true.","example":true},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by dRefault.","example":true},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"min_ready_vms":{"minimum":0,"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm. Default value is 0.","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsCreateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsCreateSpecV2"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error. Default value is true.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm. Default value is VM.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"}},"description":"Applicable To: Automated farms.<br>Settings for Automated farm."},"FarmAutomatedSettingsInfo":{"type":"object","properties":{"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsInfo"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"image_source":{"type":"string","description":"Source of image used in the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.","format":"int32","example":50},"min_ready_vms":{"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm.\nThis property can be used for sorting.","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsInfo"}},"operating_system":{"type":"string","description":"The guest operating system.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2016","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsInfo"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsInfo"},"provisioning_status_data":{"$ref":"#/components/schemas/FarmProvisioningStatusInfo"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsInfo"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm.\nThis property can be used for sorting.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"}},"description":"Settings for Automated farm."},"FarmAutomatedSettingsInfoV2":{"type":"object","properties":{"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsInfoV2"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"image_source":{"type":"string","description":"Source of image used in the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.","format":"int32","example":50},"min_ready_vms":{"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm.\nThis property can be used for sorting.","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsInfo"}},"operating_system":{"type":"string","description":"The guest operating system.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2016","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsInfo"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsInfo"},"provisioning_status_data":{"$ref":"#/components/schemas/FarmProvisioningStatusInfo"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsInfo"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm.\nThis property can be used for sorting.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"}},"description":"Settings for Automated farm."},"FarmAutomatedSettingsInfoV3":{"type":"object","properties":{"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsInfoV2"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"image_source":{"type":"string","description":"Source of image used in the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.","format":"int32","example":50},"min_ready_vms":{"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm.\nThis property can be used for sorting.","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsInfo"}},"operating_system":{"type":"string","description":"The guest operating system.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2016","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsInfo"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsInfoV2"},"provisioning_status_data":{"$ref":"#/components/schemas/FarmProvisioningStatusInfoV2"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsInfo"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm.\nThis property can be used for sorting.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"}},"description":"Settings for Automated farm."},"FarmAutomatedSettingsInfoV4":{"type":"object","properties":{"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsInfoV3"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"image_source":{"type":"string","description":"Source of image used in the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.","format":"int32","example":50},"min_ready_vms":{"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm.\nThis property can be used for sorting.","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsInfo"}},"operating_system":{"type":"string","description":"The guest operating system.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2016","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsInfo"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsInfoV2"},"provisioning_status_data":{"$ref":"#/components/schemas/FarmProvisioningStatusInfoV2"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsInfo"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm.\nThis property can be used for sorting.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"}},"description":"Applicable To: Automated farms.<br>Settings for Automated farm."},"FarmAutomatedSettingsUpdateSpec":{"required":["customization_settings","enable_provisioning","max_session_type","min_ready_vms","pattern_naming_settings","provisioning_settings","stop_provisioning_on_error","storage_settings","transparent_page_sharing_scope"],"type":"object","properties":{"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsUpdateSpec"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately.","example":true},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"min_ready_vms":{"minimum":0,"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm. ","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsUpdateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsUpdateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]}},"description":"Settings for Automated farm. This is required if type is set to AUTOMATED."},"FarmAutomatedSettingsUpdateSpecV2":{"required":["customization_settings","enable_provisioning","max_session_type","min_ready_vms","pattern_naming_settings","provisioning_settings","stop_provisioning_on_error","storage_settings","transparent_page_sharing_scope"],"type":"object","properties":{"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsUpdateSpecV2"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately.","example":true},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"min_ready_vms":{"minimum":0,"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm. ","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsUpdateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsUpdateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]}},"description":"Settings for Automated farm."},"FarmAutomatedSettingsUpdateSpecV3":{"required":["customization_settings","enable_provisioning","max_session_type","min_ready_vms","pattern_naming_settings","provisioning_settings","stop_provisioning_on_error","storage_settings","transparent_page_sharing_scope"],"type":"object","properties":{"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsUpdateSpecV3"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately.","example":true},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"min_ready_vms":{"minimum":0,"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm. ","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsUpdateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsUpdateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]}},"description":"Applicable To: Automated farms.<br>Settings for Automated farm."},"FarmAutomatedSettingsUpdateV5":{"required":["customization_settings","enable_provisioning","max_session_type","min_ready_vms","pattern_naming_settings","provisioning_settings","stop_provisioning_on_error","storage_settings","transparent_page_sharing_scope"],"type":"object","properties":{"customization_script_settings":{"$ref":"#/components/schemas/FarmCustomizationScriptSettingsUpdateV1"},"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsUpdateSpecV3"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately.","example":true},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by dRefault.","example":true},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"minimum":1,"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","format":"int32","example":50},"min_ready_vms":{"minimum":0,"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm. ","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsUpdateSpec"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsUpdateSpec"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]}},"description":"Applicable To: Automated farms.<br>Settings for Automated farm."},"FarmAutomatedSettingsV5":{"type":"object","properties":{"customization_script_settings":{"$ref":"#/components/schemas/FarmCustomizationScriptSettingsInfoV1"},"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsInfoV3"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by dRefault.","example":true},"image_source":{"type":"string","description":"Source of image used in the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.","format":"int32","example":50},"min_ready_vms":{"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm.\nThis property can be used for sorting.","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsInfo"}},"operating_system":{"type":"string","description":"The guest operating system.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2016","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsInfo"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsV3"},"provisioning_status_data":{"$ref":"#/components/schemas/FarmProvisioningStatusV3"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsInfo"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm.\nThis property can be used for sorting.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"}},"description":"Applicable To: Automated farms.<br>Settings for Automated farm."},"FarmAutomatedSettingsV6":{"type":"object","properties":{"aws_core_farm_settings":{"$ref":"#/components/schemas/AwsCoreFarmSettingsInfoSpec"},"capacity_provider_id":{"type":"string","description":"ID of the capacity provider<br>Supported Filters: 'Equals'.","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"customization_script_settings":{"$ref":"#/components/schemas/FarmCustomizationScriptSettingsInfoV1"},"customization_settings":{"$ref":"#/components/schemas/FarmCustomizationSettingsInfoV3"},"enable_provisioning":{"type":"boolean","description":"Indicates whether to enable provisioning immediately.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by dRefault.","example":true},"image_source":{"type":"string","description":"Source of image used in the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* IMAGE_CATALOG: Image was created in image catalog.\n* VIRTUAL_CENTER: Image was created in virtual center.","example":"VIRTUAL_CENTER","enum":["IMAGE_CATALOG","VIRTUAL_CENTER"]},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.","format":"int32","example":50},"min_ready_vms":{"type":"integer","description":"Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm.\nThis property can be used for sorting.","format":"int32","example":0},"nics":{"type":"array","description":"Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.","items":{"$ref":"#/components/schemas/FarmNetworkInterfaceCardSettingsInfo"}},"operating_system":{"type":"string","description":"The guest operating system.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2016","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pattern_naming_settings":{"$ref":"#/components/schemas/FarmRDSServersPatternNamingSettingsInfo"},"provisioning_settings":{"$ref":"#/components/schemas/FarmProvisioningSettingsV3"},"provisioning_status_data":{"$ref":"#/components/schemas/FarmProvisioningStatusV4"},"stop_provisioning_on_error":{"type":"boolean","description":"Indicates whether provisioning on all VMs stops on error.\nThis property can be used for sorting.","example":true},"storage_settings":{"$ref":"#/components/schemas/FarmStorageSettingsInfo"},"transparent_page_sharing_scope":{"type":"string","description":"Transparent page sharing scope for the farm.\nThis property can be used for sorting.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* VM: Inter-VM page sharing is not permitted.","example":"VM","enum":["FARM","GLOBAL","POD","VM"]},"vcenter_id":{"type":"string","description":"ID of the virtual center server.<br>Supported Filters: 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"}},"description":"Applicable To: Automated farms.<br>Settings for Automated farm."},"FarmCancelMaintenanceSpec":{"required":["maintenance_mode"],"type":"object","properties":{"maintenance_mode":{"type":"string","description":"Scheduled maintenance mode to be cancelled.\n* IMMEDIATE: All server VMs will be refreshed once, immediately or at user scheduled time.\n* RECURRING: All server VMs will be periodically refreshed based on FarmInstantCloneRecurringMaintenancePeriod and StartTime","example":"IMMEDIATE","enum":["IMMEDIATE","RECURRING"]}},"description":"The specification to cancel the scheduled maintenance operation."},"FarmCloneprepCustomizationSettingsCreateSpec":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. ClonePrep can run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"cloneprep_postsync_script","deprecated":true},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3","deprecated":true},"power_off_script_name":{"type":"string","description":"Power off script. ClonePrep can run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"cloneprep_poweroff_script","deprecated":true},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3","deprecated":true},"priming_computer_account":{"type":"string","description":"Instant Clone publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts. This field accepts the pre-created computer accounts. This property is ignored when reuse_pre_existing_accounts is set to false.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Settings for ClonePrep customization for the farm."},"FarmCloneprepCustomizationSettingsInfo":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. ClonePrep can run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"cloneprep_postsync_script","deprecated":true},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3","deprecated":true},"power_off_script_name":{"type":"string","description":"Power off script. ClonePrep can run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"cloneprep_poweroff_script","deprecated":true},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3","deprecated":true},"priming_computer_account":{"type":"string","description":"Instant Clone publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Settings for ClonePrep customization for the farm."},"FarmCloneprepCustomizationSettingsUpdateSpec":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. ClonePrep can run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"cloneprep_postsync_script","deprecated":true},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3","deprecated":true},"power_off_script_name":{"type":"string","description":"Power off script. ClonePrep can run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"cloneprep_poweroff_script","deprecated":true},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3","deprecated":true},"priming_computer_account":{"type":"string","description":"Instant Clone publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts. This field accepts the pre-created computer accounts. This property is ignored when reuse_pre_existing_accounts is set to false.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Settings for ClonePrep customization for the farm."},"FarmCreateSpec":{"required":["access_group_id","name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsCreateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm. If the display name is left blank, it defaults to name.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsCreateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering. Default value is true.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsCreateSpec"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the farm. This property must contain only alphanumerics, underscores, and dashes.","example":"ManualFarm"},"rds_server_ids":{"uniqueItems":true,"type":"array","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":["5134796a-322g-5fe5-343f-4daa5d25ebfe","2a43f96c-102b-4ed3-953f-35deg43d43b0ge"],"items":{"type":"string","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":"[\"5134796a-322g-5fe5-343f-4daa5d25ebfe\",\"2a43f96c-102b-4ed3-953f-35deg43d43b0ge\"]"}},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. Default value is 0.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsCreateSpec"},"type":{"type":"string","description":"Type of the farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. Default value is false.","example":false}},"description":"Farm object to be created."},"FarmCreateSpecV2":{"required":["access_group_id","name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsCreateSpecV2"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm. If the display name is left blank, it defaults to name.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsCreateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering. Default value is true.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsCreateSpec"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the farm. This property must contain only alphanumerics, underscores, and dashes.","example":"ManualFarm"},"rds_server_ids":{"uniqueItems":true,"type":"array","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":["5134796a-322g-5fe5-343f-4daa5d25ebfe","2a43f96c-102b-4ed3-953f-35deg43d43b0ge"],"items":{"type":"string","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":"[\"5134796a-322g-5fe5-343f-4daa5d25ebfe\",\"2a43f96c-102b-4ed3-953f-35deg43d43b0ge\"]"}},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. Default value is 0.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsCreateSpec"},"type":{"type":"string","description":"Type of the farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. Default value is false.","example":false}},"description":"Farm object to be created."},"FarmCreateSpecV3":{"required":["access_group_id","name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsCreateSpecV3"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm. If the display name is left blank, it defaults to name.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsCreateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering. Default value is true.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsCreateSpecV2"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the farm. This property must contain only alphanumerics, underscores, and dashes.","example":"ManualFarm"},"rds_server_ids":{"uniqueItems":true,"type":"array","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":["5134796a-322g-5fe5-343f-4daa5d25ebfe","2a43f96c-102b-4ed3-953f-35deg43d43b0ge"],"items":{"type":"string","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":"[\"5134796a-322g-5fe5-343f-4daa5d25ebfe\",\"2a43f96c-102b-4ed3-953f-35deg43d43b0ge\"]"}},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. Default value is 0.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsCreateSpecV2"},"type":{"type":"string","description":"Type of the farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. Default value is false.","example":false}},"description":"Farm object to be created."},"FarmCreateSpecV4":{"required":["access_group_id","name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsCreateSpecV4"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm. If the display name is left blank, it defaults to name.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsCreateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering. Default value is true.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsCreateSpecV2"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the farm. This property must contain only alphanumerics, underscores, and dashes.","example":"ManualFarm"},"rds_server_ids":{"uniqueItems":true,"type":"array","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":["5134796a-322g-5fe5-343f-4daa5d25ebfe","2a43f96c-102b-4ed3-953f-35deg43d43b0ge"],"items":{"type":"string","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":"[\"5134796a-322g-5fe5-343f-4daa5d25ebfe\",\"2a43f96c-102b-4ed3-953f-35deg43d43b0ge\"]"}},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. Default value is 0.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsCreateSpecV2"},"type":{"type":"string","description":"Type of the farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. Default value is false.","example":false}},"description":"Farm object to be created."},"FarmCreateSpecV5":{"required":["access_group_id","name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsCreateV5"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm. If the display name is left blank, it defaults to name.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsCreateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering. Default value is true.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsCreateSpecV2"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the farm. This property must contain only alphanumerics, underscores, and dashes.","example":"ManualFarm"},"rds_server_ids":{"uniqueItems":true,"type":"array","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":["5134796a-322g-5fe5-343f-4daa5d25ebfe","2a43f96c-102b-4ed3-953f-35deg43d43b0ge"],"items":{"type":"string","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":"[\"5134796a-322g-5fe5-343f-4daa5d25ebfe\",\"2a43f96c-102b-4ed3-953f-35deg43d43b0ge\"]"}},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. Default value is 0.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsCreateSpecV2"},"type":{"type":"string","description":"Type of the farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. Default value is false.","example":false}},"description":"Farm object to be created."},"FarmCreateSpecV6":{"required":["access_group_id","name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsCreateV6"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm. If the display name is left blank, it defaults to name.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsCreateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering. Default value is true.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsCreateSpecV2"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the farm. This property must contain only alphanumerics, underscores, and dashes.","example":"ManualFarm"},"rds_server_ids":{"uniqueItems":true,"type":"array","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":["5134796a-322g-5fe5-343f-4daa5d25ebfe","2a43f96c-102b-4ed3-953f-35deg43d43b0ge"],"items":{"type":"string","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":"[\"5134796a-322g-5fe5-343f-4daa5d25ebfe\",\"2a43f96c-102b-4ed3-953f-35deg43d43b0ge\"]"}},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. Default value is 0.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsCreateSpecV2"},"source":{"type":"string","description":"Applicable To: Manual and Automated farms.<br>Source of the Machines in this farm. This is required for AWS farms.<br>\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* AWS_CORE: The Farm uses AWS core as source for provisioning the machines.\n* PRISM: The Farm uses capacity provider as source for provisioning the RDS servers.","example":"AWS_CORE","enum":["INSTANT_CLONE","LINKED_CLONE","AWS_CORE","PRISM"]},"type":{"type":"string","description":"Type of the farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. Default value is false.","example":false}},"description":"Farm object to be created."},"FarmCreateSpecV7":{"required":["access_group_id","entra_sso_enabled","name","type"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsCreateV6"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm. If the display name is left blank, it defaults to name.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsCreateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering. Default value is true.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled for the farm","example":false},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsCreateSpecV3"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Name of the farm. This property must contain only alphanumerics, underscores, and dashes.","example":"ManualFarm"},"rds_server_ids":{"uniqueItems":true,"type":"array","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":["5134796a-322g-5fe5-343f-4daa5d25ebfe","2a43f96c-102b-4ed3-953f-35deg43d43b0ge"],"items":{"type":"string","description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","example":"[\"5134796a-322g-5fe5-343f-4daa5d25ebfe\",\"2a43f96c-102b-4ed3-953f-35deg43d43b0ge\"]"}},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. Default value is 0.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsCreateSpecV2"},"source":{"type":"string","description":"Applicable To: Manual and Automated farms.<br>Source of the Machines in this farm. This is required for AWS farms.<br>\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* AWS_CORE: The Farm uses AWS core as source for provisioning the machines.\n* PRISM: The Farm uses capacity provider as source for provisioning the RDS servers.","example":"AWS_CORE","enum":["INSTANT_CLONE","LINKED_CLONE","AWS_CORE","PRISM"]},"type":{"type":"string","description":"Type of the farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. Default value is false.","example":false}},"description":"Farm object to be created."},"FarmCustomizationScriptSettingsCreateV1":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"}},"description":"Settings for customization scripts. This setting is only applicable to instant clone farms."},"FarmCustomizationScriptSettingsInfoV1":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"}},"description":"Settings for customization scripts. This setting is only applicable to instant clone farms."},"FarmCustomizationScriptSettingsUpdateV1":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","description":"Post synchronization script. Run a customization script on instant-clone machines after they are created or recovered or a new image is pushed. Provide the path to the script on the parent virtual machine.","example":"postsync_script"},"post_synchronization_script_parameters":{"type":"string","description":"Post synchronization script parameters.","example":"p1 p2 p3"},"power_off_script_name":{"type":"string","description":"Power off script. Run a customization script on instant-clone machines before they are powered off. Provide the path to the script on the parent virtual machine.","example":"poweroff_script"},"power_off_script_parameters":{"type":"string","description":"Power off script parameters.","example":"p1 p2 p3"}},"description":"Settings for customization scripts. This setting is only applicable to instant clone farms."},"FarmCustomizationSettingsCreateSpec":{"required":["instant_clone_domain_account_id"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Instant Clone Engine Active Directory container for clone prep. Default value is CN=Computers","example":"CN=Computers"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/FarmCloneprepCustomizationSettingsCreateSpec"},"instant_clone_domain_account_id":{"type":"string","description":"Instant clone domain account. This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. Default value is false.","example":false}},"description":"Customization settings for the automated farm."},"FarmCustomizationSettingsCreateSpecV2":{"required":["customization_type","instant_clone_domain_account_id"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Instant Clone Engine Active Directory container for clone prep. Default value is CN=Computers","example":"CN=Computers"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/FarmCloneprepCustomizationSettingsCreateSpec"},"customization_type":{"type":"string","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script.\n* CLONE_PREP: Applicable To: Instant clone automated Farms.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.","example":"CLONE_PREP","enum":["SYS_PREP","CLONE_PREP"]},"instant_clone_domain_account_id":{"type":"string","description":"Instant clone domain account. This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. Default value is false.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"Customization specification to use when Sysprep customization is requested. This is required if customization_type is set to SYS_PREP","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Customization settings for the automated farm."},"FarmCustomizationSettingsCreateSpecV3":{"required":["customization_type","instant_clone_domain_account_id"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Instant Clone Engine Active Directory container for clone prep. Default value is CN=Computers","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Instant Clone farms. <br>The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone farm provisioning.","example":"Default-First-Site-Name"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/FarmCloneprepCustomizationSettingsCreateSpec"},"customization_type":{"type":"string","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script.\n* CLONE_PREP: Applicable To: Instant clone automated Farms.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.","example":"CLONE_PREP","enum":["SYS_PREP","CLONE_PREP"]},"instant_clone_domain_account_id":{"type":"string","description":"Instant clone domain account. This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. Default value is false.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"Customization specification to use when Sysprep customization is requested. This is required if customization_type is set to SYS_PREP","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated farms.<br>Customization settings for the automated farm."},"FarmCustomizationSettingsInfo":{"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Instant Clone Engine Active Directory container for clone prep.\nThis property can be used for sorting.","example":"CN=Computers"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/FarmCloneprepCustomizationSettingsInfo"},"instant_clone_domain_account_id":{"type":"string","description":"Instant clone domain account. This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names.\nThis property can be used for sorting.","example":false}},"description":"Customization settings for the automated farm."},"FarmCustomizationSettingsInfoV2":{"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Instant Clone Engine Active Directory container for clone prep.\nThis property can be used for sorting.","example":"CN=Computers"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/FarmCloneprepCustomizationSettingsInfo"},"customization_type":{"type":"string","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script.\n* CLONE_PREP: Applicable To: Instant clone automated Farms.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.","example":"CLONE_PREP","enum":["SYS_PREP","CLONE_PREP"]},"instant_clone_domain_account_id":{"type":"string","description":"Instant clone domain account. This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names.\nThis property can be used for sorting.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"Customization specification used when Sysprep customization is requested. This will be set if customization_type is set to SYS_PREP ","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Customization settings for the automated farm."},"FarmCustomizationSettingsInfoV3":{"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Instant Clone Engine Active Directory container for clone prep.\nThis property can be used for sorting.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Instant Clone farms. <br>The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone farm provisioning.","example":"Default-First-Site-Name"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/FarmCloneprepCustomizationSettingsInfo"},"customization_type":{"type":"string","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script.\n* CLONE_PREP: Applicable To: Instant clone automated Farms.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.","example":"CLONE_PREP","enum":["SYS_PREP","CLONE_PREP"]},"instant_clone_domain_account_id":{"type":"string","description":"Instant clone domain account. This is the administrator which will add the machines to its domain upon creation.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names.\nThis property can be used for sorting.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"Customization specification used when Sysprep customization is requested. This will be set if customization_type is set to SYS_PREP ","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated farms.<br>Customization settings for the automated farm."},"FarmCustomizationSettingsUpdateSpec":{"required":["ad_container_rdn","cloneprep_customization_settings","reuse_pre_existing_accounts"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Instant Clone Engine Active Directory container for clone prep.","example":"CN=Computers"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/FarmCloneprepCustomizationSettingsUpdateSpec"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names.","example":false}},"description":"Customization settings for the automated farm."},"FarmCustomizationSettingsUpdateSpecV2":{"required":["ad_container_rdn","cloneprep_customization_settings","customization_type","instant_clone_domain_account_id","reuse_pre_existing_accounts"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Instant Clone Engine Active Directory container for clone prep.","example":"CN=Computers"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/FarmCloneprepCustomizationSettingsUpdateSpec"},"customization_type":{"type":"string","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script.\n* CLONE_PREP: Applicable To: Instant clone automated Farms.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.","example":"CLONE_PREP","enum":["SYS_PREP","CLONE_PREP"]},"instant_clone_domain_account_id":{"type":"string","description":"Instant clone domain account. This is the administrator which will add the machines to its domain.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"Customization specification to use when Sysprep customization is requested. This is required if customization_type is set to SYS_PREP","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Customization settings for the automated farm."},"FarmCustomizationSettingsUpdateSpecV3":{"required":["ad_container_rdn","cloneprep_customization_settings","customization_type","instant_clone_domain_account_id","reuse_pre_existing_accounts"],"type":"object","properties":{"ad_container_rdn":{"type":"string","description":"Instant Clone Engine Active Directory container for clone prep.","example":"CN=Computers"},"ad_site_name":{"maxLength":256,"minLength":0,"type":"string","description":"Applicable To: Instant Clone farms. <br>The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone farm provisioning.","example":"Default-First-Site-Name"},"cloneprep_customization_settings":{"$ref":"#/components/schemas/FarmCloneprepCustomizationSettingsUpdateSpec"},"customization_type":{"type":"string","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.<br>Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script.\n* CLONE_PREP: Applicable To: Instant clone automated Farms.<br>ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.","example":"CLONE_PREP","enum":["SYS_PREP","CLONE_PREP"]},"instant_clone_domain_account_id":{"type":"string","description":"Instant clone domain account. This is the administrator which will add the machines to its domain.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"reuse_pre_existing_accounts":{"type":"boolean","description":"Indicates whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names.","example":false},"sysprep_customization_spec_id":{"type":"string","description":"Customization specification to use when Sysprep customization is requested. This is required if customization_type is set to SYS_PREP","example":"a219420d-4799-4517-8f78-39c74c7c4efc"}},"description":"Applicable To: Automated farms.<br>Customization settings for the automated farm."},"FarmDatastoreSettingsCreateSpec":{"required":["datastore_id"],"type":"object","properties":{"datastore_id":{"type":"string","description":"Id of the datastore.","example":"datastore-1"}},"description":"Datastore settings for the automated farm."},"FarmDatastoreSettingsInfo":{"type":"object","properties":{"datastore_id":{"type":"string","description":"Id of the datastore.","example":"datastore-1"},"storage_overcommit":{"type":"string","description":"Storage overcommit determines how view places new RDS Servers on the selected datastores. With an aggressive overcommit level, view reserves less space for sparse disk growth, but fits more RDS Servers on the datastore.\n* NONE: No overcommit.\n* CONSERVATIVE: Conservative.\n* MODERATE: Moderate.\n* AGGRESSIVE: Aggressive.\n* UNBOUNDED: Unbounded.","example":"CONSERVATIVE","enum":["NONE","CONSERVATIVE","MODERATE","AGGRESSIVE","UNBOUNDED"]}},"description":"Datastore settings for the automated farm."},"FarmDatastoreSettingsUpdateSpec":{"required":["datastore_id"],"type":"object","properties":{"datastore_id":{"type":"string","description":"Id of the datastore.","example":"datastore-1"}},"description":"Datastore settings for the automated farm."},"FarmDisplayProtocolSettings":{"type":"object","properties":{"allow_display_protocol_override":{"type":"boolean","description":"Indicates whether the display protocol settings could be overridden.If set to false, then default_display_protocol is used.Default value is true.","example":true},"default_display_protocol":{"type":"string","description":"The default server display protocol. Default value is PCOIP.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"grid_vgpus_enabled":{"type":"boolean","description":"If this is true, the host or cluster associated with the farm must support NVIDIA GRID andvGPU types required by the RDSH desktop virtualMachines, VmTemplate, or BaseImageSnapshot.If this is false, RDSH instant clone farm must not support NVIDIA GRID vGPUs.Default value is false.","example":false},"html_access_enabled":{"type":"boolean","description":"This property is no longer in use for Horizon Components. It is always set to true. HTML Access, enabled by Omnissa Blast technology, allows users to connect to Horizon machines from Web browsers. Horizon Client software does not have to be installed on the client devices. To enable HTML Access, you must install the HTML Machine Access feature pack.","example":true},"session_collaboration_enabled":{"type":"boolean","description":"Enable session collaboration feature. Session collaborationallows a user to share their remote session with other users.BLAST must be configured as a supported protocol in supported_display_protocols.Default value is false.","example":false},"vgpu_grid_profile":{"type":"string","description":"NVIDIA GRID vGPUs might have multiple profiles and any one of the available profiles can beapplied to newly created instant clone RDSH server. The profile specified in this field will beused in the newly created instant clone RDSH server. Will be set if enable_grid_vgpus set to true.","example":"instant-profile"}},"description":"Display protocol settings for the Farm."},"FarmDisplayProtocolSettingsCreateSpec":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol. Default value is true. This should be false for the AWS-CORE farms.","example":true},"default_display_protocol":{"type":"string","description":"Indicates default server display protocol, when user is not allowed to choose protocol.Farms support PCOIP, RDP and BLAST. Default value is PCOIP.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"grid_vgpus_enabled":{"type":"boolean","description":"Indicates whether RDSH instant clone farm must not support NVIDIA GRID vGPUs. If this is true, the host or cluster associated with the farm must support NVIDIA GRID and vGPU types required by the RDSH desktop pool virtualMachines, VmTemplate, or BaseImageSnapshot. If this is false, RDSH instant clone farm must not support NVIDIA GRID vGPUs. This property is only applicable to instant clone farm. Default value is false.","example":true},"session_collaboration_enabled":{"type":"boolean","description":"Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users. Default value is false.","example":false}},"description":"Display protocol settings for the farm."},"FarmDisplayProtocolSettingsInfo":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"Indicates default server display protocol, when user is not allowed to choose protocol.Farms support PCOIP, RDP and BLAST.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"grid_vgpus_enabled":{"type":"boolean","description":"Indicates whether RDSH instant clone farm must not support NVIDIA GRID vGPUs. If this is true, the host or cluster associated with the farm must support NVIDIA GRID and vGPU types required by the RDSH desktop pool virtualMachines, VmTemplate, or BaseImageSnapshot. If this is false, RDSH instant clone farm must not support NVIDIA GRID vGPUs.\nThis property can be used for sorting.","example":false},"session_collaboration_enabled":{"type":"boolean","description":"Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users.\nThis property can be used for sorting.","example":false},"vgpu_grid_profile":{"type":"string","description":"NVIDIA GRID vGPUs have multiple profiles and any one of the available profiles can be applied to newly created instant clone RDSH desktop pool. The profile specified in this field will be used in the newly created instant clone RDSH server. This is set when grid_vgpus_enabled is true.\nThis property can be used for sorting.","example":"instant-profile"}},"description":"Display protocol settings for the farm."},"FarmDisplayProtocolSettingsUpdateSpec":{"required":["allow_users_to_choose_protocol","default_display_protocol","session_collaboration_enabled"],"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol.","example":true},"default_display_protocol":{"type":"string","description":"Indicates default server display protocol, when user is not allowed to choose protocol.Farms support PCOIP, RDP and BLAST.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"session_collaboration_enabled":{"type":"boolean","description":"Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users.","example":false}},"description":"Display protocol settings for the farm."},"FarmHealthMissingApplicationInfo":{"type":"object","properties":{"executable_path":{"type":"string","description":"Executable path of the Application.","example":"example/apps"},"id":{"type":"string","description":"Unique ID of the Application.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"name":{"type":"string","description":"Name of the Application.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"}},"description":"Missing application info for those application which are missing on associated app volumes manager"},"FarmInfo":{"type":"object","properties":{"description":{"type":"string","description":"Farm description. The maximum length is 1024 characters.","example":"Farm description"},"display_name":{"type":"string","description":"Display name of the Farm. The maximum length is 256 characters.","example":"Farm-display-1"},"enabled":{"type":"boolean","description":"Indicates whether the Farm is enabled for brokering. Default value is true.","example":true},"id":{"type":"string","description":"Unique ID representing Farm.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"name":{"type":"string","description":"Name of the Farm. The maximum length is 64 characters.","example":"ManualFarm1"},"settings":{"$ref":"#/components/schemas/FarmSettings"},"source":{"type":"string","description":"Type of the Farm.\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* AWS_CORE: The Farm uses AWS core as source for provisioning the machines.\n* PRISM: The Farm uses capacity provider as source for provisioning the RDS servers.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","AWS_CORE","PRISM"]},"type":{"type":"string","description":"Type of the Farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL"]}},"description":"Information related to Farm."},"FarmInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsInfo"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the farm is in the process of being deleted.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the farm. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Farm Description"},"desktop_pool_id":{"type":"string","description":"ID of RDS desktop pool associated with the farm.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"type":"string","description":"Display name of the farm. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsInfo"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing farm.<br>Supported Filters: 'Equals'.","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4"},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsInfo"},"name":{"type":"string","description":"Name of the farm. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"server_error_threshold":{"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. \nThis property can be used for sorting.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsInfo"},"type":{"type":"string","description":"Type of the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not.\nThis property can be used for sorting.","example":false}},"description":"Information related to Farm.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"FarmInfoV3":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsInfoV2"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the farm is in the process of being deleted.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the farm. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Farm Description"},"desktop_pool_id":{"type":"string","description":"ID of RDS desktop pool associated with the farm.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"type":"string","description":"Display name of the farm. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsInfo"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing farm.<br>Supported Filters: 'Equals'.","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4"},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsInfo"},"name":{"type":"string","description":"Name of the farm. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"server_error_threshold":{"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. \nThis property can be used for sorting.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsInfo"},"type":{"type":"string","description":"Type of the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not.\nThis property can be used for sorting.","example":false}},"description":"Information related to Farm.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"FarmInfoV4":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsInfoV3"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the farm is in the process of being deleted.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the farm. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Farm Description"},"desktop_pool_id":{"type":"string","description":"ID of RDS desktop pool associated with the farm.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"type":"string","description":"Display name of the farm. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsInfo"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing farm.<br>Supported Filters: 'Equals'.","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4"},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsInfoV2"},"name":{"type":"string","description":"Name of the farm. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"server_error_threshold":{"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. \nThis property can be used for sorting.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsInfoV2"},"type":{"type":"string","description":"Type of the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not.\nThis property can be used for sorting.","example":false}},"description":"Information related to Farm.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"FarmInfoV5":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"app_volumes_manager_guid":{"type":"string","description":"Associated app volumes manager id for the Farm.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsInfoV3"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the farm is in the process of being deleted.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the farm. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Farm Description"},"desktop_pool_id":{"type":"string","description":"ID of RDS desktop pool associated with the farm.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"type":"string","description":"Display name of the farm. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsInfo"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing farm.<br>Supported Filters: 'Equals'.","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4"},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsInfoV2"},"name":{"type":"string","description":"Name of the farm. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"server_error_threshold":{"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. \nThis property can be used for sorting.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsInfoV2"},"type":{"type":"string","description":"Type of the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not.\nThis property can be used for sorting.","example":false}},"description":"Information related to Farm.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"FarmInfoV6":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"app_volumes_manager_guid":{"type":"string","description":"Associated app volumes manager id for the Farm.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsInfoV4"},"delete_in_progress":{"type":"boolean","description":"Indicates whether the farm is in the process of being deleted.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the farm. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Farm Description"},"desktop_pool_id":{"type":"string","description":"ID of RDS desktop pool associated with the farm.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_name":{"type":"string","description":"Display name of the farm. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsInfo"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing farm.<br>Supported Filters: 'Equals'.","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4"},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsInfoV2"},"name":{"type":"string","description":"Name of the farm. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"server_error_threshold":{"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. \nThis property can be used for sorting.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsInfoV2"},"type":{"type":"string","description":"Type of the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not.\nThis property can be used for sorting.","example":false}},"description":"Information related to Farm.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"FarmInfoV7":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"access_group_name":{"type":"string","description":"View access group name","example":"access-group"},"app_volumes_manager_guid":{"type":"string","description":"Associated app volumes manager id for the Farm.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"application_count":{"type":"integer","description":"Count of Applications that belong to the Farm","format":"int32","example":10},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsV5"},"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the Farm was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"delete_in_progress":{"type":"boolean","description":"Indicates whether the farm is in the process of being deleted.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the farm. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Farm Description"},"desktop_pool_id":{"type":"string","description":"ID of RDS desktop pool associated with the farm.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_name":{"type":"string","description":"RDS Desktop display name","example":"test"},"display_name":{"type":"string","description":"Display name of the farm. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsInfo"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing farm.<br>Supported Filters: 'Equals'.","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4"},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsInfoV2"},"name":{"type":"string","description":"Name of the farm. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"server_error_threshold":{"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. \nThis property can be used for sorting.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsInfoV2"},"source":{"type":"string","description":"Source of the Farm.\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* AWS_CORE: The Farm uses AWS core as source for provisioning the machines.\n* PRISM: The Farm uses capacity provider as source for provisioning the RDS servers.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","AWS_CORE","PRISM"]},"type":{"type":"string","description":"Type of the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the Farm was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not.\nThis property can be used for sorting.","example":false}},"description":"Information related to Farm.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"FarmInfoV8":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"access_group_name":{"type":"string","description":"View access group name","example":"access-group"},"app_volumes_manager_guid":{"type":"string","description":"Associated app volumes manager id for the Farm.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"application_count":{"type":"integer","description":"Count of Applications that belong to the Farm","format":"int32","example":10},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsV6"},"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the Farm was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"delete_in_progress":{"type":"boolean","description":"Indicates whether the farm is in the process of being deleted.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the farm. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Farm Description"},"desktop_pool_id":{"type":"string","description":"ID of RDS desktop pool associated with the farm.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_name":{"type":"string","description":"RDS Desktop display name","example":"test"},"display_name":{"type":"string","description":"Display name of the farm. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsInfo"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing farm.<br>Supported Filters: 'Equals'.","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4"},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsInfoV2"},"max_number_of_rds_servers":{"type":"integer","description":"Maximum number of RDS Servers in the farm.\nThis property can be used for sorting.","format":"int32","example":5},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","description":"Maximum number of sessions allowed for Farm. This is set when max_session_type is LIMITED.","format":"int32","example":50},"max_sessions_per_rds_server":{"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.","format":"int32","example":50},"name":{"type":"string","description":"Name of the farm. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"server_error_threshold":{"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. \nThis property can be used for sorting.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsInfoV2"},"source":{"type":"string","description":"Source of the Machines in this Farm.\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* AWS_CORE: The Farm uses AWS core as source for provisioning the machines.\n* PRISM: The Farm uses capacity provider as source for provisioning the RDS servers.","example":"AWS_CORE","enum":["INSTANT_CLONE","LINKED_CLONE","AWS_CORE","PRISM"]},"type":{"type":"string","description":"Type of the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the Farm was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not.\nThis property can be used for sorting.","example":false}},"description":"Information related to Farm.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"FarmInfoV9":{"required":["entra_sso_enabled"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.<br>Supported Filters: 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"access_group_name":{"type":"string","description":"View access group name","example":"access-group"},"app_volumes_manager_guid":{"type":"string","description":"Associated app volumes manager id for the Farm.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"application_count":{"type":"integer","description":"Count of Applications that belong to the Farm","format":"int32","example":10},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsV6"},"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the Farm was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"delete_in_progress":{"type":"boolean","description":"Indicates whether the farm is in the process of being deleted.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"description":{"type":"string","description":"Description of the farm. The maximum length is 1024 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Farm Description"},"desktop_pool_id":{"type":"string","description":"ID of RDS desktop pool associated with the farm.<br>Supported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_name":{"type":"string","description":"RDS Desktop display name","example":"test"},"display_name":{"type":"string","description":"Display name of the farm. The maximum length is 256 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsInfo"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled for the farm","example":false},"id":{"type":"string","description":"Unique ID representing farm.<br>Supported Filters: 'Equals'.","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4"},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsInfoV3"},"max_number_of_rds_servers":{"type":"integer","description":"Maximum number of RDS Servers in the farm.\nThis property can be used for sorting.","format":"int32","example":5},"max_session_type":{"type":"string","description":"RDS Server type for max sessions.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","description":"Maximum number of sessions allowed for Farm. This is set when max_session_type is LIMITED.","format":"int32","example":50},"max_sessions_per_rds_server":{"type":"integer","description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.","format":"int32","example":50},"name":{"type":"string","description":"Name of the farm. The maximum length is 64 characters.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm"},"server_error_threshold":{"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. \nThis property can be used for sorting.","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsInfoV2"},"source":{"type":"string","description":"Source of the Machines in this Farm.\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* AWS_CORE: The Farm uses AWS core as source for provisioning the machines.\n* PRISM: The Farm uses capacity provider as source for provisioning the RDS servers.","example":"AWS_CORE","enum":["INSTANT_CLONE","LINKED_CLONE","AWS_CORE","PRISM"]},"type":{"type":"string","description":"Type of the farm.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the Farm was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not.\nThis property can be used for sorting.","example":false}},"description":"Information related to Farm.<br>List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"FarmLoadBalancerSettings":{"type":"object","properties":{"custom_script_in_use":{"type":"boolean","description":"Indicates whether to use custom scripts for Load Balancing.Default is false.","example":false},"lb_metric_settings":{"$ref":"#/components/schemas/LoadBalancerMetricSettings"}},"description":"Settings for load balancing the session requests across the RDS servers in the farm."},"FarmMaintenanceSpec":{"required":["logoff_policy","maintenance_mode"],"type":"object","properties":{"im_stream_id":{"type":"string","description":"New image management stream for the farm. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"New image management tag for the farm. This tag must be within the im_stream_id. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"logoff_policy":{"type":"string","description":"Determines when to perform the operation on RDS servers which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"maintenance_mode":{"type":"string","description":"The mode of schedule maintenance for Instant Clone Farm.\n* IMMEDIATE: All server VMs will be refreshed once, immediately or at user scheduled time.\n* RECURRING: All server VMs will be periodically refreshed based on FarmInstantCloneRecurringMaintenancePeriod and StartTime","example":"IMMEDIATE","enum":["IMMEDIATE","RECURRING"]},"next_scheduled_time":{"type":"integer","description":"Time when next scheduled maintenance would happen. If maintenance_mode is set to IMMEDIATE and next_scheduled_time is not set, maintenance will begin immediately. If maintenance_mode is set to RECURRING and next_scheduled_time is not set, it will be calculated based on current recurring maintenance configuration. If the value is in the past, maintenance will begin immediately. Measured as epoch time.","format":"int64","example":1237081283000},"parent_vm_id":{"type":"string","description":"New base image VM for the instant clone farm. This must be in the same datacenter as the base image of the farm. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.","example":"vm-2"},"recurring_maintenance_settings":{"$ref":"#/components/schemas/FarmRecurringMaintenanceSettingsSpec"},"snapshot_id":{"type":"string","description":"New base image snapshot for the instant clone farm. This must be a snapshot of the parent_vm_id. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.","example":"snapshot-1"},"stop_on_first_error":{"type":"boolean","description":"Indicates whether the operation should stop on first error. Default value is true.","example":false}},"description":"The specification to schedule maintenance."},"FarmMaintenanceSpecV2":{"required":["logoff_policy","maintenance_mode"],"type":"object","properties":{"compute_profile_num_cores_per_socket":{"minimum":1,"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones. \nIf set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set. ","format":"int32","example":1},"compute_profile_num_cpus":{"minimum":1,"type":"integer","description":"Indicates the number of CPUs in the compute profile to be configured on clones. \nIf set, this must be a multiple of compute_profile_num_cores_per_socket.","format":"int32","example":4},"compute_profile_ram_mb":{"minimum":1024,"type":"integer","description":"Indicates the RAM in MB in the compute profile to be configured on clones.","format":"int32","example":4096},"im_stream_id":{"type":"string","description":"New image management stream for the farm. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"New image management tag for the farm. This tag must be within the im_stream_id. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"logoff_policy":{"type":"string","description":"Determines when to perform the operation on RDS servers which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"maintenance_mode":{"type":"string","description":"The mode of schedule maintenance for Instant Clone Farm.\n* IMMEDIATE: All server VMs will be refreshed once, immediately or at user scheduled time.\n* RECURRING: All server VMs will be periodically refreshed based on FarmInstantCloneRecurringMaintenancePeriod and StartTime","example":"IMMEDIATE","enum":["IMMEDIATE","RECURRING"]},"next_scheduled_time":{"type":"integer","description":"Time when next scheduled maintenance would happen. If maintenance_mode is set to IMMEDIATE and next_scheduled_time is not set, maintenance will begin immediately. If maintenance_mode is set to RECURRING and next_scheduled_time is not set, it will be calculated based on current recurring maintenance configuration. If the value is in the past, maintenance will begin immediately. Measured as epoch time.","format":"int64","example":1237081283000},"parent_vm_id":{"type":"string","description":"New base image VM for the instant clone farm. This must be in the same datacenter as the base image of the farm. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.","example":"vm-2"},"rds_server_ids":{"uniqueItems":true,"type":"array","description":"Set of RDS servers from the farm on which the new image is to be applied. This can be set when selective_schedule_maintenance is set to true.","example":["816d44cb-b486-3c97-adcb-cf3806d53657","414927f3-1a3b-3e4c-81b3-d39602f634dc"],"items":{"type":"string","description":"Set of RDS servers from the farm on which the new image is to be applied. This can be set when selective_schedule_maintenance is set to true.","example":"[\"816d44cb-b486-3c97-adcb-cf3806d53657\",\"414927f3-1a3b-3e4c-81b3-d39602f634dc\"]"}},"recurring_maintenance_settings":{"$ref":"#/components/schemas/FarmRecurringMaintenanceSettingsSpec"},"selective_schedule_maintenance":{"type":"boolean","description":"Indicates whether selective scheduled maintenance is to be applied. If set to true, the new image will be applied to specified rds_server_ids in the farm. The image published with this option will be held as a pending image, unless it is promoted or cancelled. The default value is false.","example":true},"snapshot_id":{"type":"string","description":"New base image snapshot for the instant clone farm. This must be a snapshot of the parent_vm_id. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.","example":"snapshot-1"},"stop_on_first_error":{"type":"boolean","description":"Indicates whether the operation should stop on first error. Default value is true.","example":false}},"description":"The specification to schedule maintenance."},"FarmMaintenanceSpecV3":{"required":["logoff_policy","maintenance_mode"],"type":"object","properties":{"bundle_id":{"type":"string","description":"Indicates AWS core bundle ID","example":"wdy-hv3qhyzb2"},"compute_profile_num_cores_per_socket":{"minimum":1,"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones. \nIf set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set. ","format":"int32","example":1},"compute_profile_num_cpus":{"minimum":1,"type":"integer","description":"Indicates the number of CPUs in the compute profile to be configured on clones. \nIf set, this must be a multiple of compute_profile_num_cores_per_socket.","format":"int32","example":4},"compute_profile_ram_mb":{"minimum":1024,"type":"integer","description":"Indicates the RAM in MB in the compute profile to be configured on clones.","format":"int32","example":4096},"im_stream_id":{"type":"string","description":"New image management stream for the farm. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"New image management tag for the farm. This tag must be within the im_stream_id. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_id":{"type":"string","description":"Indicates AWS core image ID","example":"wsi-1ba58xt01"},"logoff_policy":{"type":"string","description":"Determines when to perform the operation on RDS servers which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"maintenance_mode":{"type":"string","description":"The mode of schedule maintenance for Instant Clone Farm.\n* IMMEDIATE: All server VMs will be refreshed once, immediately or at user scheduled time.\n* RECURRING: All server VMs will be periodically refreshed based on FarmInstantCloneRecurringMaintenancePeriod and StartTime","example":"IMMEDIATE","enum":["IMMEDIATE","RECURRING"]},"next_scheduled_time":{"type":"integer","description":"Time when next scheduled maintenance would happen. If maintenance_mode is set to IMMEDIATE and next_scheduled_time is not set, maintenance will begin immediately. If maintenance_mode is set to RECURRING and next_scheduled_time is not set, it will be calculated based on current recurring maintenance configuration. If the value is in the past, maintenance will begin immediately. Measured as epoch time.","format":"int64","example":1237081283000},"parent_vm_id":{"type":"string","description":"New base image VM for the instant clone farm. This must be in the same datacenter as the base image of the farm. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.","example":"vm-2"},"rds_server_ids":{"uniqueItems":true,"type":"array","description":"Set of RDS servers from the farm on which the new image is to be applied. This can be set when selective_schedule_maintenance is set to true.","example":["816d44cb-b486-3c97-adcb-cf3806d53657","414927f3-1a3b-3e4c-81b3-d39602f634dc"],"items":{"type":"string","description":"Set of RDS servers from the farm on which the new image is to be applied. This can be set when selective_schedule_maintenance is set to true.","example":"[\"816d44cb-b486-3c97-adcb-cf3806d53657\",\"414927f3-1a3b-3e4c-81b3-d39602f634dc\"]"}},"recurring_maintenance_settings":{"$ref":"#/components/schemas/FarmRecurringMaintenanceSettingsSpec"},"selective_schedule_maintenance":{"type":"boolean","description":"Indicates whether selective scheduled maintenance is to be applied. If set to true, the new image will be applied to specified rds_server_ids in the farm. The image published with this option will be held as a pending image, unless it is promoted or cancelled. The default value is false.","example":true},"snapshot_id":{"type":"string","description":"New base image snapshot for the instant clone farm. This must be a snapshot of the parent_vm_id. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.","example":"snapshot-1"},"stop_on_first_error":{"type":"boolean","description":"Indicates whether the operation should stop on first error. Default value is true.","example":false}},"description":"The specification to schedule maintenance."},"FarmMonitorDetails":{"type":"object","properties":{"source":{"type":"string","description":"Source of farm machines.\nThis property is required if type is set to \"AUTOMATED\".\n* LINKED_CLONE: Linked clone share the same base image and use less storage space than full RDS Servers.\n* INSTANT_CLONE: Instant clone engine uses vmfork technology to create the instant clones. These clones take much less time for provisioning.","example":"LINKED_CLONE","enum":["LINKED_CLONE","INSTANT_CLONE"]},"type":{"type":"string","description":"Farm type.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual farm.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL"]}},"description":"Details of the Farm."},"FarmMonitorInfo":{"type":"object","properties":{"application_count":{"minimum":0,"type":"integer","description":"Number of Applications published from the farm.","format":"int32","example":12},"details":{"$ref":"#/components/schemas/FarmMonitorDetails"},"id":{"type":"string","description":"Unique ID of the Farm.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"name":{"type":"string","description":"Farm name.","example":"farm1"},"rds_server_count":{"minimum":0,"type":"integer","description":"Number of RDS Servers in the farm.","format":"int32","example":123},"status":{"type":"string","description":"Status of Farm.\n* OK: Farm is enabled and no servers are in WARNING or ERROR state. One or more server(s) may be DISABLED (including the case where all of them are DISABLED).\n* WARNING: Farm is enabled. One or more of the following is true:\n1) One or more server(s) is either in WARNING or ERROR (not exceeding the predefined threshold) state.\n2) The RDS Servers in this Farm present a mix of both known and unknown load preferences.\n* ERROR: Farm is enabled. One or more server(s) (exceeding the predefined threshold) is in ERROR state, or, for Automated Farms, there could be a provisioning error.\n* DISABLED: Farm is disabled.","example":"OK","enum":["OK","WARNING","ERROR","DISABLED"]}},"description":"Monitoring information related to Farm."},"FarmMonitorInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Unique ID of the Farm.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"application_count":{"minimum":0,"type":"integer","description":"Number of Applications published from the farm.","format":"int32","example":12},"avm_accessible":{"type":"boolean","description":"Indicates if App volume manager is accessible","example":true},"details":{"$ref":"#/components/schemas/FarmMonitorDetails"},"id":{"type":"string","description":"Unique ID of the Farm.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"missing_application_infos":{"type":"array","description":"Indicates if App volume manager is accessible","example":true,"items":{"$ref":"#/components/schemas/FarmHealthMissingApplicationInfo"}},"name":{"type":"string","description":"Farm name.","example":"farm1"},"rds_server_count":{"minimum":0,"type":"integer","description":"Number of RDS Servers in the farm.","format":"int32","example":123},"status":{"type":"string","description":"Status of Farm.\n* OK: Farm is enabled and no servers are in WARNING or ERROR state. One or more server(s) may be DISABLED (including the case where all of them are DISABLED).\n* WARNING: Farm is enabled. One or more of the following is true:\n1) One or more server(s) is either in WARNING or ERROR (not exceeding the predefined threshold) state.\n2) The RDS Servers in this Farm present a mix of both known and unknown load preferences.\n* ERROR: Farm is enabled. One or more server(s) (exceeding the predefined threshold) is in ERROR state, or, for Automated Farms, there could be a provisioning error.\n* DISABLED: Farm is disabled.","example":"OK","enum":["OK","WARNING","ERROR","DISABLED"]}},"description":"Monitoring information related to Farm."},"FarmNetworkInterfaceCardSettingsCreateSpec":{"required":["network_interface_card_id"],"type":"object","properties":{"network_interface_card_id":{"type":"string","description":"ID of the network interface card for these settings.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"network_label_assignment_specs":{"type":"array","description":"Automatic network label assignment feature settings for this NIC. If network_label_assignment_specs is not set, nics will be ignored. By default, newly provisioned machines of an automated farm retain their parent image's network labels on each of their network interface cards. In certain circumstances, notably dealing with VLAN subset sizing and DHCP IP address availability, it may be desirable for the cloned VM to instead use different network labels for these newly provisioned machines. This feature allows an administrator to provide a per NIC list of network labels and their maximum availability to be automatically distributed to newly provisioned machines.<br>If this is not set, the feature is disabled.<br>Starting at the alphabetically first network label spec in the list that has not yet been assigned its maximum count for this NIC on this VM, the VM will have its next provisioned machine's NIC assigned that label. If all network labels in this list have reached their maximum count, this VM will have further provisioned machines assigned the last label in the list over capacity, and an error will be logged. Not all labels need be configured.","items":{"$ref":"#/components/schemas/FarmNetworkLabelAssignmentSettingsCreateSpec"}}},"description":"Network interface card settings for RDS Servers provisioned for the farm."},"FarmNetworkInterfaceCardSettingsInfo":{"type":"object","properties":{"network_interface_card_id":{"type":"string","description":"ID of the network interface card for these settings.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"network_interface_card_name":{"type":"string","description":"Name of the network interface card for these settings.","example":"Network adapter 1"},"network_label_assignment_specs":{"type":"array","description":"Automatic network label assignment feature settings for this NIC.","items":{"$ref":"#/components/schemas/NetworkLabelAssignmentSettingsInfo"}}},"description":"Network interface card settings for RDS Servers provisioned for the farm."},"FarmNetworkInterfaceCardSettingsUpdateSpec":{"required":["network_interface_card_id"],"type":"object","properties":{"network_interface_card_id":{"type":"string","description":"ID of the network interface card for these settings.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"network_label_assignment_specs":{"type":"array","description":"Automatic network label assignment feature settings for this NIC. If network_label_assignment_specs is not set, nics will be ignored. By default, newly provisioned machines of an automated farm retain their parent image's network labels on each of their network interface cards. In certain circumstances, notably dealing with VLAN subset sizing and DHCP IP address availability, it may be desirable for the cloned VM to instead use different network labels for these newly provisioned machines. This feature allows an administrator to provide a per NIC list of network labels and their maximum availability to be automatically distributed to newly provisioned machines.<br>If this is not set, the feature is disabled.<br>Starting at the alphabetically first network label spec in the list that has not yet been assigned its maximum count for this NIC on this VM, the VM will have its next provisioned machine's NIC assigned that label. If all network labels in this list have reached their maximum count, this VM will have further provisioned machines assigned the last label in the list over capacity, and an error will be logged. Not all labels need be configured.<br>Any changes to these settings will be applicable only to RDS servers provisioned after the change. Already provisioned RDS servers will never have their network label assignments altered by this feature.","items":{"$ref":"#/components/schemas/FarmNetworkLabelAssignmentSettingsUpdateSpec"}}},"description":"Network interface card settings for RDS Servers provisioned for the farm."},"FarmNetworkLabelAssignmentSettingsCreateSpec":{"required":["max_label_type","network_label_name"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether or not this specification is enabled. While this specification is disabled, automatic network label assignment for this automated farm will skip over the network label in this spec. Default value is true.","example":true},"max_label":{"minimum":1,"type":"integer","description":"The maximum number of times this label can be assigned to a RDS server. Note this count only encompasses this spec. That is, this label may be used for other NICs and in other farms, but those assignments will not be counted towards this total. This count also does not include assignments of this label to RDS server not under the control of View. This is required if max_label_type is set to LIMITED.","format":"int32","example":1},"max_label_type":{"type":"string","description":"This type specifies whether or not there is a maximum limit to the number of times this label may be assigned to machines within this spec. While this specification is enabled and unlimited, specs after this one in the NIC's network label specification list will never be used.\n* UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.\n* LIMITED: The network label assignment specification has a limited number of labels to assign.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","description":"The network label id for this spec. This network label must not have any incompatibility reasons that would preclude it from automatic machine assignment.","example":"vm-network"}},"description":"Network label assignment settings for the farm."},"FarmNetworkLabelAssignmentSettingsUpdateSpec":{"required":["enabled","max_label_type","network_label_name"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether or not this specification is enabled. While this specification is disabled, automatic network label assignment for this automated farm will skip over the network label in this spec.","example":true},"max_label":{"minimum":1,"type":"integer","description":"The maximum number of times this label can be assigned to a RDS server. Note this count only encompasses this spec. That is, this label may be used for other NICs and in other farms, but those assignments will not be counted towards this total. This count also does not include assignments of this label to RDS server not under the control of View. This is required if max_label_type is set to LIMITED.","format":"int32","example":1},"max_label_type":{"type":"string","description":"This type specifies whether or not there is a maximum limit to the number of times this label may be assigned to machines within this spec. While this specification is enabled and unlimited, specs after this one in the NIC's network label specification list will never be used.\n* UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.\n* LIMITED: The network label assignment specification has a limited number of labels to assign.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","description":"The network label id for this spec. This network label must not have any incompatibility reasons that would preclude it from automatic machine assignment.","example":"vm-network"}},"description":"Network label assignment settings for the farm."},"FarmProvisioningSettingsCreateSpec":{"required":["datacenter_id","host_or_cluster_id","resource_pool_id","vm_folder_id"],"type":"object","properties":{"base_snapshot_id":{"type":"string","description":"Current image snapshot for instant clone farm.","example":"snapshot-1"},"datacenter_id":{"type":"string","description":"Datacenter within which the farm is configured","example":"datacenter-1"},"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in. For Instant clone farms it can be only be a cluster id.","example":"domain-s425"},"im_stream_id":{"type":"string","description":"Image management stream used in the farm. This is required if parent_vm_id and base_snapshot_id are not set.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"Image management tag used in the farm. This is required if im_stream_id is set.","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"parent_vm_id":{"type":"string","description":"Current VM image for instant clone farm.","example":"vm-2"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the RDS Servers.","example":"resgroup-1"},"vm_folder_id":{"type":"string","description":"VM folder to deploy the RDS Servers to.","example":"group-v1"}},"description":"Virtual center provisioning settings for the farm."},"FarmProvisioningSettingsCreateSpecV2":{"required":["datacenter_id","host_or_cluster_id","resource_pool_id","vm_folder_id"],"type":"object","properties":{"base_snapshot_id":{"type":"string","description":"Current image snapshot for instant clone farm.","example":"snapshot-1"},"compute_profile_num_cores_per_socket":{"minimum":1,"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones.\nIf set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set. ","format":"int32","example":1},"compute_profile_num_cpus":{"minimum":1,"type":"integer","description":"Indicates the number of CPUs in the compute profile to be configured on clones.\nIf set, this must be a multiple of compute_profile_num_cores_per_socket.","format":"int32","example":4},"compute_profile_ram_mb":{"minimum":1024,"type":"integer","description":"Indicates the RAM in MB in the compute profile to be configured on clones.","format":"int32","example":4096},"datacenter_id":{"type":"string","description":"Datacenter within which the farm is configured","example":"datacenter-1"},"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in. For Instant clone farms it can be only be a cluster id.","example":"domain-s425"},"im_stream_id":{"type":"string","description":"Image management stream used in the farm. This is required if parent_vm_id and base_snapshot_id are not set.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"Image management tag used in the farm. This is required if im_stream_id is set.","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"parent_vm_id":{"type":"string","description":"Current VM image for instant clone farm.","example":"vm-2"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the RDS Servers.","example":"resgroup-1"},"vm_folder_id":{"type":"string","description":"VM folder to deploy the RDS Servers to.","example":"group-v1"}},"description":"Virtual center provisioning settings for the farm."},"FarmProvisioningSettingsInfo":{"type":"object","properties":{"base_snapshot_id":{"type":"string","description":"Current image snapshot for instant clone farm.","example":"snapshot-1"},"datacenter_id":{"type":"string","description":"Datacenter within which the farm is configured","example":"datacenter-1"},"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in.","example":"domain-s425"},"im_stream_id":{"type":"string","description":"Image management stream used in the farm.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"Image management tag used in the farm.<br>Supported Filters: 'Equals'.","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"parent_vm_id":{"type":"string","description":"Current VM image for instant clone farm.","example":"vm-2"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the RDS Servers.","example":"resgroup-1"},"vm_folder_id":{"type":"string","description":"VM folder to deploy the RDS Servers to.","example":"group-v1"}},"description":"Virtual center provisioning settings for the farm."},"FarmProvisioningSettingsInfoV2":{"type":"object","properties":{"base_snapshot_id":{"type":"string","description":"Current image snapshot for instant clone farm.","example":"snapshot-1"},"compute_profile_num_cores_per_socket":{"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile configured on clones.","format":"int32","example":1},"compute_profile_num_cpus":{"type":"integer","description":"Indicates the number of CPUs in the compute profile configured on clones.","format":"int32","example":4},"compute_profile_ram_mb":{"type":"integer","description":"Indicates the RAM in MB in the compute profile configured on clones.","format":"int32","example":4096},"datacenter_id":{"type":"string","description":"Datacenter within which the farm is configured","example":"datacenter-1"},"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in.","example":"domain-s425"},"im_stream_id":{"type":"string","description":"Image management stream used in the farm.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"Image management tag used in the farm.<br>Supported Filters: 'Equals'.","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"parent_vm_id":{"type":"string","description":"Current VM image for instant clone farm.","example":"vm-2"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the RDS Servers.","example":"resgroup-1"},"vm_folder_id":{"type":"string","description":"VM folder to deploy the RDS Servers to.","example":"group-v1"}},"description":"Virtual center provisioning settings for the farm."},"FarmProvisioningSettingsUpdateSpec":{"required":["host_or_cluster_id","resource_pool_id"],"type":"object","properties":{"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in. For Instant clone farms it can be only be a cluster id. This can be modified only if there are no current operations ( operation is NONE).","example":"domain-s425"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the RDS Servers.","example":"resgroup-1"}},"description":"Virtual center provisioning settings for the farm."},"FarmProvisioningSettingsV3":{"type":"object","properties":{"base_snapshot_id":{"type":"string","description":"Current image snapshot for instant clone farm.","example":"snapshot-1"},"compute_profile_num_cores_per_socket":{"type":"integer","description":"Indicates the number of cores per socket for the CPU in the compute profile configured on clones.","format":"int32","example":1},"compute_profile_num_cpus":{"type":"integer","description":"Indicates the number of CPUs in the compute profile configured on clones.","format":"int32","example":4},"compute_profile_ram_mb":{"type":"integer","description":"Indicates the RAM in MB in the compute profile configured on clones.","format":"int32","example":4096},"customization_spec_name":{"type":"string","description":"Name of the customization spec.","example":"cust-spec-name"},"datacenter_id":{"type":"string","description":"Datacenter within which the farm is configured","example":"datacenter-1"},"datacenter_name":{"type":"string","description":"Name of the data center of the RDS Servers","example":"dataCenterName-1"},"host_or_cluster_id":{"type":"string","description":"Host or cluster where the machines are deployed in.","example":"domain-s425"},"host_or_cluster_path":{"type":"string","description":"Host or cluster path to deploy the RDS Servers in. The name is the last element of the path.","example":"/host/cluster/path-1/"},"im_stream_id":{"type":"string","description":"Image management stream used in the farm.<br>Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_tag_id":{"type":"string","description":"Image management tag used in the farm.<br>Supported Filters: 'Equals'.","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_stream_name":{"type":"string","description":"Name of image management stream used in instant clone farm when created from image catalog.","example":"stream-name"},"image_management_tag_name":{"type":"string","description":"Name of image management tag used in instant clone farm when created from image catalog.","example":"tag-name"},"parent_vm_id":{"type":"string","description":"Current VM image for instant clone farm.","example":"vm-2"},"parent_vm_path":{"type":"string","description":"Base image path for RDS Servers. The name is the last element of the path.","example":"/path"},"resource_pool_id":{"type":"string","description":"Resource pool to deploy the RDS Servers.","example":"resgroup-1"},"resource_pool_path":{"type":"string","description":"Resource pool path to deploy the RDS Servers. The name is the last element of the path","example":"/resource-pool/"},"snapshot_path":{"type":"string","description":"Base image snapshot path for RDS Servers.","example":"snapshotPath-1"},"vm_folder_id":{"type":"string","description":"VM folder to deploy the RDS Servers to.","example":"group-v1"},"vm_folder_path":{"type":"string","description":"VM folder path to deploy the RDS Servers to. The name is the last element of the path.","example":"/vm-folder"}},"description":"Virtual center entities used for provisioning."},"FarmProvisioningStatusInfo":{"type":"object","properties":{"instant_clone_current_image_state":{"type":"string","description":"This represents the state of the current image of this instant clone farms.\nThis property can be used for sorting.\n* FAILED: This is the state of the current image if instant clone delete operation has failed or timed out.\n* PENDING_UNPUBLISH: This is the state of the current image before instant clone delete or cluster edit or datastore(s) edit operation(s) begins.\n* READY: This is the state of the current image after successful completion of creation operation. At this stage the current image is ready to be used to create the instant clones. Please note that this state is also reached from UNPUBLISHING state on successful completion of editing of cluster or editing of datastore(s) operations.\n* UNPUBLISHING: This is the transient state of the current image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"READY","enum":["FAILED","PENDING_UNPUBLISH","READY","UNPUBLISHING"]},"instant_clone_operation":{"type":"string","description":"The operation that this instant clone farm is undergoing.\n* NONE: There is no current operation on the farm.\n* INITIAL_PUBLISH: The farm has just been created and is undergoing initial publishing.\n* RECURRING_SCHEDULED_MAINTENANCE: Recurring maintenance operation is scheduled on the farm.\n* CANCEL_SCHEDULED_MAINTENANCE: The recurring maintenance operation on the farm is being cancelled.\n* INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the farm.\n* FINAL_UNPUBLISH: A farm has been deleted and is undergoing final unpublishing.","example":"INITIAL_PUBLISH","enum":["NONE","INITIAL_PUBLISH","RECURRING_SCHEDULED_MAINTENANCE","CANCEL_SCHEDULED_MAINTENANCE","INFRASTRUCTURE_CHANGE","FINAL_UNPUBLISH"]},"instant_clone_operation_time":{"type":"integer","description":"Time of the operation that instant clone farm is undergoing.","format":"int64","example":1587081283000},"instant_clone_pending_im_stream_id":{"type":"string","description":"Pending image management stream for instant clone farms.<br>Supported Filters: 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"instant_clone_pending_im_tag_id":{"type":"string","description":"Pending image management tag for instant clone farms.<br>Supported Filters: 'Equals'.","example":"e9896e51-48a2-4d82-ae9e-a0246981b484"},"instant_clone_pending_image_error":{"type":"string","description":"This represents the error message if publishing of push image operation is failed.","example":"Could not authenticate with domain administrator credentials"},"instant_clone_pending_image_parent_vm_id":{"type":"string","description":"Pending base image VM for instant clone farms. This is used to return the information about the parent VM of the pending Image.","example":"vm-1"},"instant_clone_pending_image_progress":{"type":"integer","description":"This represents the pending image publish progress in percentage for an instant clone farm.\nThis property can be used for sorting.","format":"int32","example":10},"instant_clone_pending_image_snapshot_id":{"type":"string","description":"Pending base image snapshot for instant clone farms. This is used to return the information about the snapshot of the pending image.","example":"snapshot-1"},"instant_clone_pending_image_state":{"type":"string","description":"This represents the state of the pending image of this instant clone farms. This will be null when there is no pending image for the farm.\nThis property can be used for sorting.\n* FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.\n* PENDING_PUBLISH: This is the initial transient state of the pending image before instant clone creation operation has started.\n* PUBLISHING: This is the transient state of the pending image when creation of instant clone operation is going on.\n* READY: This is the state of the pending image after successful publish of the pending image and before that image has been upgraded to the current image. This is normally seen after successful publish for a push image which has been scheduled to trigger at a later time.\n* READY_HELD: This is the state of the pending image after performing a selective resync operation, in which the image may be applied to some VMs in the desktop pool/farm.\n* UNPUBLISHING: This is the transient state of the pending image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"FAILED","enum":["FAILED","PENDING_PUBLISH","PUBLISHING","READY","READY_HELD","UNPUBLISHING"]},"instant_clone_scheduled_maintenance_data":{"$ref":"#/components/schemas/FarmScheduledMaintenanceInfo"},"last_provisioning_error":{"type":"string","description":"String message detailing the last provisioning error on this farm while stop_provisioning_on_error is enabled.","example":"Initial publish failed: Could not authenticate with domain administrator credentials"},"last_provisioning_error_time":{"type":"integer","description":"Time the last provisioning error occurred on this farm while stop_provisioning_on_error is enabled. Measured as epoch time.","format":"int64","example":1587081283000}},"description":"Provisioning status data about this automated farm."},"FarmProvisioningStatusInfoV2":{"type":"object","properties":{"instant_clone_current_image_state":{"type":"string","description":"This represents the state of the current image of this instant clone farms.\nThis property can be used for sorting.\n* FAILED: This is the state of the current image if instant clone delete operation has failed or timed out.\n* PENDING_UNPUBLISH: This is the state of the current image before instant clone delete or cluster edit or datastore(s) edit operation(s) begins.\n* READY: This is the state of the current image after successful completion of creation operation. At this stage the current image is ready to be used to create the instant clones. Please note that this state is also reached from UNPUBLISHING state on successful completion of editing of cluster or editing of datastore(s) operations.\n* UNPUBLISHING: This is the transient state of the current image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"READY","enum":["FAILED","PENDING_UNPUBLISH","READY","UNPUBLISHING"]},"instant_clone_operation":{"type":"string","description":"The operation that this instant clone farm is undergoing.\n* NONE: There is no current operation on the farm.\n* INITIAL_PUBLISH: The farm has just been created and is undergoing initial publishing.\n* RECURRING_SCHEDULED_MAINTENANCE: Recurring maintenance operation is scheduled on the farm.\n* CANCEL_SCHEDULED_MAINTENANCE: The recurring maintenance operation on the farm is being cancelled.\n* INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the farm.\n* FINAL_UNPUBLISH: A farm has been deleted and is undergoing final unpublishing.","example":"INITIAL_PUBLISH","enum":["NONE","INITIAL_PUBLISH","RECURRING_SCHEDULED_MAINTENANCE","CANCEL_SCHEDULED_MAINTENANCE","INFRASTRUCTURE_CHANGE","FINAL_UNPUBLISH"]},"instant_clone_operation_time":{"type":"integer","description":"Time of the operation that instant clone farm is undergoing.","format":"int64","example":1587081283000},"instant_clone_pending_im_stream_id":{"type":"string","description":"Pending image management stream for instant clone farms.<br>Supported Filters: 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"instant_clone_pending_im_tag_id":{"type":"string","description":"Pending image management tag for instant clone farms.<br>Supported Filters: 'Equals'.","example":"e9896e51-48a2-4d82-ae9e-a0246981b484"},"instant_clone_pending_image_error":{"type":"string","description":"This represents the error message if publishing of push image operation is failed.","example":"Could not authenticate with domain administrator credentials"},"instant_clone_pending_image_parent_vm_id":{"type":"string","description":"Pending base image VM for instant clone farms. This is used to return the information about the parent VM of the pending Image.","example":"vm-1"},"instant_clone_pending_image_progress":{"type":"integer","description":"This represents the pending image publish progress in percentage for an instant clone farm.\nThis property can be used for sorting.","format":"int32","example":10},"instant_clone_pending_image_snapshot_id":{"type":"string","description":"Pending base image snapshot for instant clone farms. This is used to return the information about the snapshot of the pending image.","example":"snapshot-1"},"instant_clone_pending_image_state":{"type":"string","description":"This represents the state of the pending image of this instant clone farms. This will be null when there is no pending image for the farm.\nThis property can be used for sorting.\n* FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.\n* PENDING_PUBLISH: This is the initial transient state of the pending image before instant clone creation operation has started.\n* PUBLISHING: This is the transient state of the pending image when creation of instant clone operation is going on.\n* READY: This is the state of the pending image after successful publish of the pending image and before that image has been upgraded to the current image. This is normally seen after successful publish for a push image which has been scheduled to trigger at a later time.\n* READY_HELD: This is the state of the pending image after performing a selective resync operation, in which the image may be applied to some VMs in the desktop pool/farm.\n* UNPUBLISHING: This is the transient state of the pending image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"FAILED","enum":["FAILED","PENDING_PUBLISH","PUBLISHING","READY","READY_HELD","UNPUBLISHING"]},"instant_clone_scheduled_maintenance_data":{"$ref":"#/components/schemas/FarmScheduledMaintenanceInfo"},"last_provisioning_error":{"type":"string","description":"String message detailing the last provisioning error on this farm while stop_provisioning_on_error is enabled.","example":"Initial publish failed: Could not authenticate with domain administrator credentials"},"last_provisioning_error_time":{"type":"integer","description":"Time the last provisioning error occurred on this farm while stop_provisioning_on_error is enabled. Measured as epoch time.","format":"int64","example":1587081283000},"pending_compute_profile_num_cores_per_socket":{"type":"integer","description":"Indicates the pending number of cores per socket for the CPU in the compute profile configured on clones.","format":"int32","example":1},"pending_compute_profile_num_cpus":{"type":"integer","description":"Indicates the pending number of CPUs in the compute profile configured on clones.","format":"int32","example":4},"pending_compute_profile_ram_mb":{"type":"integer","description":"Indicates the pending RAM in MB in the compute profile configured on clones.","format":"int32","example":4096}},"description":"Provisioning status data about this automated farm."},"FarmProvisioningStatusV3":{"type":"object","properties":{"instant_clone_current_image_state":{"type":"string","description":"This represents the state of the current image of this instant clone farms.\nThis property can be used for sorting.\n* FAILED: This is the state of the current image if instant clone delete operation has failed or timed out.\n* PENDING_UNPUBLISH: This is the state of the current image before instant clone delete or cluster edit or datastore(s) edit operation(s) begins.\n* READY: This is the state of the current image after successful completion of creation operation. At this stage the current image is ready to be used to create the instant clones. Please note that this state is also reached from UNPUBLISHING state on successful completion of editing of cluster or editing of datastore(s) operations.\n* UNPUBLISHING: This is the transient state of the current image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"READY","enum":["FAILED","PENDING_UNPUBLISH","READY","UNPUBLISHING"]},"instant_clone_operation":{"type":"string","description":"The operation that this instant clone farm is undergoing.\n* NONE: There is no current operation on the farm.\n* INITIAL_PUBLISH: The farm has just been created and is undergoing initial publishing.\n* RECURRING_SCHEDULED_MAINTENANCE: Recurring maintenance operation is scheduled on the farm.\n* CANCEL_SCHEDULED_MAINTENANCE: The recurring maintenance operation on the farm is being cancelled.\n* INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the farm.\n* FINAL_UNPUBLISH: A farm has been deleted and is undergoing final unpublishing.","example":"INITIAL_PUBLISH","enum":["NONE","INITIAL_PUBLISH","RECURRING_SCHEDULED_MAINTENANCE","CANCEL_SCHEDULED_MAINTENANCE","INFRASTRUCTURE_CHANGE","FINAL_UNPUBLISH"]},"instant_clone_operation_time":{"type":"integer","description":"Time of the operation that instant clone farm is undergoing.","format":"int64","example":1587081283000},"instant_clone_pending_im_stream_id":{"type":"string","description":"Pending image management stream for instant clone farms.<br>Supported Filters: 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"instant_clone_pending_im_tag_id":{"type":"string","description":"Pending image management tag for instant clone farms.<br>Supported Filters: 'Equals'.","example":"e9896e51-48a2-4d82-ae9e-a0246981b484"},"instant_clone_pending_image_error":{"type":"string","description":"This represents the error message if publishing of push image operation is failed.","example":"Could not authenticate with domain administrator credentials"},"instant_clone_pending_image_parent_vm_id":{"type":"string","description":"Pending base image VM for instant clone farms. This is used to return the information about the parent VM of the pending Image.","example":"vm-1"},"instant_clone_pending_image_progress":{"type":"integer","description":"This represents the pending image publish progress in percentage for an instant clone farm.\nThis property can be used for sorting.","format":"int32","example":10},"instant_clone_pending_image_snapshot_id":{"type":"string","description":"Pending base image snapshot for instant clone farms. This is used to return the information about the snapshot of the pending image.","example":"snapshot-1"},"instant_clone_pending_image_state":{"type":"string","description":"This represents the state of the pending image of this instant clone farms. This will be null when there is no pending image for the farm.\nThis property can be used for sorting.\n* FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.\n* PENDING_PUBLISH: This is the initial transient state of the pending image before instant clone creation operation has started.\n* PUBLISHING: This is the transient state of the pending image when creation of instant clone operation is going on.\n* READY: This is the state of the pending image after successful publish of the pending image and before that image has been upgraded to the current image. This is normally seen after successful publish for a push image which has been scheduled to trigger at a later time.\n* READY_HELD: This is the state of the pending image after performing a selective resync operation, in which the image may be applied to some VMs in the desktop pool/farm.\n* UNPUBLISHING: This is the transient state of the pending image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"FAILED","enum":["FAILED","PENDING_PUBLISH","PUBLISHING","READY","READY_HELD","UNPUBLISHING"]},"instant_clone_scheduled_maintenance_data":{"$ref":"#/components/schemas/FarmScheduledMaintenanceInfo"},"last_provisioning_error":{"type":"string","description":"String message detailing the last provisioning error on this farm while stop_provisioning_on_error is enabled.","example":"Initial publish failed: Could not authenticate with domain administrator credentials"},"last_provisioning_error_time":{"type":"integer","description":"Time the last provisioning error occurred on this farm while stop_provisioning_on_error is enabled. Measured as epoch time.","format":"int64","example":1587081283000},"pending_compute_profile_num_cores_per_socket":{"type":"integer","description":"Indicates the pending number of cores per socket for the CPU in the compute profile configured on clones.","format":"int32","example":1},"pending_compute_profile_num_cpus":{"type":"integer","description":"Indicates the pending number of CPUs in the compute profile configured on clones.","format":"int32","example":4},"pending_compute_profile_ram_mb":{"type":"integer","description":"Indicates the pending RAM in MB in the compute profile configured on clones.","format":"int32","example":4096},"pending_image_management_stream_name":{"type":"string","description":"Pending image stream name","example":"test"},"pending_image_management_tag_name":{"type":"string","description":"Pending image management tag for Instant clone farms.","example":"tag-1"},"pending_image_parent_vm_path":{"type":"string","description":"Pending image's parent vm path.This property is required if operation is set to INITIAL_PUBLISH or CANCEL_SCHEDULED_MAINTENANCE or INFRASTRUCTURE_CHANGE","example":"/datastore/pending-imgs/vm-1"},"pending_image_snapshot_path":{"type":"string","description":"Pending image snap shot path. This property is required if operation is set to INITIAL_PUBLISH or CANCEL_SCHEDULED_MAINTENANCE or INFRASTRUCTURE_CHANGE","example":"/datastore/snap-shots/snapshot-1"}},"description":"Provisioning status data about this automated farm."},"FarmProvisioningStatusV4":{"type":"object","properties":{"instant_clone_current_image_state":{"type":"string","description":"This represents the state of the current image of this instant clone farms.\nThis property can be used for sorting.\n* FAILED: This is the state of the current image if instant clone delete operation has failed or timed out.\n* PENDING_UNPUBLISH: This is the state of the current image before instant clone delete or cluster edit or datastore(s) edit operation(s) begins.\n* READY: This is the state of the current image after successful completion of creation operation. At this stage the current image is ready to be used to create the instant clones. Please note that this state is also reached from UNPUBLISHING state on successful completion of editing of cluster or editing of datastore(s) operations.\n* UNPUBLISHING: This is the transient state of the current image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"READY","enum":["FAILED","PENDING_UNPUBLISH","READY","UNPUBLISHING"]},"instant_clone_operation":{"type":"string","description":"The operation that this instant clone farm is undergoing.\n* NONE: There is no current operation on the farm.\n* INITIAL_PUBLISH: The farm has just been created and is undergoing initial publishing.\n* RECURRING_SCHEDULED_MAINTENANCE: Recurring maintenance operation is scheduled on the farm.\n* CANCEL_SCHEDULED_MAINTENANCE: The recurring maintenance operation on the farm is being cancelled.\n* INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the farm.\n* FINAL_UNPUBLISH: A farm has been deleted and is undergoing final unpublishing.","example":"INITIAL_PUBLISH","enum":["NONE","INITIAL_PUBLISH","RECURRING_SCHEDULED_MAINTENANCE","CANCEL_SCHEDULED_MAINTENANCE","INFRASTRUCTURE_CHANGE","FINAL_UNPUBLISH"]},"instant_clone_operation_time":{"type":"integer","description":"Time of the operation that instant clone farm is undergoing.","format":"int64","example":1587081283000},"instant_clone_pending_im_stream_id":{"type":"string","description":"Pending image management stream for instant clone farms.<br>Supported Filters: 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"instant_clone_pending_im_tag_id":{"type":"string","description":"Pending image management tag for instant clone farms.<br>Supported Filters: 'Equals'.","example":"e9896e51-48a2-4d82-ae9e-a0246981b484"},"instant_clone_pending_image_error":{"type":"string","description":"This represents the error message if publishing of push image operation is failed.","example":"Could not authenticate with domain administrator credentials"},"instant_clone_pending_image_parent_vm_id":{"type":"string","description":"Pending base image VM for instant clone farms. This is used to return the information about the parent VM of the pending Image.","example":"vm-1"},"instant_clone_pending_image_progress":{"type":"integer","description":"This represents the pending image publish progress in percentage for an instant clone farm.\nThis property can be used for sorting.","format":"int32","example":10},"instant_clone_pending_image_snapshot_id":{"type":"string","description":"Pending base image snapshot for instant clone farms. This is used to return the information about the snapshot of the pending image.","example":"snapshot-1"},"instant_clone_pending_image_state":{"type":"string","description":"This represents the state of the pending image of this instant clone farms. This will be null when there is no pending image for the farm.\nThis property can be used for sorting.\n* FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.\n* PENDING_PUBLISH: This is the initial transient state of the pending image before instant clone creation operation has started.\n* PUBLISHING: This is the transient state of the pending image when creation of instant clone operation is going on.\n* READY: This is the state of the pending image after successful publish of the pending image and before that image has been upgraded to the current image. This is normally seen after successful publish for a push image which has been scheduled to trigger at a later time.\n* READY_HELD: This is the state of the pending image after performing a selective resync operation, in which the image may be applied to some VMs in the desktop pool/farm.\n* UNPUBLISHING: This is the transient state of the pending image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"FAILED","enum":["FAILED","PENDING_PUBLISH","PUBLISHING","READY","READY_HELD","UNPUBLISHING"]},"instant_clone_scheduled_maintenance_data":{"$ref":"#/components/schemas/FarmScheduledMaintenanceInfo"},"last_provisioning_error":{"type":"string","description":"String message detailing the last provisioning error on this farm while stop_provisioning_on_error is enabled.","example":"Initial publish failed: Could not authenticate with domain administrator credentials"},"last_provisioning_error_time":{"type":"integer","description":"Time the last provisioning error occurred on this farm while stop_provisioning_on_error is enabled. Measured as epoch time.","format":"int64","example":1587081283000},"pending_compute_profile_num_cores_per_socket":{"type":"integer","description":"Indicates the pending number of cores per socket for the CPU in the compute profile configured on clones.","format":"int32","example":1},"pending_compute_profile_num_cpus":{"type":"integer","description":"Indicates the pending number of CPUs in the compute profile configured on clones.","format":"int32","example":4},"pending_compute_profile_ram_mb":{"type":"integer","description":"Indicates the pending RAM in MB in the compute profile configured on clones.","format":"int32","example":4096},"pending_image_management_stream_name":{"type":"string","description":"Pending image stream name","example":"test"},"pending_image_management_tag_name":{"type":"string","description":"Pending image management tag for Instant clone farms.","example":"tag-1"},"pending_image_parent_vm_path":{"type":"string","description":"Pending image's parent vm path.This property is required if operation is set to INITIAL_PUBLISH or CANCEL_SCHEDULED_MAINTENANCE or INFRASTRUCTURE_CHANGE","example":"/datastore/pending-imgs/vm-1"},"pending_image_snapshot_path":{"type":"string","description":"Pending image snap shot path. This property is required if operation is set to INITIAL_PUBLISH or CANCEL_SCHEDULED_MAINTENANCE or INFRASTRUCTURE_CHANGE","example":"/datastore/snap-shots/snapshot-1"},"push_image_settings":{"$ref":"#/components/schemas/PushImageSettings"}},"description":"Provisioning status data about this automated farm."},"FarmRDSServersPatternNamingSettingsCreateSpec":{"required":["naming_pattern"],"type":"object","properties":{"max_number_of_rds_servers":{"minimum":1,"type":"integer","description":"Maximum number of RDS Servers in the farm. Default value is 1.","format":"int32","example":5},"naming_pattern":{"type":"string","description":"RDS Servers will be named according to the specified naming pattern. By default, Horizon appends a unique number to the specified pattern to provide a unique name for each RDS Server. To place this unique number elsewhere in the pattern, use '{n}'. (For example: rds-{n}-sales.) The unique number can also be made a fixed length. (For example: rds-{n:fixed=3}-sales will name RDS Servers from rds-001-sales to rds-999-sales).<br>RDS Server names are constrained to a maximum size of 15 characters including the unique number. Therefore, care must be taken when choosing a pattern. If the maximum farm size is 9 RDS servers, the pattern must be at most 14 characters. For 99 RDS servers, 13 characters, for 999 RDS servers, 12 characters. For 9999 RDS servers, 11 characters. If using a fixed size token, use a maximum of 14 characters for \"n=1\", 13 characters for \"n=2\", 12 characters for \"n=3\", and 11 characters for \"n=4\". If {n} is specified with no size, a size of 2 is automatically used and if no {} is specified, {n=2} is automatically appended to the end of the pattern.<br>This property must contain only alphanumerics and dashes. It must contain at least one alpha character. It may also optionally contain a numeric placement token {n} or {n:fixed=#}. If the pattern does not specify the numeric placement token, the maximum length is 14 characters.","example":"vm-{n}-sales"}},"description":"RDS server naming Pattern settings for the farm."},"FarmRDSServersPatternNamingSettingsInfo":{"type":"object","properties":{"max_number_of_rds_servers":{"type":"integer","description":"Maximum number of RDS Servers in the farm.\nThis property can be used for sorting.","format":"int32","example":5},"naming_pattern":{"type":"string","description":"RDS Servers will be named according to the specified naming pattern. By default, Horizon appends a unique number to the specified pattern to provide a unique name for each RDS Server. To place this unique number elsewhere in the pattern, use '{n}'. (For example: rds-{n}-sales.) The unique number can also be made a fixed length. (For example: rds-{n:fixed=3}-sales will name RDS Servers from rds-001-sales to rds-999-sales).\nRDS Server names are constrained to a maximum size of 15 characters including the unique number. Therefore, care must be taken when choosing a pattern. If the maximum farm size is 9 RDS servers, the pattern must be at most 14 characters. For 99 RDS servers, 13 characters, for 999 RDS servers, 12 characters. For 9999 RDS servers, 11 characters. If using a fixed size token, use a maximum of 14 characters for \"n=1\", 13 characters for \"n=2\", 12 characters for \"n=3\", and 11 characters for \"n=4\". If {n} is specified with no size, a size of 2 is automatically used and if no {} is specified, {n=2} is automatically appended to the end of the pattern. If the numeric placement token not present, then maximum length is 14 characters.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":"vm-{n}-sales"}},"description":"RDS server naming Pattern settings for the farm."},"FarmRDSServersPatternNamingSettingsUpdateSpec":{"required":["max_number_of_rds_servers","naming_pattern"],"type":"object","properties":{"max_number_of_rds_servers":{"minimum":1,"type":"integer","description":"Maximum number of RDS Servers in the farm.","format":"int32","example":5},"naming_pattern":{"type":"string","description":"RDS Servers will be named according to the specified naming pattern. By default, Horizon appends a unique number to the specified pattern to provide a unique name for each RDS Server. To place this unique number elsewhere in the pattern, use '{n}'. (For example: rds-{n}-sales.) The unique number can also be made a fixed length. (For example: rds-{n:fixed=3}-sales will name RDS Servers from rds-001-sales to rds-999-sales).<br>RDS Server names are constrained to a maximum size of 15 characters including the unique number. Therefore, care must be taken when choosing a pattern. If the maximum farm size is 9 RDS servers, the pattern must be at most 14 characters. For 99 RDS servers, 13 characters, for 999 RDS servers, 12 characters. For 9999 RDS servers, 11 characters. If using a fixed size token, use a maximum of 14 characters for \"n=1\", 13 characters for \"n=2\", 12 characters for \"n=3\", and 11 characters for \"n=4\". If {n} is specified with no size, a size of 2 is automatically used and if no {} is specified, {n=2} is automatically appended to the end of the pattern.<br>This property must contain only alphanumerics and dashes. It must contain at least one alpha character. It may also optionally contain a numeric placement token {n} or {n:fixed=#}. If the pattern does not specify the numeric placement token, the maximum length is 14 characters.","example":"vm-{n}-sales"}},"description":"RDS server naming Pattern settings for the farm."},"FarmRecurringMaintenanceSettingsInfo":{"type":"object","properties":{"maintenance_period":{"type":"string","description":"Settings for recurring maintenance operations.\n* DAILY: Daily recurring maintenance\n* WEEKLY: Weekly recurring maintenance\n* MONTHLY: Monthly recurring maintenance","example":"WEEKLY","enum":["DAILY","WEEKLY","MONTHLY"]},"maintenance_period_frequency":{"type":"integer","description":"Indicates frequency of repeating maintenance and is expressed as a multiple of the maintenance_period. ","format":"int32","example":10},"start_index":{"type":"integer","description":"Start index for weekly or monthly maintenance. Weekly: 1-7 (Sun-Sat), Monthly: 1-31. This is set when maintenance_period is WEEKLY or MONTHLY.","format":"int32","example":1},"start_time":{"type":"string","description":"Start time configured for the recurring maintenance. This is in the form hh:mm in 24 hours format","example":"10:00"}},"description":"Settings for recurring maintenance operation for the farm."},"FarmRecurringMaintenanceSettingsSpec":{"required":["maintenance_period","start_time"],"type":"object","properties":{"maintenance_period":{"type":"string","description":"This represents the frequency at which to perform recurring maintenance.\n* DAILY: Daily recurring maintenance\n* WEEKLY: Weekly recurring maintenance\n* MONTHLY: Monthly recurring maintenance","example":"MONTHLY","enum":["DAILY","WEEKLY","MONTHLY"]},"maintenance_period_frequency":{"maximum":100,"minimum":1,"type":"integer","description":"Indicates how frequently to repeat maintenance, expressed as multiple of the maintenance period. e.g. Every 2 weeks. Default value is 1.","format":"int32","example":10},"start_index":{"maximum":31,"minimum":1,"type":"integer","description":"Start index for weekly or monthly maintenance.This required if maintenance_period is set to either WEEKLY or MONTHLY. Weekly: 1-7 (Sun-Sat), Monthly: 1-31","format":"int32","example":2},"start_time":{"type":"string","description":"Start time configured for the recurring maintenance. This should be in the form hh:mm in 24 hours format.","example":"10:00"}},"description":"Settings for recurring maintenance operation for the farm. This is Required only if maintenance_mode is set to RECURRING"},"FarmScheduledMaintenanceInfo":{"type":"object","properties":{"immediate_maintenance_scheduled":{"type":"boolean","description":"Indicates whether immediate maintenance is scheduled.","example":true},"logoff_policy":{"type":"string","description":"Determines when to perform the operation on RDS servers which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"WAIT_FOR_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"next_scheduled_time":{"type":"integer","description":"Time when next scheduled maintenance would happen.","format":"int64","example":1237081283000},"recurring_maintenance_settings":{"$ref":"#/components/schemas/FarmRecurringMaintenanceSettingsInfo"},"stop_on_first_error":{"type":"boolean","description":"Indicates whether the operation should stop on first error.","example":true}},"description":"Scheduled maintenance settings for the automated farm."},"FarmSessionSettings":{"type":"object","properties":{"disconnected_session_timeout_minutes":{"type":"integer","description":"Disconnected sessions timeout (in minutes).Will be set when disconnected_session_timeout_policy is set to AFTER.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","description":"Application empty session timeout in minutes. An empty session that has no remote-ablewindow is disconnected after the timeout. Default value is 1.Will be set when the empty_session_timeout_policy set to AFTER.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy. Default value is AFTER.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"After timeout, empty application sessions are logged off when set to true. Otherwise sessions are disconnected.Default value is false.","example":false},"pre_launch_session_timeout_minutes":{"type":"integer","description":"Application pre-launch session timeout in minutes. A pre-launch session is disconnected after the timeout.Will be set only when pre_launch_timeout_policy is set to AFTER.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Pre-launch session timeout policy for the application sessions on this Farm.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]}},"description":"Session related settings for the Farm."},"FarmSessionSettingsCreateSpec":{"type":"object","properties":{"disconnected_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Disconnected sessions timeout (in minutes). An empty disconnected session is logged off after the timeout. This is required if the disconnect_session_timeout_policy is set to AFTER.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER. \n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. Default value is 1. This is required if the empty_session_timeout_policy is set to AFTER.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy. Default value is AFTER\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. Default value is false if emptySessionTimeoutPolicy is set to AFTER or IMMEDIATE.","example":false},"pre_launch_session_timeout_minutes":{"minimum":10,"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. Default value is 10. This is required if pre_launch_session_timeout_policy is set to AFTER.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Application pre-launch session timeout policy. Default value is AFTER\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]}},"description":"Session settings related to the Farm."},"FarmSessionSettingsCreateSpecV2":{"type":"object","properties":{"disconnected_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Disconnected sessions timeout (in minutes). An empty disconnected session is logged off after the timeout. This is required if the disconnect_session_timeout_policy is set to AFTER.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session. Default value is NEVER. \n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. Default value is 1. This is required if the empty_session_timeout_policy is set to AFTER.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy. Default value is AFTER\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. Default value is false if emptySessionTimeoutPolicy is set to AFTER or IMMEDIATE.","example":false},"pre_launch_session_timeout_minutes":{"minimum":10,"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. Default value is 10. This is required if pre_launch_session_timeout_policy is set to AFTER.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Application pre-launch session timeout policy. Default value is AFTER\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"session_timeout_policy":{"type":"string","description":"Specifies the session timeout policy for the applications published from the Farm. This policy indicates whether the launched application session is a forever application session or not. Default value is DEFAULT.\n* DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.\n* NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.","example":"DEFAULT","enum":["DEFAULT","NEVER"]}},"description":"Session settings related to the Farm."},"FarmSessionSettingsInfo":{"type":"object","properties":{"disconnected_session_timeout_minutes":{"type":"integer","description":"Disconnected sessions timeout (in minutes). An empty disconnected session is logged off after the timeout. This is set when the disconnect_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session.\nThis property can be used for sorting.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. This is set when the empty_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy.\nThis property can be used for sorting.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.\nThis property can be used for sorting.","example":false},"pre_launch_session_timeout_minutes":{"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout.This is set when the pre_launch_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Application pre-launch session timeout policy. \nThis property can be used for sorting.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]}},"description":"Session settings related to the Farm."},"FarmSessionSettingsInfoV2":{"type":"object","properties":{"disconnected_session_timeout_minutes":{"type":"integer","description":"Disconnected sessions timeout (in minutes). An empty disconnected session is logged off after the timeout. This is set when the disconnect_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session.\nThis property can be used for sorting.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. This is set when the empty_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy.\nThis property can be used for sorting.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.\nThis property can be used for sorting.","example":false},"pre_launch_session_timeout_minutes":{"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout.This is set when the pre_launch_session_timeout_policy is set to AFTER.\nThis property can be used for sorting.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Application pre-launch session timeout policy. \nThis property can be used for sorting.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"session_timeout_policy":{"type":"string","description":"Specifies the session timeout policy for the applications published from the Farm. This policy indicates whether the launched application session is a forever application session or not.\nThis property can be used for sorting.\n* DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.\n* NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.","example":"DEFAULT","enum":["DEFAULT","NEVER"]}},"description":"Session settings related to the Farm."},"FarmSessionSettingsUpdateSpec":{"required":["disconnected_session_timeout_policy","empty_session_timeout_policy"],"type":"object","properties":{"disconnected_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Disconnected sessions timeout (in minutes). An empty disconnected session is logged off after the timeout. This is required if the disconnect_session_timeout_policy is set to AFTER.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. This is required if the empty_session_timeout_policy is set to AFTER.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. Default value is false if emptySessionTimeoutPolicy is set to AFTER or IMMEDIATE ","example":false},"pre_launch_session_timeout_minutes":{"minimum":10,"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout.This is required if pre_launch_session_timeout_policy is set to AFTER.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Application pre-launch session timeout policy.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]}},"description":"Session settings related to the Farm."},"FarmSessionSettingsUpdateSpecV2":{"required":["disconnected_session_timeout_policy","empty_session_timeout_policy","session_timeout_policy"],"type":"object","properties":{"disconnected_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Disconnected sessions timeout (in minutes). An empty disconnected session is logged off after the timeout. This is required if the disconnect_session_timeout_policy is set to AFTER.","format":"int32","example":5},"disconnected_session_timeout_policy":{"type":"string","description":"Log-off policy after disconnected session.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* NEVER: Do not logoff after user disconnect.","example":"NEVER","enum":["AFTER","IMMEDIATELY","NEVER"]},"empty_session_timeout_minutes":{"minimum":1,"type":"integer","description":"Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. This is required if the empty_session_timeout_policy is set to AFTER.","format":"int32","example":5},"empty_session_timeout_policy":{"type":"string","description":"Application empty session timeout policy.\n* AFTER: Empty session will be disconnected after specified number of minutes.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.","example":"AFTER","enum":["AFTER","IMMEDIATE","NEVER"]},"logoff_after_timeout":{"type":"boolean","description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. Default value is false if emptySessionTimeoutPolicy is set to AFTER or IMMEDIATE ","example":false},"pre_launch_session_timeout_minutes":{"minimum":10,"type":"integer","description":"Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout.This is required if pre_launch_session_timeout_policy is set to AFTER.","format":"int32","example":10},"pre_launch_session_timeout_policy":{"type":"string","description":"Application pre-launch session timeout policy.\n* AFTER: Pre-launched session is disconnected after specified number of minutes.\n* NEVER: Pre-launched session is never disconnected.","example":"AFTER","enum":["AFTER","NEVER"]},"session_timeout_policy":{"type":"string","description":"Specifies the session timeout policy for the applications published from the Farm. This policy indicates whether the launched application session is a forever application session or not.\n* DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.\n* NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.","example":"DEFAULT","enum":["DEFAULT","NEVER"]}},"description":"Session settings related to the Farm."},"FarmSettings":{"type":"object","properties":{"delete_in_progess":{"type":"boolean","description":"Indicates whether the Farm is in the process of being deleted. Default value is false.","example":false},"desktop_id":{"type":"string","description":"Desktop pool Id representing the RDS Desktop pool to which this Farm belongs.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettings"},"load_balancer_settings":{"$ref":"#/components/schemas/FarmLoadBalancerSettings"},"server_error_threshold":{"type":"integer","description":"The minimum number of machines that must be fully operational in order toavoid showing the farm in an error state. Default value is 0.","format":"int32","example":5},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettings"}},"description":"Settings related to the Farm."},"FarmStorageSettingsCreateSpec":{"required":["datastores"],"type":"object","properties":{"datastores":{"type":"array","description":"List of IDs of the datastore used to store the RDS Server.","items":{"$ref":"#/components/schemas/FarmDatastoreSettingsCreateSpec"}},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks for instant clone machines. This is required if use_separate_datastores_replica_and_os_disks is set to true.","example":"datastore-1"},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Indicates whether to use separate datastores for replica and OS disks. Default value is false.","example":false},"use_view_storage_accelerator":{"type":"boolean","description":"Indicates whether to use view storage accelerator. Default value is false.","example":false},"use_vsan":{"type":"boolean","description":"Indicates whether to use vSphere VSAN. Default value is false.","example":false}},"description":"Virtual center storage settings for the farm."},"FarmStorageSettingsInfo":{"type":"object","properties":{"datastores":{"type":"array","description":"List of IDs of the datastore used to store the RDS Server.","items":{"$ref":"#/components/schemas/FarmDatastoreSettingsInfo"}},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks for instant clone machines. This is set when use_separate_datastores_replica_and_os_disks is true.","example":"datastore-1"},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","description":"Indicates whether to use separate datastores for replica and OS disks.","example":false},"use_view_storage_accelerator":{"type":"boolean","description":"Indicates whether to use view storage accelerator.\nThis property can be used for sorting.","example":false},"use_vsan":{"type":"boolean","description":"Indicates whether to use vSphere VSAN.\nThis property can be used for sorting.","example":false}},"description":"Virtual center storage settings for the farm."},"FarmStorageSettingsUpdateSpec":{"required":["datastores"],"type":"object","properties":{"datastores":{"type":"array","description":"List of IDs of the datastore used to store the RDS Server. This can be modified only if there are no current operations ( operation is NONE).","items":{"$ref":"#/components/schemas/FarmDatastoreSettingsUpdateSpec"}},"replica_disk_datastore_id":{"type":"string","description":"Datastore to store replica disks for instant clone machines. This is required if use_separate_datastores_replica_and_os_disks is set to true. This can be modified only if there are no current operations ( operation is NONE).","example":"datastore-1"}},"description":"Virtual center storage settings for the farm."},"FarmUpdateSpec":{"required":["access_group_id","display_name","display_protocol_settings","enabled","server_error_threshold","session_settings","use_custom_script_for_load_balancing"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsUpdateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsUpdateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsUpdateSpec"},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. ","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsUpdateSpec"},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. ","example":false}},"description":"Farm object to be updated."},"FarmUpdateSpecV2":{"required":["access_group_id","display_name","display_protocol_settings","enabled","server_error_threshold","session_settings","use_custom_script_for_load_balancing"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsUpdateSpecV2"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsUpdateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsUpdateSpec"},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. ","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsUpdateSpec"},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. ","example":false}},"description":"Farm object to be updated."},"FarmUpdateSpecV3":{"required":["access_group_id","display_name","display_protocol_settings","enabled","load_balancer_settings","server_error_threshold","session_settings","use_custom_script_for_load_balancing"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsUpdateSpecV2"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsUpdateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsUpdateSpecV2"},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. ","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsUpdateSpecV2"},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. ","example":false}},"description":"Farm object to be updated."},"FarmUpdateSpecV4":{"required":["access_group_id","display_name","display_protocol_settings","enabled","load_balancer_settings","server_error_threshold","session_settings","use_custom_script_for_load_balancing"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsUpdateSpecV3"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsUpdateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsUpdateSpecV2"},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. ","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsUpdateSpecV2"},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. ","example":false}},"description":"Farm object to be updated."},"FarmUpdateSpecV5":{"required":["access_group_id","display_name","display_protocol_settings","enabled","load_balancer_settings","server_error_threshold","session_settings","use_custom_script_for_load_balancing"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsUpdateV5"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsUpdateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.","example":true},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsUpdateSpecV2"},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. ","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsUpdateSpecV2"},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. ","example":false}},"description":"Farm object to be updated."},"FarmUpdateSpecV6":{"required":["access_group_id","display_name","display_protocol_settings","enabled","entra_sso_enabled","load_balancer_settings","server_error_threshold","session_settings","use_custom_script_for_load_balancing"],"type":"object","properties":{"access_group_id":{"type":"string","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"automated_farm_settings":{"$ref":"#/components/schemas/FarmAutomatedSettingsUpdateV5"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of the farm.","example":"Farm Description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Display name of the farm.","example":"ManualFarm"},"display_protocol_settings":{"$ref":"#/components/schemas/FarmDisplayProtocolSettingsUpdateSpec"},"enabled":{"type":"boolean","description":"Indicates whether the farm is enabled for brokering.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled for the farm","example":false},"load_balancer_settings":{"$ref":"#/components/schemas/RDSHLoadBalancerSettingsUpdateSpecV3"},"server_error_threshold":{"minimum":0,"type":"integer","description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. ","format":"int32","example":0},"session_settings":{"$ref":"#/components/schemas/FarmSessionSettingsUpdateSpecV2"},"use_custom_script_for_load_balancing":{"type":"boolean","description":"Indicates whether to use custom scripts for load balancing or not. ","example":false}},"description":"Farm object to be updated."},"FeatureLogLevelInfo":{"type":"object","properties":{"associated_feature_list":{"type":"array","description":"List of feature keys associated with this particular feature.","example":["cdr","dpisync","fa","publishedapp","watermark"],"items":{"type":"string","description":"List of feature keys associated with this particular feature.","example":"[\"cdr\",\"dpisync\",\"fa\",\"publishedapp\",\"watermark\"]"}},"feature_display_name":{"type":"string","description":"Feature display name.","example":"RTAV"},"feature_key":{"type":"string","description":"Unique short name of the feature.","example":"rtav"},"log_level":{"type":"string","description":"Current log level for this feature.\n* INFO: Represents INFO log level.\n* DEBUG: Represents DEBUG log level..\n* TRACE: Represents TRACE log level.\n* VERBOSE: Represents VERBOSE log level.\n* DEFAULT: Represents DEFAULT log level.\n* PARTIAL_INFO: Represents PARTIAL_INFO log level.\n* PARTIAL_DEBUG: Represents PARTIAL_DEBUG log level.\n* PARTIAL_TRACE: Represents PARTIAL_TRACE log level.\n* PARTIAL_VERBOSE: Represents PARTIAL_VERBOSE log level.\n* CUSTOM: Represents UNKNOWN or PARTIAL log level.","example":"DEBUG","enum":["INFO","DEBUG","TRACE","VERBOSE","DEFAULT","PARTIAL_INFO","PARTIAL_DEBUG","PARTIAL_TRACE","PARTIAL_VERBOSE","CUSTOM"]},"supported_log_levels":{"type":"array","description":"List of log levels supported by this feature.","example":["INFO","DEBUG","TRACE"],"items":{"type":"string","description":"* VERBOSE: Represents VERBOSE log level.","example":"[\"INFO\",\"DEBUG\",\"TRACE\"]","enum":["INFO","DEBUG","TRACE","VERBOSE"]}}},"description":"List of log level info where each object in the list represents the log levels for a feature."},"FeatureSettings":{"type":"object","properties":{"cloud_managed":{"type":"boolean","description":"Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines.","example":true},"enable_helpdesk":{"type":"boolean","description":"Determines whether Helpdesk feature is enabled or not. By default Helpdesk is enabled.","example":true},"enable_image_management":{"type":"boolean","description":"Determines whether Image Management feature is enabled or not. By default Image Management is disabled.","example":true}},"description":"Information related to Feature Settings."},"FeatureSettingsUpdateSpec":{"type":"object","properties":{"cloud_managed":{"type":"boolean","description":"Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines.","example":true}},"description":"Feature settings object to be updated."},"FeatureSettingsUpdateSpecV2":{"type":"object","properties":{"cloud_managed":{"type":"boolean","description":"Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines.","example":true},"samlkey_sharing_enabled":{"type":"boolean"}},"description":"Feature settings object to be updated."},"FeatureSettingsUpdateSpecV3":{"type":"object","properties":{"cloud_managed":{"type":"boolean","description":"Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines.","example":true},"enforce_access_path_restriction":{"type":"boolean","description":"Indicates whether access restriction to pool based on path should be enforced.\nDefault value is false."},"samlkey_sharing_enabled":{"type":"boolean"}},"description":"Feature settings object to be updated."},"FeatureSettingsUpdateSpecV4":{"type":"object","properties":{"cloud_managed":{"type":"boolean","description":"Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines.","example":true},"enforce_access_path_restriction":{"type":"boolean","description":"Indicates whether access restriction to pool based on path should be enforced.\nDefault value is false."},"samlkey_sharing_enabled":{"type":"boolean"},"shared_acs_url":{"type":"string","description":"Custom Shared ACS URL for the cluster.","example":"https://lb.yourcompany.com:443"},"shared_entity_id_enabled":{"type":"boolean","description":"Indicates whether the shared SAML EntityID is supported over the cluster or not. By default, this feature is disabled.","example":false,"default":false}},"description":"Feature settings object to be updated."},"FeatureSettingsUpdateSpecV5":{"type":"object","properties":{"cloud_managed":{"type":"boolean","description":"Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines.","example":true},"enforce_access_path_restriction":{"type":"boolean","description":"Indicates whether access restriction to pool based on path should be enforced.\nDefault value is false."},"samlkey_sharing_enabled":{"type":"boolean"},"shared_acs_url":{"type":"string","description":"Custom Shared ACS URL for the cluster.","example":"https://lb.yourcompany.com:443"},"shared_entity_id":{"type":"string","description":"Shared entity ID for the cluster.","example":"98c17532-260f-492e-8f75-12e1001d4762"},"shared_entity_id_enabled":{"type":"boolean","description":"Indicates whether the shared SAML EntityID is supported over the cluster or not. By default, this feature is disabled.","example":false,"default":false}},"description":"Feature settings object to be updated."},"FeatureSettingsV2":{"type":"object","properties":{"cloud_entitlements_enabled":{"type":"boolean","description":"Indicates whether Cloud Entitlements is enabled.","example":true},"cloud_managed":{"type":"boolean","description":"Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines.","example":true},"enable_helpdesk":{"type":"boolean","description":"Determines whether Helpdesk feature is enabled or not. By default Helpdesk is enabled.","example":true},"enable_image_management":{"type":"boolean","description":"Determines whether Image Management feature is enabled or not. By default Image Management is disabled.","example":true},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by default.","example":true},"samlkey_sharing_enabled":{"type":"boolean"}},"description":"Information related to Feature Settings."},"FeatureSettingsV3":{"type":"object","properties":{"cloud_entitlements_enabled":{"type":"boolean","description":"Indicates whether Cloud Entitlements is enabled.","example":true},"cloud_managed":{"type":"boolean","description":"Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines.","example":true},"enable_helpdesk":{"type":"boolean","description":"Determines whether Helpdesk feature is enabled or not. By default Helpdesk is enabled.","example":true},"enable_image_management":{"type":"boolean","description":"Determines whether Image Management feature is enabled or not. By default Image Management is disabled.","example":true},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by default.","example":true},"enforce_access_path_restriction":{"type":"boolean","description":"Indicates whether access restriction to pool based on path should be enforced."},"samlkey_sharing_enabled":{"type":"boolean"}},"description":"Information related to Feature Settings."},"FeatureSettingsV4":{"type":"object","properties":{"cloud_entitlements_enabled":{"type":"boolean","description":"Indicates whether Cloud Entitlements is enabled.","example":true},"cloud_managed":{"type":"boolean","description":"Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines.","example":true},"enable_helpdesk":{"type":"boolean","description":"Determines whether Helpdesk feature is enabled or not. By default Helpdesk is enabled.","example":true},"enable_image_management":{"type":"boolean","description":"Determines whether Image Management feature is enabled or not. By default Image Management is disabled.","example":true},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by default.","example":true},"enforce_access_path_restriction":{"type":"boolean","description":"Indicates whether access restriction to pool based on path should be enforced."},"samlkey_sharing_enabled":{"type":"boolean"},"shared_acs_url":{"type":"string","description":"Custom Shared ACS URL for the cluster.","example":"https://lb.yourcompany.com:443"},"shared_entity_id_enabled":{"type":"boolean","description":"Indicates whether the shared SAML EntityID is supported over the cluster or not. By default, this feature is disabled.","example":false}},"description":"Information related to Feature Settings."},"FeatureSettingsV5":{"type":"object","properties":{"agent_log_collection_disabled":{"type":"boolean","description":"Indicates agent log collection is allowed or not. If connection server is installed in Non-FIPS mode default value of this field is false, in case if connection server is installed in FIPS mode default value of this field is set to true.","example":false},"cloud_entitlements_enabled":{"type":"boolean","description":"Indicates whether Cloud Entitlements is enabled.","example":true},"cloud_managed":{"type":"boolean","description":"Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines.","example":true},"enable_helpdesk":{"type":"boolean","description":"Determines whether Helpdesk feature is enabled or not. By default Helpdesk is enabled.","example":true},"enable_image_management":{"type":"boolean","description":"Determines whether Image Management feature is enabled or not. By default Image Management is disabled.","example":true},"enable_sysprep_domain_join":{"type":"boolean","description":"Indicates whether Microsoft Sysprep process performs domain bind for instant clone VMs when using sysprep customization. Disabled by default.","example":true},"enforce_access_path_restriction":{"type":"boolean","description":"Indicates whether access restriction to pool based on path should be enforced."},"samlkey_sharing_enabled":{"type":"boolean"},"shared_acs_url":{"type":"string","description":"Custom Shared ACS URL for the cluster.","example":"https://lb.yourcompany.com:443"},"shared_entity_id":{"type":"string","description":"Shared entity ID for the cluster.","example":"98c17532-260f-492e-8f75-12e1001d476"},"shared_entity_id_enabled":{"type":"boolean","description":"Indicates whether the shared SAML EntityID is supported over the cluster or not. By default, this feature is disabled.","example":false}},"description":"Information related to Feature Settings."},"FederationAccessGroupCreateSpec":{"required":["name"],"type":"object","properties":{"description":{"pattern":"[\\S\\s]{0,400}","type":"string","description":"Federation Access Group Description.","example":"This access group can be used to delegate administration of sales team inventories to specific administrators."},"name":{"pattern":"[a-zA-Z0-9_-]{1,32}","type":"string","description":"Federation Access Group Name. This property must contain only alphanumerics, underscores, and dashes.","example":"Sales"}},"description":"Federation access group object to be created."},"FederationAccessGroupInfo":{"type":"object","properties":{"deletable":{"type":"boolean","description":"Indicates whether this federation access group can be deleted.","example":true},"description":{"type":"string","description":"Federation Access group description.","example":"This Federation access group can be used to delegate administration of global sales team inventories to specific administrators."},"id":{"type":"string","description":"Unique ID representing this Federation Access Group.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"name":{"type":"string","description":"Federation Access group name.","example":"Sales"}},"description":"Information about Federation Access Group"},"FederationAccessGroupInfoV2":{"type":"object","properties":{"deletable":{"type":"boolean","description":"Indicates whether this federation access group can be deleted.","example":true},"description":{"type":"string","description":"Federation Access group description.","example":"This Federation access group can be used to delegate administration of global sales team inventories to specific administrators."},"id":{"type":"string","description":"Unique ID representing this Federation Access Group.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"name":{"type":"string","description":"Federation Access group name.","example":"Sales"},"permission_ids":{"type":"array","description":"List of permission ids associated with federation access group.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","6fd4638a-381f-4518-aed6-042aa3d9f14c"],"items":{"type":"string","description":"List of permission ids associated with federation access group.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"6fd4638a-381f-4518-aed6-042aa3d9f14c\"]"}}},"description":"Information about Federation Access Group"},"GSSAPIAuthenticatorCreateSpec":{"required":["allow_legacy_clients","allow_ntlm_fallback","connection_server_ids","enable_login_as_current_user","enforce_channel_bindings","trigger_mode"],"type":"object","properties":{"allow_legacy_clients":{"type":"boolean","description":"Indicates whether the legacy Horizon clients will be allowed to use login as current user.","example":true},"allow_ntlm_fallback":{"type":"boolean","description":"Indicates whether NTLM is allowed for GSSAPI authentication. When the client does not have access to the domain controllers in the hosted environment kerberos authentication fails, clients can fall back to NTLM authentication if allowNTLMFallback is set to true.","example":true},"connection_server_ids":{"uniqueItems":true,"type":"array","description":"The list of Connection Servers for which this GSSAPI authenticator is enabled.","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9","d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"items":{"type":"string","description":"The list of Connection Servers for which this GSSAPI authenticator is enabled.","example":"[\"42e47f15-aad0-221a-b231-ea4a3a134ec9\",\"d0325b13-2bf1-4fa4-b027-e780004f2d1e\"]"}},"enable_login_as_current_user":{"type":"boolean","description":"Indicates whether the login as current user is enabled or not.","example":true},"enforce_channel_bindings":{"type":"boolean","description":"Indicates whether channel bindings is supported or not.","example":true},"trigger_mode":{"type":"string","description":"Indicates True SSO trigger mode on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* OPTIONAL: If no SSO credentials are provided then use True SSO otherwise use the supplied SSO credentials.\n* ENABLED: Always use True SSO even if client supplied SSO credentials.","example":"ENABLED","enum":["DISABLED","OPTIONAL","ENABLED"]}},"description":"GSSAPI Authenticator specification"},"GSSAPIAuthenticatorInfo":{"type":"object","properties":{"allow_legacy_clients":{"type":"boolean","description":"Indicates whether the legacy Horizon clients will be allowed to use login as current user.","example":true},"allow_ntlm_fallback":{"type":"boolean","description":"Indicates whether NTLM is allowed for GSSAPI authentication. When the client does not have access to the domain controllers in the hosted environment kerberos authentication fails, clients can fall back to NTLM authentication if allowNTLMFallback is set to true.","example":true},"connection_servers":{"type":"array","description":"The list of Connection Servers for which this GSSAPI authenticator is enabled.","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9","d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"items":{"type":"string","description":"The list of Connection Servers for which this GSSAPI authenticator is enabled.","example":"[\"42e47f15-aad0-221a-b231-ea4a3a134ec9\",\"d0325b13-2bf1-4fa4-b027-e780004f2d1e\"]"}},"enable_login_as_current_user":{"type":"boolean","description":"Indicates whether the login as current user is enabled or not.","example":true},"enforce_channel_bindings":{"type":"boolean","description":"Indicates whether channel bindings is supported or not.","example":true},"id":{"type":"string","description":"Unique ID representing this GSSAPI Authenticator.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"trigger_mode":{"type":"string","description":"Indicates True SSO trigger mode on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* OPTIONAL: If no SSO credentials are provided then use True SSO otherwise use the supplied SSO credentials.\n* ENABLED: Always use True SSO even if client supplied SSO credentials.","example":"ENABLED","enum":["DISABLED","OPTIONAL","ENABLED"]}},"description":"Information about to GSSAPI Authenticator."},"GSSAPIAuthenticatorUpdateSpec":{"required":["allow_legacy_clients","allow_ntlm_fallback","enable_login_as_current_user","enforce_channel_bindings","trigger_mode"],"type":"object","properties":{"allow_legacy_clients":{"type":"boolean","description":"Indicates whether the legacy Horizon clients will be allowed to use login as current user.","example":true},"allow_ntlm_fallback":{"type":"boolean","description":"Indicates whether NTLM is allowed for GSSAPI authentication. When the client does not have access to the domain controllers in the hosted environment kerberos authentication fails, clients can fall back to NTLM authentication if allowNTLMFallback is set to true.","example":true},"enable_login_as_current_user":{"type":"boolean","description":"Indicates whether the login as current user is enabled or not.","example":true},"enforce_channel_bindings":{"type":"boolean","description":"Indicates whether channel bindings is supported or not.","example":true},"trigger_mode":{"type":"string","description":"Indicates True SSO trigger mode on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* OPTIONAL: If no SSO credentials are provided then use True SSO otherwise use the supplied SSO credentials.\n* ENABLED: Always use True SSO even if client supplied SSO credentials.","example":"ENABLED","enum":["DISABLED","OPTIONAL","ENABLED"]}},"description":"GSSAPIAuthenticator whose settings need to be updated."},"GatewayAccessUserOrGroupInfo":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","description":"The unique SID for the user or group.","example":"S-1-5-21-1111111111-2222222222-3333333333-513"}},"description":"Information for user or group with gateway access"},"GatewayCertificateInfo":{"type":"object","properties":{"certificate_name":{"type":"string","description":"Name of the certificate.","example":"Uag certificate"},"common_name":{"type":"string","description":"Indicates the common name of the certificate derived from the subject field in X509.","example":"OU=self-signed, CN=uagcte.horizoncte.net"},"expiry_date":{"type":"integer","description":"Expiration date of the certificate.","format":"int64","example":1804942883000},"id":{"type":"string"},"issuer":{"type":"string","description":"Issuer of the certificate.","example":"OU=self-signed, CN=uagcte.horizoncte.net"},"serial_num":{"type":"string","description":"Indicates the unique serial number issued by the certificate authority.","example":"63581968621"}},"description":"Information about Gateway certificate."},"GatewayCertificateSpec":{"type":"object","properties":{"certificate":{"type":"string","description":"Certificate content in PEM format"},"certificate_name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the certificate.","example":"Uag certificate"}},"description":"Gateway certificate to be added."},"GatewayCreateSpec":{"required":["name"],"type":"object","properties":{"name":{"maxLength":64,"minLength":0,"type":"string","description":"FQDN of gateway server which is to be registered.","example":"gateway1.example.com"}},"description":"Gateway Server to be registered"},"GatewayInfo":{"type":"object","properties":{"address":{"type":"string","description":"Gateway host name or IP address.","example":"uag1.example.com"},"id":{"type":"string","description":"Unique ID of the Gateway.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"internal":{"type":"boolean","description":"Indicates whether the gateway is internal.","example":false},"name":{"type":"string","description":"Gateway name.","example":"uag1.example.com"},"type":{"type":"string","description":"Type of the Gateway.\n* UAG: Unified Access Gateway type.\n* F5: F5 Gateway type.\n* SG: SG type is for Security Server.\n* SG_COHOSTED: SG-cohosted type is for Cohosted CS as gateway.\n* UNKNOWN: Unknown type.","example":"UAG","enum":["UAG","F5","SG","SG_COHOSTED","UNKNOWN"]},"version":{"type":"string","description":"Version of the Gateway.","example":"3.5.0"}},"description":"Information about Gateway."},"GatewayMonitorDetails":{"type":"object","properties":{"address":{"type":"string","description":"Gateway host name or IP address.","example":"uag1.example.com"},"internal":{"type":"boolean","description":"Indicates if the Gateway is internal.","example":false},"type":{"type":"string","description":"Type of the Gateway.\n* UAG: Unified Access Gateway type.\n* F5: F5 Gateway type.\n* SG: SG type is for Security Server.\n* SG_COHOSTED: SG-cohosted type is for Cohosted CS as gateway.\n* UNKNOWN: Unknown type.","example":"UAG","enum":["UAG","F5","SG","SG_COHOSTED","UNKNOWN"]},"version":{"type":"string","description":"Version of the Gateway.","example":"3.5.0"}},"description":"Details of the Gateway."},"GatewayMonitorInfo":{"type":"object","properties":{"active_connection_count":{"minimum":0,"type":"integer","description":"Number of active connections for the gateway. Includes PCoIP and BLAST connection counts.","format":"int32","example":1234},"blast_connection_count":{"minimum":0,"type":"integer","description":"Number of BLAST connections for the gateway.","format":"int32","example":10},"details":{"$ref":"#/components/schemas/GatewayMonitorDetails"},"id":{"type":"string","description":"Unique ID of the Gateway.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"name":{"type":"string","description":"Gateway name.","example":"uag1"},"pcoip_connection_count":{"minimum":0,"type":"integer","description":"Number of PCoIP connections for the gateway.","format":"int32","example":90},"status":{"type":"string","description":"Status of the Gateway.\n* NOT_CONTACTED: There has been no contact from the gateway.\n* PROBLEM: The gateway has reported a problem.\n* STALE: Gateway is stale. Gateway will be marked as stale when Connection Server does not receive any request from the Gateway in last two successive intervals.\n* OK: The Gateway is working as expected.","example":"OK","enum":["NOT_CONTACTED","PROBLEM","STALE","OK"]}},"description":"Monitoring information related to Gateways registered in the environment."},"GatewayMonitorInfoV2":{"type":"object","properties":{"active_connection_count":{"minimum":0,"type":"integer","description":"Number of active connections for the gateway. Includes PCoIP and BLAST connection counts.","format":"int32","example":1234},"blast_connection_count":{"minimum":0,"type":"integer","description":"Number of BLAST connections for the gateway.","format":"int32","example":10},"details":{"$ref":"#/components/schemas/GatewayMonitorDetails"},"id":{"type":"string","description":"Unique ID of the Gateway.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Gateway name.","example":"uag1"},"pcoip_connection_count":{"minimum":0,"type":"integer","description":"Number of PCoIP connections for the gateway.","format":"int32","example":90},"status":{"type":"string","description":"Status of the Gateway.\n* NOT_CONTACTED: There has been no contact from the gateway.\n* PROBLEM: The gateway has reported a problem.\n* STALE: Gateway is stale. Gateway will be marked as stale when Connection Server does not receive any request from the Gateway in last two successive intervals.\n* OK: The Gateway is working as expected.","example":"OK","enum":["NOT_CONTACTED","PROBLEM","STALE","OK"]}},"description":"Monitoring information related to Gateways registered in the environment."},"GatewayMonitorInfoV3":{"type":"object","properties":{"active_connection_count":{"minimum":0,"type":"integer","description":"Number of active connections for the gateway. Includes PCoIP and BLAST connection counts.","format":"int32","example":1234},"blast_connection_count":{"minimum":0,"type":"integer","description":"Number of BLAST connections for the gateway.","format":"int32","example":10},"details":{"$ref":"#/components/schemas/GatewayMonitorDetails"},"id":{"type":"string","description":"Unique ID of the Gateway.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Gateway name.","example":"uag1"},"pcoip_connection_count":{"minimum":0,"type":"integer","description":"Number of PCoIP connections for the gateway.","format":"int32","example":90},"status":{"type":"string","description":"Status of the Gateway.\n* NOT_CONTACTED: There has been no contact from the gateway.\n* PROBLEM: The gateway has reported a problem.\n* STALE: Gateway is stale. Gateway will be marked as stale when Connection Server does not receive any request from the Gateway in last two successive intervals.\n* OK: The Gateway is working as expected.","example":"OK","enum":["NOT_CONTACTED","PROBLEM","STALE","OK"]},"unrecognized_pcoip_requests_count":{"type":"integer","description":"Number of unrecognized PCoIP Secure Gateway requests.","format":"int32","example":2},"unrecognized_tunnel_requests_count":{"type":"integer","description":"Number of unrecognized Tunnel requests.","format":"int32","example":5},"unrecognized_xmlapi_requests_count":{"type":"integer","description":"Number of unrecognized XML API requests.","format":"int32","example":6}},"description":"Monitoring information related to Gateways registered in the environment."},"GatewayMonitorInfoV4":{"type":"object","properties":{"active_connection_count":{"minimum":0,"type":"integer","description":"Number of active connections for the gateway. Includes PCoIP and BLAST connection counts.","format":"int32","example":1234},"blast_connection_count":{"minimum":0,"type":"integer","description":"Number of BLAST connections for the gateway.","format":"int32","example":10},"details":{"$ref":"#/components/schemas/GatewayMonitorDetails"},"id":{"type":"string","description":"Unique ID of the Gateway.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Gateway name.","example":"uag1"},"pcoip_connection_count":{"minimum":0,"type":"integer","description":"Number of PCoIP connections for the gateway.","format":"int32","example":90},"status":{"type":"string","description":"Status of the Gateway.\n* NOT_CONTACTED: There has been no contact from the gateway.\n* PROBLEM: The gateway has reported a problem.\n* STALE: Gateway is stale. Gateway will be marked as stale when Connection Server does not receive any request from the Gateway in last two successive intervals.\n* OK: The Gateway is working as expected.","example":"OK","enum":["NOT_CONTACTED","PROBLEM","STALE","OK"]},"unrecognized_blast_requests_count":{"type":"integer","description":"Number of unrecognized blast requests.","format":"int32","example":5},"unrecognized_pcoip_requests_count":{"type":"integer","description":"Number of unrecognized PCoIP Secure Gateway requests.","format":"int32","example":2},"unrecognized_tunnel_requests_count":{"type":"integer","description":"Number of unrecognized Tunnel requests.","format":"int32","example":5},"unrecognized_xmlapi_requests_count":{"type":"integer","description":"Number of unrecognized XML API requests.","format":"int32","example":6}},"description":"Monitoring information related to Gateways registered in the environment."},"GatewayMonitorInfoV5":{"type":"object","properties":{"active_connection_count":{"minimum":0,"type":"integer","description":"Number of active connections for the gateway. Includes PCoIP and BLAST connection counts.","format":"int32","example":1234},"blast_connection_count":{"minimum":0,"type":"integer","description":"Number of BLAST connections for the gateway.","format":"int32","example":10},"details":{"$ref":"#/components/schemas/GatewayMonitorDetails"},"gateway_certificate_health":{"$ref":"#/components/schemas/GatewayTlsCertificateHealth"},"id":{"type":"string","description":"Unique ID of the Gateway.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Gateway name.","example":"uag1"},"pcoip_connection_count":{"minimum":0,"type":"integer","description":"Number of PCoIP connections for the gateway.","format":"int32","example":90},"service_error_infos":{"type":"array","description":"List containing gateway services in error state.","items":{"$ref":"#/components/schemas/ServiceErrorInfo"}},"status":{"type":"string","description":"Status of the Gateway.\n* NOT_CONTACTED: There has been no contact from the gateway.\n* PROBLEM: The gateway has reported a problem.\n* STALE: Gateway is stale. Gateway will be marked as stale when Connection Server does not receive any request from the Gateway in last two successive intervals.\n* OK: The Gateway is working as expected.","example":"OK","enum":["NOT_CONTACTED","PROBLEM","STALE","OK"]},"unrecognized_blast_requests_count":{"type":"integer","description":"Number of unrecognized blast requests.","format":"int32","example":5},"unrecognized_pcoip_requests_count":{"type":"integer","description":"Number of unrecognized PCoIP Secure Gateway requests.","format":"int32","example":2},"unrecognized_tunnel_requests_count":{"type":"integer","description":"Number of unrecognized Tunnel requests.","format":"int32","example":5},"unrecognized_xmlapi_requests_count":{"type":"integer","description":"Number of unrecognized XML API requests.","format":"int32","example":6}},"description":"Monitoring information related to Gateways registered in the environment."},"GatewayTlsCertificateHealth":{"type":"object","properties":{"days_before_expiry":{"type":"integer","description":"Indicates days remaining before certificate expiry.","format":"int32","example":30},"invalid_reasons":{"type":"array","description":"Indicates the reason for invalid certificate.","example":["NAME_MISMATCH","NOT_TRUSTED"],"items":{"type":"string","description":"Indicates the reason for invalid certificate.","example":"[\"NAME_MISMATCH\",\"NOT_TRUSTED\"]"}},"valid":{"type":"boolean","description":"Indicates if the certificate is valid.","example":true}},"description":"Information about gateway TLS certificate."},"GeneralSettings":{"type":"object","properties":{"application_sso_timeout_minutes":{"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the Connection Server takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if clientMaxSessionTimeoutPolicy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data":{"type":"array","description":"List of restricted Horizon Clients.","example":[{"type":"WINDOWS","version":"7.5"},{"type":"LINUX","version":"6.5"}],"items":{"$ref":"#/components/schemas/RestrictedClientData"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Connection Server.","example":false}},"description":"Information related to General Settings."},"GeneralSettingsUpdateSpec":{"required":["application_sso_timeout_policy","client_idle_session_timeout_policy","client_max_session_timeout_policy","client_session_timeout_minutes","machine_sso_timeout_policy","store_cal_on_client","store_cal_on_connection_server"],"type":"object","properties":{"application_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the broker takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if Client Max Session Timeout Policy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"minimum":1,"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data":{"type":"array","description":"List of restricted Horizon Clients.","example":[{"type":"WINDOWS","version":"7.5"},{"type":"LINUX","version":"6.5"}],"items":{"$ref":"#/components/schemas/RestrictedClientData"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Broker.","example":false}},"description":"General settings object to be updated."},"GeneralSettingsUpdateSpecV2":{"required":["application_sso_timeout_policy","client_idle_session_timeout_policy","client_max_session_timeout_policy","client_session_timeout_minutes","machine_sso_timeout_policy","store_cal_on_client","store_cal_on_connection_server"],"type":"object","properties":{"application_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the broker takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if Client Max Session Timeout Policy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"minimum":1,"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"restricted_client_warn_message":{"type":"string","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server.","example":"This client version is not recommended. Please upgrade to the latest version."},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Broker.","example":false}},"description":"General settings object to be updated."},"GeneralSettingsUpdateSpecV3":{"required":["application_sso_timeout_policy","client_idle_session_timeout_policy","client_max_session_timeout_policy","client_session_timeout_minutes","display_pre_login_admin_banner","machine_sso_timeout_policy","store_cal_on_client","store_cal_on_connection_server"],"type":"object","properties":{"api_session_timeout_minutes":{"maximum":4320,"minimum":10,"type":"integer","description":"Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.<br>Setting the API session timeout to a high number of minutes increases the risk of unauthorized use of View API.<br>Use caution when you allow an idle session to persist for a long time.<br>Default value is 30.","format":"int32","example":30},"application_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the broker takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if Client Max Session Timeout Policy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"display_pre_login_admin_banner":{"type":"boolean","description":"Enable/disable pre login message pop up before logging into Horizon admin console","example":false},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"enable_user_name_caching":{"type":"boolean","description":"UI Client provide 'remember me' option when this is set to true.<br>Default value is true.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"minimum":1,"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_admin_banner_header":{"type":"string","description":"The warning pop up header to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"Attention"},"pre_login_admin_banner_message":{"type":"string","description":"The warning pop up message to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"On proceeding, you agree that you fully comply with the laws of this organisation."},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"restricted_client_warn_message":{"type":"string","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server.","example":"This client version is not recommended. Please upgrade to the latest version."},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Broker.","example":false}},"description":"General settings object to be updated."},"GeneralSettingsUpdateSpecV4":{"required":["application_sso_timeout_policy","client_idle_session_timeout_policy","client_max_session_timeout_policy","client_session_timeout_minutes","display_pre_login_admin_banner","machine_sso_timeout_policy","store_cal_on_client","store_cal_on_connection_server"],"type":"object","properties":{"api_session_timeout_minutes":{"maximum":4320,"minimum":10,"type":"integer","description":"Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.<br>Setting the API session timeout to a high number of minutes increases the risk of unauthorized use of View API.<br>Use caution when you allow an idle session to persist for a long time.<br>Default value is 30.","format":"int32","example":30},"application_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the broker takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if Client Max Session Timeout Policy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"display_pre_login_admin_banner":{"type":"boolean","description":"Enable/disable pre login message pop up before logging into Horizon admin console","example":false},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"enable_user_name_caching":{"type":"boolean","description":"UI Client provide 'remember me' option when this is set to true.<br>Default value is true.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"minimum":1,"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_admin_banner_header":{"type":"string","description":"The warning pop up header to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"Attention"},"pre_login_admin_banner_message":{"type":"string","description":"The warning pop up message to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"On proceeding, you agree that you fully comply with the laws of this organisation."},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"restricted_client_warn_message":{"type":"string","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server.","example":"This client version is not recommended. Please upgrade to the latest version."},"sso_discard_connection_type":{"type":"string","description":"The type of connection for which the single sign on discard timeout minutes should be applied.\n* NONE: Indicates the connections from client devices on neither private networks nor non-private networks.\n* INTERNAL: Indicates the connections from client devices on private networks.\n* EXTERNAL: Indicates the connections from client devices on non-private networks.\n* BOTH: Indicates the connections from client devices both on private and non-private networks.","example":"BOTH","enum":["NONE","INTERNAL","EXTERNAL","BOTH"]},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Broker.","example":false}},"description":"General settings object to be updated."},"GeneralSettingsUpdateSpecV5":{"required":["application_sso_timeout_policy","client_idle_session_timeout_policy","client_max_session_timeout_policy","client_session_timeout_minutes","display_pre_login_admin_banner","machine_sso_timeout_policy","store_cal_on_client","store_cal_on_connection_server"],"type":"object","properties":{"api_session_timeout_minutes":{"maximum":4320,"minimum":10,"type":"integer","description":"Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.<br>Setting the API session timeout to a high number of minutes increases the risk of unauthorized use of View API.<br>Use caution when you allow an idle session to persist for a long time.<br>Default value is 30.","format":"int32","example":30},"application_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_folders_enabled":{"type":"boolean","description":"Flag conveying if client gets the ability to add/edit/display folders","example":true},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the broker takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if Client Max Session Timeout Policy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"disconnect_message":{"type":"string","description":"The message to be displayed at the time of forced disconnect."},"disconnect_warning_message":{"type":"string","description":"The warning to be displayed before forcibly disconnect timeout."},"disconnect_warning_time":{"maximum":30,"minimum":0,"type":"integer","description":"The time (in minutes) prior to the forcibly disconnect timeout when a warning message would be shown by the client","format":"int32","example":30},"display_pre_login_admin_banner":{"type":"boolean","description":"Enable/disable pre login message pop up before logging into Horizon admin console","example":false},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"enable_user_name_caching":{"type":"boolean","description":"UI Client provide 'remember me' option when this is set to true.<br>Default value is true.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"minimum":1,"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"password_policy_error_message":{"type":"string","description":"The Error message that needs to be displayed at the client for end users incase resetting password fails because of policy violations","example":"The new password does not meet the password policy requirements."},"pre_login_admin_banner_header":{"type":"string","description":"The warning pop up header to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"Attention"},"pre_login_admin_banner_message":{"type":"string","description":"The warning pop up message to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"On proceeding, you agree that you fully comply with the laws of this organisation."},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"restricted_client_warn_message":{"type":"string","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server.","example":"This client version is not recommended. Please upgrade to the latest version."},"sso_discard_connection_type":{"type":"string","description":"The type of connection for which the single sign on discard timeout minutes should be applied.\n* NONE: Indicates the connections from client devices on neither private networks nor non-private networks.\n* INTERNAL: Indicates the connections from client devices on private networks.\n* EXTERNAL: Indicates the connections from client devices on non-private networks.\n* BOTH: Indicates the connections from client devices both on private and non-private networks.","example":"BOTH","enum":["NONE","INTERNAL","EXTERNAL","BOTH"]},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Broker.","example":false}},"description":"General settings object to be updated."},"GeneralSettingsUpdateSpecV6":{"required":["application_sso_timeout_policy","client_idle_session_timeout_policy","client_max_session_timeout_policy","client_session_timeout_minutes","display_pre_login_admin_banner","machine_sso_timeout_policy","store_cal_on_client","store_cal_on_connection_server"],"type":"object","properties":{"agent_upgrade_notifications_enabled":{"type":"boolean"},"api_session_timeout_minutes":{"maximum":4320,"minimum":10,"type":"integer","description":"Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.<br>Setting the API session timeout to a high number of minutes increases the risk of unauthorized use of View API.<br>Use caution when you allow an idle session to persist for a long time.<br>Default value is 30.","format":"int32","example":30},"application_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_domains_ordering":{"type":"array","description":"The domains in specified order is sent to Horizon client when send domains is enabled.","example":["HZN","HZNTWOWAY"],"items":{"type":"string","description":"The domains in specified order is sent to Horizon client when send domains is enabled.","example":"[\"HZN\",\"HZNTWOWAY\"]"}},"client_folders_enabled":{"type":"boolean","description":"Flag conveying if client gets the ability to add/edit/display folders","example":true},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the broker takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if Client Max Session Timeout Policy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"disconnect_message":{"type":"string","description":"The message to be displayed at the time of forced disconnect."},"disconnect_warning_message":{"type":"string","description":"The warning to be displayed before forcibly disconnect timeout."},"disconnect_warning_time":{"maximum":30,"minimum":0,"type":"integer","description":"The time (in minutes) prior to the forcibly disconnect timeout when a warning message would be shown by the client","format":"int32","example":30},"display_pre_login_admin_banner":{"type":"boolean","description":"Enable/disable pre login message pop up before logging into Horizon admin console","example":false},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"enable_user_name_caching":{"type":"boolean","description":"UI Client provide 'remember me' option when this is set to true.<br>Default value is true.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"minimum":1,"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"password_policy_error_message":{"type":"string","description":"The Error message that needs to be displayed at the client for end users incase resetting password fails because of policy violations","example":"The new password does not meet the password policy requirements."},"pre_login_admin_banner_header":{"type":"string","description":"The warning pop up header to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"Attention"},"pre_login_admin_banner_message":{"type":"string","description":"The warning pop up message to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"On proceeding, you agree that you fully comply with the laws of this organisation."},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"restricted_client_warn_message":{"type":"string","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server.","example":"This client version is not recommended. Please upgrade to the latest version."},"sso_discard_connection_type":{"type":"string","description":"The type of connection for which the single sign on discard timeout minutes should be applied.\n* NONE: Indicates the connections from client devices on neither private networks nor non-private networks.\n* INTERNAL: Indicates the connections from client devices on private networks.\n* EXTERNAL: Indicates the connections from client devices on non-private networks.\n* BOTH: Indicates the connections from client devices both on private and non-private networks.","example":"BOTH","enum":["NONE","INTERNAL","EXTERNAL","BOTH"]},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Broker.","example":false}},"description":"General settings object to be updated."},"GeneralSettingsUpdateSpecV7":{"required":["application_sso_timeout_policy","client_idle_session_timeout_policy","client_max_session_timeout_policy","client_session_timeout_minutes","display_pre_login_admin_banner","machine_sso_timeout_policy","store_cal_on_client","store_cal_on_connection_server"],"type":"object","properties":{"agent_upgrade_notifications_enabled":{"type":"boolean"},"api_session_timeout_minutes":{"maximum":4320,"minimum":10,"type":"integer","description":"Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.<br>Setting the API session timeout to a high number of minutes increases the risk of unauthorized use of View API.<br>Use caution when you allow an idle session to persist for a long time.<br>Default value is 30.","format":"int32","example":30},"application_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_domains_ordering":{"type":"array","description":"The domains in specified order is sent to Horizon client when send domains is enabled.","example":["HZN","HZNTWOWAY"],"items":{"type":"string","description":"The domains in specified order is sent to Horizon client when send domains is enabled.","example":"[\"HZN\",\"HZNTWOWAY\"]"}},"client_folders_enabled":{"type":"boolean","description":"Flag conveying if client gets the ability to add/edit/display folders","example":true},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the broker takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if Client Max Session Timeout Policy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"minimum":5,"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"disconnect_message":{"type":"string","description":"The message to be displayed at the time of forced disconnect."},"disconnect_warning_message":{"type":"string","description":"The warning to be displayed before forcibly disconnect timeout."},"disconnect_warning_time":{"maximum":30,"minimum":0,"type":"integer","description":"The time (in minutes) prior to the forcibly disconnect timeout when a warning message would be shown by the client","format":"int32","example":30},"display_pre_login_admin_banner":{"type":"boolean","description":"Enable/disable pre login message pop up before logging into Horizon admin console","example":false},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"enable_user_name_caching":{"type":"boolean","description":"UI Client provide 'remember me' option when this is set to true.<br>Default value is true.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"minimum":1,"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"helpdesk_app_privacy":{"type":"string","description":"Controls visibility of application file names. If set to ENABLED, only application process IDs are visible instead of file names. Default is DISABLED (file names are visible).\n* DISABLED: Helpdesk App Privacy is disabled. Application file names are visible.\n* ENABLED: Helpdesk App Privacy is enabled. Application file names are hidden; only process IDs are shown.","example":"DISABLED","enum":["DISABLED","ENABLED"]},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"minimum":1,"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"password_policy_error_message":{"type":"string","description":"The Error message that needs to be displayed at the client for end users incase resetting password fails because of policy violations","example":"The new password does not meet the password policy requirements."},"pre_login_admin_banner_header":{"type":"string","description":"The warning pop up header to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"Attention"},"pre_login_admin_banner_message":{"type":"string","description":"The warning pop up message to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"On proceeding, you agree that you fully comply with the laws of this organisation."},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV2"}},"restricted_client_data_v3":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV3"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"restricted_client_warn_message":{"type":"string","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server.","example":"This client version is not recommended. Please upgrade to the latest version."},"sso_discard_connection_type":{"type":"string","description":"The type of connection for which the single sign on discard timeout minutes should be applied.\n* NONE: Indicates the connections from client devices on neither private networks nor non-private networks.\n* INTERNAL: Indicates the connections from client devices on private networks.\n* EXTERNAL: Indicates the connections from client devices on non-private networks.\n* BOTH: Indicates the connections from client devices both on private and non-private networks.","example":"BOTH","enum":["NONE","INTERNAL","EXTERNAL","BOTH"]},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Broker.","example":false}},"description":"General settings object to be updated."},"GeneralSettingsV2":{"type":"object","properties":{"application_sso_timeout_minutes":{"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the Connection Server takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if clientMaxSessionTimeoutPolicy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"restricted_client_warn_message":{"type":"string","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server.","example":"This client version is not recommended. Please upgrade to the latest version."},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Connection Server.","example":false}},"description":"Information related to General Settings."},"GeneralSettingsV3":{"type":"object","properties":{"api_session_timeout_minutes":{"type":"integer","description":"Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.\nSetting the API session timeout to a high number of minutes increases the risk of unauthorized use of View API.\nUse caution when you allow an idle session to persist for a long time.","format":"int32","example":30},"application_sso_timeout_minutes":{"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the Connection Server takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if clientMaxSessionTimeoutPolicy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"display_pre_login_admin_banner":{"type":"boolean","description":"Enable/disable pre login message pop up before logging into Horizon admin console","example":false},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_admin_banner_header":{"type":"string","description":"The warning pop up header to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"Attention"},"pre_login_admin_banner_message":{"type":"string","description":"The warning pop up message to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"On proceeding, you agree that you fully comply with the laws of this organisation."},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"restricted_client_warn_message":{"type":"string","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server.","example":"This client version is not recommended. Please upgrade to the latest version."},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Connection Server.","example":false}},"description":"Information related to General Settings."},"GeneralSettingsV4":{"type":"object","properties":{"api_session_timeout_minutes":{"type":"integer","description":"Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.\nSetting the API session timeout to a high number of minutes increases the risk of unauthorized use of View API.\nUse caution when you allow an idle session to persist for a long time.","format":"int32","example":30},"application_sso_timeout_minutes":{"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the Connection Server takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if clientMaxSessionTimeoutPolicy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"display_pre_login_admin_banner":{"type":"boolean","description":"Enable/disable pre login message pop up before logging into Horizon admin console","example":false},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_admin_banner_header":{"type":"string","description":"The warning pop up header to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"Attention"},"pre_login_admin_banner_message":{"type":"string","description":"The warning pop up message to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"On proceeding, you agree that you fully comply with the laws of this organisation."},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"restricted_client_warn_message":{"type":"string","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server.","example":"This client version is not recommended. Please upgrade to the latest version."},"sso_discard_connection_type":{"type":"string","description":"The type of connection for which the single sign on discard timeout minutes should be applied.\n* NONE: Indicates the connections from client devices on neither private networks nor non-private networks.\n* INTERNAL: Indicates the connections from client devices on private networks.\n* EXTERNAL: Indicates the connections from client devices on non-private networks.\n* BOTH: Indicates the connections from client devices both on private and non-private networks.","example":"BOTH","enum":["NONE","INTERNAL","EXTERNAL","BOTH"]},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Connection Server.","example":false}},"description":"Information related to General Settings."},"GeneralSettingsV5":{"type":"object","properties":{"api_session_timeout_minutes":{"type":"integer","description":"Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.\nSetting the API session timeout to a high number of minutes increases the risk of unauthorized use of View API.\nUse caution when you allow an idle session to persist for a long time.","format":"int32","example":30},"application_sso_timeout_minutes":{"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_folders_enabled":{"type":"boolean","description":"Flag conveying if client gets the ability to add/edit/display folders","example":true},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the Connection Server takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if clientMaxSessionTimeoutPolicy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"disconnect_message":{"type":"string","description":"The message to be displayed at the time of forced disconnect."},"disconnect_warning_message":{"type":"string","description":"The warning to be displayed before forcibly disconnect timeout."},"disconnect_warning_time":{"type":"integer","description":"The time (in minutes) prior to the forcibly disconnect timeout when a warning message would be shown by the client","format":"int32","example":30},"display_pre_login_admin_banner":{"type":"boolean","description":"Enable/disable pre login message pop up before logging into Horizon admin console","example":false},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"password_policy_error_message":{"type":"string","description":"The Error message that needs to be displayed at the client for end users incase resetting password fails because of policy violations","example":"The new password does not meet the password policy requirements."},"pre_login_admin_banner_header":{"type":"string","description":"The warning pop up header to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"Attention"},"pre_login_admin_banner_message":{"type":"string","description":"The warning pop up message to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"On proceeding, you agree that you fully comply with the laws of this organisation."},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"restricted_client_warn_message":{"type":"string","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server.","example":"This client version is not recommended. Please upgrade to the latest version."},"sso_discard_connection_type":{"type":"string","description":"The type of connection for which the single sign on discard timeout minutes should be applied.\n* NONE: Indicates the connections from client devices on neither private networks nor non-private networks.\n* INTERNAL: Indicates the connections from client devices on private networks.\n* EXTERNAL: Indicates the connections from client devices on non-private networks.\n* BOTH: Indicates the connections from client devices both on private and non-private networks.","example":"BOTH","enum":["NONE","INTERNAL","EXTERNAL","BOTH"]},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Connection Server.","example":false}},"description":"Information related to General Settings."},"GeneralSettingsV6":{"type":"object","properties":{"agent_upgrade_notifications_enabled":{"type":"boolean"},"api_session_timeout_minutes":{"type":"integer","description":"Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.\nSetting the API session timeout to a high number of minutes increases the risk of unauthorized use of View API.\nUse caution when you allow an idle session to persist for a long time.","format":"int32","example":30},"application_sso_timeout_minutes":{"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_domains_ordering":{"type":"array","description":"The domains in specified order is sent to Horizon client when send domains is enabled.","example":["HZN","HZNTWOWAY"],"items":{"type":"string","description":"The domains in specified order is sent to Horizon client when send domains is enabled.","example":"[\"HZN\",\"HZNTWOWAY\"]"}},"client_folders_enabled":{"type":"boolean","description":"Flag conveying if client gets the ability to add/edit/display folders","example":true},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the Connection Server takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if clientMaxSessionTimeoutPolicy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"disconnect_message":{"type":"string","description":"The message to be displayed at the time of forced disconnect."},"disconnect_warning_message":{"type":"string","description":"The warning to be displayed before forcibly disconnect timeout."},"disconnect_warning_time":{"type":"integer","description":"The time (in minutes) prior to the forcibly disconnect timeout when a warning message would be shown by the client","format":"int32","example":30},"display_pre_login_admin_banner":{"type":"boolean","description":"Enable/disable pre login message pop up before logging into Horizon admin console","example":false},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"password_policy_error_message":{"type":"string","description":"The Error message that needs to be displayed at the client for end users incase resetting password fails because of policy violations","example":"The new password does not meet the password policy requirements."},"pre_login_admin_banner_header":{"type":"string","description":"The warning pop up header to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"Attention"},"pre_login_admin_banner_message":{"type":"string","description":"The warning pop up message to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"On proceeding, you agree that you fully comply with the laws of this organisation."},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"restricted_client_warn_message":{"type":"string","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server.","example":"This client version is not recommended. Please upgrade to the latest version."},"sso_discard_connection_type":{"type":"string","description":"The type of connection for which the single sign on discard timeout minutes should be applied.\n* NONE: Indicates the connections from client devices on neither private networks nor non-private networks.\n* INTERNAL: Indicates the connections from client devices on private networks.\n* EXTERNAL: Indicates the connections from client devices on non-private networks.\n* BOTH: Indicates the connections from client devices both on private and non-private networks.","example":"BOTH","enum":["NONE","INTERNAL","EXTERNAL","BOTH"]},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Connection Server.","example":false}},"description":"Information related to General Settings."},"GeneralSettingsV7":{"type":"object","properties":{"agent_upgrade_notifications_enabled":{"type":"boolean"},"api_session_timeout_minutes":{"type":"integer","description":"Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.\nSetting the API session timeout to a high number of minutes increases the risk of unauthorized use of View API.\nUse caution when you allow an idle session to persist for a long time.","format":"int32","example":30},"application_sso_timeout_minutes":{"type":"integer","description":"The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.","format":"int32","example":30},"application_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"ENABLED","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.","example":false},"client_domains_ordering":{"type":"array","description":"The domains in specified order is sent to Horizon client when send domains is enabled.","example":["HZN","HZNTWOWAY"],"items":{"type":"string","description":"The domains in specified order is sent to Horizon client when send domains is enabled.","example":"[\"HZN\",\"HZNTWOWAY\"]"}},"client_folders_enabled":{"type":"boolean","description":"Flag conveying if client gets the ability to add/edit/display folders","example":true},"client_idle_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can be idle before the Connection Server takes measure to protect the session.","format":"int32","example":300},"client_idle_session_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"NEVER","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","description":"Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if clientMaxSessionTimeoutPolicy is set to TIMEOUT_AFTER.","format":"int32","example":300},"client_max_session_timeout_policy":{"type":"string","description":"Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.\n* TIMEOUT_AFTER: The timeout is set for a configurable time.\n* NEVER: The timeout has been disabled.","example":"TIMEOUT_AFTER","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","description":"Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.","format":"int32","example":300},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"disconnect_message":{"type":"string","description":"The message to be displayed at the time of forced disconnect."},"disconnect_warning_message":{"type":"string","description":"The warning to be displayed before forcibly disconnect timeout."},"disconnect_warning_time":{"type":"integer","description":"The time (in minutes) prior to the forcibly disconnect timeout when a warning message would be shown by the client","format":"int32","example":30},"display_pre_login_admin_banner":{"type":"boolean","description":"Enable/disable pre login message pop up before logging into Horizon admin console","example":false},"display_pre_login_message":{"type":"boolean","description":"Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.","example":false},"display_warning_before_forced_logoff":{"type":"boolean","description":"Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.","example":true},"enable_automatic_status_updates":{"type":"boolean","description":"Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.","example":true},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.","example":false},"enable_multi_factor_re_authentication":{"type":"boolean","description":"Enables 2 factor re-authentication after idle session timeout.","example":false},"enable_sending_domain_list":{"type":"boolean","description":"Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.","example":false},"enable_server_in_single_user_mode":{"type":"boolean","description":"Permits RDSServer operating systems to be used for non-RDS Machines.","example":true},"forced_logoff_message":{"type":"string","description":"The warning to be displayed before logging off the user.","example":"The system will shut down shortly. Please save your work."},"forced_logoff_timeout_minutes":{"type":"integer","description":"The time to wait after the warning is displayed and before logging off the user.","format":"int32","example":3},"helpdesk_app_privacy":{"type":"string","description":"Controls visibility of application file names. If set to ENABLED, only application process IDs are visible instead of file names. Default is DISABLED (file names are visible).\n* DISABLED: Helpdesk App Privacy is disabled. Application file names are visible.\n* ENABLED: Helpdesk App Privacy is enabled. Application file names are hidden; only process IDs are shown.","example":"DISABLED","enum":["DISABLED","ENABLED"]},"hide_domain_list_in_client":{"type":"boolean","description":"Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\\\\user when logging in.","example":true},"hide_server_information_in_client":{"type":"boolean","description":"Indicates whether to hide the server URL in the Horizon client user interface.","example":false},"machine_sso_timeout_minutes":{"type":"integer","description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.","format":"int32","example":300},"machine_sso_timeout_policy":{"type":"string","description":"Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.\n* DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.\n* DISABLED: Single sign on is disabled.\n* ENABLED: Single sign on is enabled.","example":"DISABLED_AFTER","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"password_policy_error_message":{"type":"string","description":"The Error message that needs to be displayed at the client for end users incase resetting password fails because of policy violations","example":"The new password does not meet the password policy requirements."},"pre_login_admin_banner_header":{"type":"string","description":"The warning pop up header to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"Attention"},"pre_login_admin_banner_message":{"type":"string","description":"The warning pop up message to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"On proceeding, you agree that you fully comply with the laws of this organisation."},"pre_login_message":{"type":"string","description":"Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.","example":"Disclaimer : This server is being monitored for suspicious activity."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV2"}},"restricted_client_data_v3":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/components/schemas/RestrictedClientDataV3"}},"restricted_client_message":{"type":"string","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server.","example":"The system does not support this version of the Horizon client."},"restricted_client_warn_message":{"type":"string","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server.","example":"This client version is not recommended. Please upgrade to the latest version."},"sso_discard_connection_type":{"type":"string","description":"The type of connection for which the single sign on discard timeout minutes should be applied.\n* NONE: Indicates the connections from client devices on neither private networks nor non-private networks.\n* INTERNAL: Indicates the connections from client devices on private networks.\n* EXTERNAL: Indicates the connections from client devices on non-private networks.\n* BOTH: Indicates the connections from client devices both on private and non-private networks.","example":"BOTH","enum":["NONE","INTERNAL","EXTERNAL","BOTH"]},"store_cal_on_client":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.","example":false},"store_cal_on_connection_server":{"type":"boolean","description":"Determines whether or not to store the RDS Per Device Client Access License on Connection Server.","example":false}},"description":"Information related to General Settings."},"GenericCapacityProviderCreateSpec":{"type":"object","properties":{"auth_base_data":{"$ref":"#/components/schemas/AuthBaseDataCreateSpec"},"auth_method":{"type":"string","description":"Authentication method for the capacity provider.\n* USERNAME_PASSWORD: Username and password auth.\n* ROLE_BASED: Role based auth.\n* ACCESS_TOKEN: Access token auth","enum":["USERNAME_PASSWORD","ROLE_BASED","ACCESS_TOKEN"]},"delete_limit":{"type":"integer","description":"Maximum concurrent delete operations to be executed on the capacity provider.","format":"int32","example":10},"deployment_type":{"type":"string","description":"Deployment type of the capacity provider.\n* PRISM: Prism capacity provider (Nutanix).","example":"PRISM","enum":["PRISM"]},"display_name":{"type":"string","description":"Display name of the capacity provider.","example":"capacity-provider-1"},"provisioning_limit":{"type":"integer","description":"Maximum concurrent provisioning operations to be executed on the capacity provider.","format":"int32","example":10},"region":{"type":"string","description":"Capacity provider's region. This is required if the type is set to AWS_CORE","example":"us-west-2"},"token_base_data":{"$ref":"#/components/schemas/TokenBaseDataCreateSpec"}},"description":"Generic capacity provider."},"GenericCapacityProviderInfo":{"type":"object","properties":{"auth_base_data":{"$ref":"#/components/schemas/AuthBaseDataInfo"},"auth_method":{"type":"string","description":"Authentication method for the capacity provider.\n* USERNAME_PASSWORD: Username and password auth.\n* ROLE_BASED: Role based auth.\n* ACCESS_TOKEN: Access token auth","enum":["USERNAME_PASSWORD","ROLE_BASED","ACCESS_TOKEN"]},"delete_limit":{"type":"integer","description":"Maximum concurrent delete operations to be executed on the capacity provider.","format":"int32","example":10},"deployment_type":{"type":"string","description":"Deployment type of the capacity provider.\n* PRISM: Prism capacity provider (Nutanix).","example":"PRISM","enum":["PRISM"]},"display_name":{"type":"string","description":"Display name of the capacity provider.","example":"capacity-provider-1"},"id":{"type":"string","description":"Unique identifier associated with the capacity provider.","example":"9f99b25e-da7a-424f-b234-b21d63799f8c"},"provisioning_limit":{"type":"integer","description":"Maximum concurrent provisioning operations to be executed on the capacity provider.","format":"int32","example":10},"region":{"type":"string","description":"Capacity provider's region. This is required if the type is set to AWS_CORE","example":"us-west-2"},"token_base_data":{"$ref":"#/components/schemas/TokenBaseDataInfo"}},"description":"Generic capacity provider."},"GenericCapacityProviderUpdateSpec":{"type":"object","properties":{"auth_base_data":{"$ref":"#/components/schemas/AuthBaseDataUpdateSpec"},"auth_method":{"type":"string","description":"Authentication method for the capacity provider.\n* USERNAME_PASSWORD: Username and password auth.\n* ROLE_BASED: Role based auth.\n* ACCESS_TOKEN: Access token auth","enum":["USERNAME_PASSWORD","ROLE_BASED","ACCESS_TOKEN"]},"delete_limit":{"type":"integer","description":"Maximum concurrent delete operations to be executed on the capacity provider.","format":"int32","example":10},"display_name":{"type":"string","description":"Display name of the capacity provider.","example":"capacity-provider-1"},"provisioning_limit":{"type":"integer","description":"Maximum concurrent provisioning operations to be executed on the capacity provider.","format":"int32","example":10},"region":{"type":"string","description":"Capacity provider's region. This is required if the type is set to AWS_CORE","example":"us-west-2"},"token_base_data":{"$ref":"#/components/schemas/TokenBaseDataUpdateSpec"}},"description":"Generic capacity provider."},"GenericCapacityProviderV2CreateSpec":{"type":"object","properties":{"auth_base_data":{"$ref":"#/components/schemas/AuthBaseDataCreateSpec"},"auth_method":{"type":"string","description":"Authentication method for the capacity provider.\n* USERNAME_PASSWORD: Username and password auth.\n* ROLE_BASED: Role based auth.\n* ACCESS_TOKEN: Access token auth","enum":["USERNAME_PASSWORD","ROLE_BASED","ACCESS_TOKEN"]},"delete_limit":{"type":"integer","description":"Maximum concurrent delete operations to be executed on the capacity provider.","format":"int32","example":10},"deployment_type":{"type":"string","description":"Deployment type of the capacity provider.\n* PRISM: Prism capacity provider (Nutanix).","example":"PRISM","enum":["PRISM"]},"display_name":{"type":"string","description":"Display name of the capacity provider.","example":"capacity-provider-1"},"power_ops_ramp_factor":{"type":"integer","description":"Capacity Provider - Maximum concurrent Power operations to be executed on the capacity provider.","format":"int32","example":5},"provisioning_limit":{"type":"integer","description":"Maximum concurrent provisioning operations to be executed on the capacity provider.","format":"int32","example":10},"refit_ramp_factor":{"type":"integer","description":"Capacity Provider - Maximum concurrent Maintenance operations to be executed on the capacity provider.","format":"int32","example":3},"region":{"type":"string","description":"Capacity provider's region. This is required if the type is set to AWS_CORE","example":"us-west-2"},"token_base_data":{"$ref":"#/components/schemas/TokenBaseDataCreateSpec"}},"description":"Generic capacity provider V2 with additional ramp/damp factors."},"GenericCapacityProviderV2Info":{"type":"object","properties":{"auth_base_data":{"$ref":"#/components/schemas/AuthBaseDataInfo"},"auth_method":{"type":"string","description":"Authentication method for the capacity provider.\n* USERNAME_PASSWORD: Username and password auth.\n* ROLE_BASED: Role based auth.\n* ACCESS_TOKEN: Access token auth","enum":["USERNAME_PASSWORD","ROLE_BASED","ACCESS_TOKEN"]},"delete_limit":{"type":"integer","description":"Maximum concurrent delete operations to be executed on the capacity provider.","format":"int32","example":10},"deployment_type":{"type":"string","description":"Deployment type of the capacity provider.\n* PRISM: Prism capacity provider (Nutanix).","example":"PRISM","enum":["PRISM"]},"display_name":{"type":"string","description":"Display name of the capacity provider.","example":"capacity-provider-1"},"id":{"type":"string","description":"Unique identifier associated with the capacity provider.","example":"9f99b25e-da7a-424f-b234-b21d63799f8c"},"power_ops_ramp_factor":{"type":"integer","description":"Capacity Provider - Maximum concurrent Power operations to be executed on the capacity provider.","format":"int32","example":5},"provisioning_limit":{"type":"integer","description":"Maximum concurrent provisioning operations to be executed on the capacity provider.","format":"int32","example":10},"refit_ramp_factor":{"type":"integer","description":"Capacity Provider - Maximum concurrent Maintenance operations to be executed on the capacity provider.","format":"int32","example":3},"region":{"type":"string","description":"Capacity provider's region. This is required if the type is set to AWS_CORE","example":"us-west-2"},"token_base_data":{"$ref":"#/components/schemas/TokenBaseDataInfo"}},"description":"Generic capacity provider V2 with additional ramp/damp factors."},"GenericCapacityProviderV2UpdateSpec":{"type":"object","properties":{"auth_base_data":{"$ref":"#/components/schemas/AuthBaseDataUpdateSpec"},"auth_method":{"type":"string","description":"Authentication method for the capacity provider.\n* USERNAME_PASSWORD: Username and password auth.\n* ROLE_BASED: Role based auth.\n* ACCESS_TOKEN: Access token auth","enum":["USERNAME_PASSWORD","ROLE_BASED","ACCESS_TOKEN"]},"delete_limit":{"type":"integer","description":"Maximum concurrent delete operations to be executed on the capacity provider.","format":"int32","example":10},"display_name":{"type":"string","description":"Display name of the capacity provider.","example":"capacity-provider-1"},"power_ops_ramp_factor":{"type":"integer","description":"Capacity Provider - Maximum concurrent Power operations to be executed on the capacity provider.","format":"int32","example":5},"provisioning_limit":{"type":"integer","description":"Maximum concurrent provisioning operations to be executed on the capacity provider.","format":"int32","example":10},"refit_ramp_factor":{"type":"integer","description":"Capacity Provider - Maximum concurrent Maintenance operations to be executed on the capacity provider.","format":"int32","example":3},"region":{"type":"string","description":"Capacity provider's region. This is required if the type is set to AWS_CORE","example":"us-west-2"},"token_base_data":{"$ref":"#/components/schemas/TokenBaseDataUpdateSpec"}},"description":"Generic capacity provider V2 with additional ramp/damp factors."},"GlobalApplicationEntitlementCreateSpec":{"required":["federated_access_group_id","name"],"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used. Default value is true.","example":true},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement. The property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the global application entitlement. This can only be set to \"PCOIP\" or \"BLAST\". If this application's Farm's or desktop pool's allow_users_to_choose_protocol is set to false, then default_display_protocol must match that default_display_protocol of farm or desktop pool. Default value is \"PCOIP\".\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","example":"PCOIP","enum":["BLAST","PCOIP"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of global application entitlement.","example":"global application entitlement description"},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"The display name is the name that users will see when they connect using Horizon View Client. If display_name is left blank, it defaults to name.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"If value is set to true, this global application entitlement can be pre-launched. This property can be set to true only if multi_session_mode is set to \"DISABLED\".  Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the global application entitlement is enabled. Default value is true.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global application entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multi_session_mode":{"type":"string","description":"Multi-session mode for this entitlement. A global application entitlement launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates whether automatic session clean up is enabled. Default value is false.","example":true},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the global application entitlement.","example":"global-application-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this global application entitlement. This property cannot be set to true if use_home_site is set to false. Default value is false.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Default value of \"ALL_SITES\".\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used. Default value is false.","example":false}},"description":"Global Application Entitlement object to be created."},"GlobalApplicationEntitlementCreateSpecV2":{"required":["federated_access_group_id","name"],"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used. Default value is true.","example":true},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement. The property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the global application entitlement. This can only be set to \"PCOIP\" or \"BLAST\". If this application's Farm's or desktop pool's allow_users_to_choose_protocol is set to false, then default_display_protocol must match that default_display_protocol of farm or desktop pool. Default value is \"PCOIP\".\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","example":"PCOIP","enum":["BLAST","PCOIP"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of global application entitlement.","example":"global application entitlement description"},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"The display name is the name that users will see when they connect using Horizon View Client. If display_name is left blank, it defaults to name.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"If value is set to true, this global application entitlement can be pre-launched. This property can be set to true only if multi_session_mode is set to \"DISABLED\".  Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the global application entitlement is enabled. Default value is true.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global application entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multi_session_mode":{"type":"string","description":"Multi-session mode for this entitlement. A global application entitlement launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates whether automatic session clean up is enabled. Default value is false.","example":true},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the global application entitlement.","example":"global-application-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this global application entitlement. This property cannot be set to true if use_home_site is set to false. Default value is false.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Default value of \"ALL_SITES\".\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used. Default value is false.","example":false}},"description":"Global Application Entitlement object to be created."},"GlobalApplicationEntitlementCreateSpecV3":{"required":["federated_access_group_id","name"],"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch.Default value is false.<br>","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used. Default value is true.","example":true},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement. The property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the global application entitlement. This can only be set to \"PCOIP\" or \"BLAST\". If this application's Farm's or desktop pool's allow_users_to_choose_protocol is set to false, then default_display_protocol must match that default_display_protocol of farm or desktop pool. Default value is \"PCOIP\".\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","example":"PCOIP","enum":["BLAST","PCOIP"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of global application entitlement.","example":"global application entitlement description"},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"The display name is the name that users will see when they connect using Horizon View Client. If display_name is left blank, it defaults to name.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"If value is set to true, this global application entitlement can be pre-launched. This property can be set to true only if multi_session_mode is set to \"DISABLED\".  Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the global application entitlement is enabled. Default value is true.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global application entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multi_session_mode":{"type":"string","description":"Multi-session mode for this entitlement. A global application entitlement launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates whether automatic session clean up is enabled. Default value is false.","example":true},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the global application entitlement.","example":"global-application-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this global application entitlement. This property cannot be set to true if use_home_site is set to false. Default value is false.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Default value of \"ALL_SITES\".\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used. Default value is false.","example":false}},"description":"Global Application Entitlement object to be created."},"GlobalApplicationEntitlementCreateSpecV4":{"required":["entra_sso_enabled","federated_access_group_id","ignore_preferred_sites_with_high_load","name","use_preferred_sites"],"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch.Default value is false.<br>","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used. Default value is true.","example":true},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement. The property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the global application entitlement. This can only be set to \"PCOIP\" or \"BLAST\". If this application's Farm's or desktop pool's allow_users_to_choose_protocol is set to false, then default_display_protocol must match that default_display_protocol of farm or desktop pool. Default value is \"PCOIP\".\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","example":"PCOIP","enum":["BLAST","PCOIP"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of global application entitlement.","example":"global application entitlement description"},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"The display name is the name that users will see when they connect using Horizon View Client. If display_name is left blank, it defaults to name.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools. Default value is false.","example":false},"enable_pre_launch":{"type":"boolean","description":"If value is set to true, this global application entitlement can be pre-launched. This property can be set to true only if multi_session_mode is set to \"DISABLED\".  Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates whether the global application entitlement is enabled. Default value is true.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled","example":false},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global application entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"ignore_preferred_sites_with_high_load":{"type":"boolean","description":"Ignores preferred site(s) with high load during brokering flow","example":false},"multi_session_mode":{"type":"string","description":"Multi-session mode for this entitlement. A global application entitlement launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Default value is \"DISABLED\"\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates whether automatic session clean up is enabled. Default value is false.","example":true},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the global application entitlement.","example":"global-application-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this global application entitlement. This property cannot be set to true if use_home_site is set to false. Default value is false.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Default value of \"ALL_SITES\".\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used. Default value is false.","example":false},"use_preferred_sites":{"type":"boolean","description":"Enable preferred site(s) during brokering flow","example":false}},"description":"Global Application Entitlement object to be created."},"GlobalApplicationEntitlementInfo":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"application_data":{"$ref":"#/components/schemas/ApplicationData"},"application_icon_ids":{"type":"array","description":"Icons associated with the Global Application Entitlement","example":["98923489-102b-4ed3-953f-3dfe3d23e0fe","asa39i-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Icons associated with the Global Application Entitlement","example":"[\"98923489-102b-4ed3-953f-3dfe3d23e0fe\",\"asa39i-102b-4ed3-953f-3d23esan0fe\"]"}},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Application Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"local_application_pools_count":{"type":"integer","description":"Count of application pools local to this pod that are associated with this Global Application Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have application pools associated with this Global Application Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have application pools associated with this Global Application Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_application_pools_count":{"type":"integer","description":"Count of application pools on remote pods that are associated with this Global Application Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"shortcut_locations":{"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\nThe value must be set if categoryFolderName is provided.","example":["desktop"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\nThe value must be set if categoryFolderName is provided.","example":"[\"desktop\"]"}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Application Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Application Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Application Entitlement"},"GlobalApplicationEntitlementInfoV2":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"application_data":{"$ref":"#/components/schemas/ApplicationData"},"application_icon_ids":{"type":"array","description":"Icons associated with the Global Application Entitlement","example":["98923489-102b-4ed3-953f-3dfe3d23e0fe","asa39i-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Icons associated with the Global Application Entitlement","example":"[\"98923489-102b-4ed3-953f-3dfe3d23e0fe\",\"asa39i-102b-4ed3-953f-3d23esan0fe\"]"}},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global application entitlement.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Application Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"local_application_pools_count":{"type":"integer","description":"Count of application pools local to this pod that are associated with this Global Application Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have application pools associated with this Global Application Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have application pools associated with this Global Application Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_application_pools_count":{"type":"integer","description":"Count of application pools on remote pods that are associated with this Global Application Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Application Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Application Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Application Entitlement."},"GlobalApplicationEntitlementInfoV3":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"application_data":{"$ref":"#/components/schemas/ApplicationData"},"application_icon_ids":{"type":"array","description":"Icons associated with the Global Application Entitlement","example":["98923489-102b-4ed3-953f-3dfe3d23e0fe","asa39i-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Icons associated with the Global Application Entitlement","example":"[\"98923489-102b-4ed3-953f-3dfe3d23e0fe\",\"asa39i-102b-4ed3-953f-3d23esan0fe\"]"}},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global application entitlement.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Application Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"local_application_pools_count":{"type":"integer","description":"Count of application pools local to this pod that are associated with this Global Application Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have application pools associated with this Global Application Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have application pools associated with this Global Application Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_application_pools_count":{"type":"integer","description":"Count of application pools on remote pods that are associated with this Global Application Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Application Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Application Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Application Entitlement."},"GlobalApplicationEntitlementInfoV4":{"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true."},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"application_data":{"$ref":"#/components/schemas/ApplicationData"},"application_icon_ids":{"type":"array","description":"Icons associated with the Global Application Entitlement","example":["98923489-102b-4ed3-953f-3dfe3d23e0fe","asa39i-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Icons associated with the Global Application Entitlement","example":"[\"98923489-102b-4ed3-953f-3dfe3d23e0fe\",\"asa39i-102b-4ed3-953f-3d23esan0fe\"]"}},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global application entitlement.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Application Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"local_application_pools_count":{"type":"integer","description":"Count of application pools local to this pod that are associated with this Global Application Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have application pools associated with this Global Application Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have application pools associated with this Global Application Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_application_pools_count":{"type":"integer","description":"Count of application pools on remote pods that are associated with this Global Application Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Application Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Application Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Application Entitlement."},"GlobalApplicationEntitlementInfoV5":{"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true."},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"application_data":{"$ref":"#/components/schemas/ApplicationData"},"application_icon_ids":{"type":"array","description":"Icons associated with the Global Application Entitlement","example":["98923489-102b-4ed3-953f-3dfe3d23e0fe","asa39i-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Icons associated with the Global Application Entitlement","example":"[\"98923489-102b-4ed3-953f-3dfe3d23e0fe\",\"asa39i-102b-4ed3-953f-3d23esan0fe\"]"}},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global application entitlement.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Application Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"launch_id":{"type":"string","description":"Launch ID used by clients to connect to the pool."},"local_application_pools_count":{"type":"integer","description":"Count of application pools local to this pod that are associated with this Global Application Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have application pools associated with this Global Application Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have application pools associated with this Global Application Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_application_pools_count":{"type":"integer","description":"Count of application pools on remote pods that are associated with this Global Application Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Application Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Application Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Application Entitlement."},"GlobalApplicationEntitlementInfoV6":{"required":["entra_sso_enabled"],"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true."},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"application_data":{"$ref":"#/components/schemas/ApplicationData"},"application_icon_ids":{"type":"array","description":"Icons associated with the Global Application Entitlement","example":["98923489-102b-4ed3-953f-3dfe3d23e0fe","asa39i-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Icons associated with the Global Application Entitlement","example":"[\"98923489-102b-4ed3-953f-3dfe3d23e0fe\",\"asa39i-102b-4ed3-953f-3d23esan0fe\"]"}},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled","example":false},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global application entitlement.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Application Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"ignore_preferred_sites_with_high_load":{"type":"boolean","description":"Ignores preferred site(s) with high load during brokering flow","example":false},"launch_id":{"type":"string","description":"Launch ID used by clients to connect to the pool."},"local_application_pools_count":{"type":"integer","description":"Count of application pools local to this pod that are associated with this Global Application Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have application pools associated with this Global Application Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have application pools associated with this Global Application Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_application_pools_count":{"type":"integer","description":"Count of application pools on remote pods that are associated with this Global Application Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"use_preferred_sites":{"type":"boolean","description":"Enabled preferred site(s) during brokering flow","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Application Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Application Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Application Entitlement."},"GlobalApplicationEntitlementSummary":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"shortcut_locations":{"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\nThe value must be set if categoryFolderName is provided.","example":["desktop"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\nThe value must be set if categoryFolderName is provided.","example":"[\"desktop\"]"}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false}},"description":"Summary Information about Global Application Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalApplicationEntitlementSummaryV2":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global application entitlement.<br> Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false}},"description":"Summary Information about Global Application Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalApplicationEntitlementSummaryV3":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global application entitlement.<br> Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false}},"description":"Summary Information about Global Application Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalApplicationEntitlementSummaryV4":{"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global application entitlement.<br> Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false}},"description":"Summary Information about Global Application Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalApplicationEntitlementSummaryV5":{"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"application_data":{"$ref":"#/components/schemas/ApplicationData"},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global application entitlement.<br> Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Application Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"member_pods":{"type":"array","description":"Pods that have application pools associated with this Global Application Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have application pools associated with this Global Application Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Application Entitlement.","format":"int32","example":5}},"description":"Summary Information about Global Application Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalApplicationEntitlementSummaryV6":{"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"application_data":{"$ref":"#/components/schemas/ApplicationData"},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global application entitlement.<br> Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Application Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"launch_id":{"type":"string","description":"Launch ID used by clients to connect to the pool."},"member_pods":{"type":"array","description":"Pods that have application pools associated with this Global Application Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have application pools associated with this Global Application Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Application Entitlement.","format":"int32","example":5}},"description":"Summary Information about Global Application Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalApplicationEntitlementSummaryV7":{"required":["entra_sso_enabled"],"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the application pools that are associated with this Global Application Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"application_data":{"$ref":"#/components/schemas/ApplicationData"},"backup_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Application Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Application Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the application pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","enum":["BLAST","PCOIP"]},"description":{"type":"string","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global application entitlement description"},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enable_pre_launch":{"type":"boolean","description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"enabled":{"type":"boolean","description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled","example":false},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global application entitlement.<br> Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Application Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"ignore_preferred_sites_with_high_load":{"type":"boolean","description":"Ignores preferred site(s) with high load during brokering flow","example":false},"launch_id":{"type":"string","description":"Launch ID used by clients to connect to the pool."},"member_pods":{"type":"array","description":"Pods that have application pools associated with this Global Application Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have application pools associated with this Global Application Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multi_session_mode":{"type":"string","description":"Multi-session mode for the application pool. An application launched in multi-session mode does\nnot support reconnect behavior when user logs in from a different client instance.\nMulti-session mode should be disabled when pre-launch is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Application Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-application-entitlement"},"primary_gae_id":{"type":"string","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Application Entitlement.\nAll the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST"],"items":{"type":"string","description":"* PCOIP: PCoIP protocol.","example":"[\"PCOIP\",\"BLAST\"]","enum":["BLAST","PCOIP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"use_preferred_sites":{"type":"boolean","description":"Enabled preferred site(s) during brokering flow","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Application Entitlement.","format":"int32","example":5}},"description":"Summary Information about Global Application Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalApplicationEntitlementUpdateSpec":{"required":["default_display_protocol","display_name","enable_client_restrictions","enable_pre_launch","enabled","federated_access_group_id","multi_session_mode","multiple_session_auto_clean","name","require_home_site","scope","use_home_site"],"type":"object","properties":{"backup_gae_id":{"type":"string","description":"Global Application Entitlement that can be used as backup for this Global Application Entitlement.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement. The property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the global application entitlement. This can only be set to \"PCOIP\" or \"BLAST\". If this application's Farm's or desktop pool's allow_users_to_choose_protocol is set to false, then default_display_protocol must match that default_display_protocol of farm or desktop pool.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","example":"PCOIP","enum":["BLAST","PCOIP"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of global application entitlement.","example":"global application entitlement description"},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"The display name is the name that users will see when they connect using Horizon View Client. If display_name is left blank, it defaults to name.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools.","example":false},"enable_pre_launch":{"type":"boolean","description":"If value is set to true, this global application entitlement can be pre-launched. This property can be set to true only if multi_session_mode is set to \"DISABLED\".","example":false},"enabled":{"type":"boolean","description":"Indicates whether the global application entitlement is enabled.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global application entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multi_session_mode":{"type":"string","description":"Multi-session mode for this entitlement. A global application entitlement launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates whether automatic session clean up is enabled.","example":true},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the global application entitlement.","example":"global-application-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this global application entitlement. This property cannot be set to true if use_home_site is set to false.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.","example":false}},"description":"Global Application Entitlement object to be updated."},"GlobalApplicationEntitlementUpdateSpecV2":{"required":["default_display_protocol","display_name","enable_client_restrictions","enable_pre_launch","enabled","federated_access_group_id","multi_session_mode","multiple_session_auto_clean","name","require_home_site","scope","session_distribution_policy","use_home_site"],"type":"object","properties":{"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"backup_gae_id":{"type":"string","description":"Global Application Entitlement that can be used as backup for this Global Application Entitlement.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement. The property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the global application entitlement. This can only be set to \"PCOIP\" or \"BLAST\". If this application's Farm's or desktop pool's allow_users_to_choose_protocol is set to false, then default_display_protocol must match that default_display_protocol of farm or desktop pool.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","example":"PCOIP","enum":["BLAST","PCOIP"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of global application entitlement.","example":"global application entitlement description"},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"The display name is the name that users will see when they connect using Horizon View Client. If display_name is left blank, it defaults to name.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools.","example":false},"enable_pre_launch":{"type":"boolean","description":"If value is set to true, this global application entitlement can be pre-launched. This property can be set to true only if multi_session_mode is set to \"DISABLED\".","example":false},"enabled":{"type":"boolean","description":"Indicates whether the global application entitlement is enabled.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global application entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multi_session_mode":{"type":"string","description":"Multi-session mode for this entitlement. A global application entitlement launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates whether automatic session clean up is enabled.","example":true},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the global application entitlement.","example":"global-application-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this global application entitlement. This property cannot be set to true if use_home_site is set to false.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.","example":false}},"description":"Global Application Entitlement object to be updated."},"GlobalApplicationEntitlementUpdateSpecV3":{"required":["allow_users_to_choose_machines","default_display_protocol","display_name","enable_client_restrictions","enable_pre_launch","enabled","federated_access_group_id","multi_session_mode","multiple_session_auto_clean","name","require_home_site","scope","session_distribution_policy","use_home_site"],"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch.","example":false},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"backup_gae_id":{"type":"string","description":"Global Application Entitlement that can be used as backup for this Global Application Entitlement.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement. The property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the global application entitlement. This can only be set to \"PCOIP\" or \"BLAST\". If this application's Farm's or desktop pool's allow_users_to_choose_protocol is set to false, then default_display_protocol must match that default_display_protocol of farm or desktop pool.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","example":"PCOIP","enum":["BLAST","PCOIP"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of global application entitlement.","example":"global application entitlement description"},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"The display name is the name that users will see when they connect using Horizon View Client. If display_name is left blank, it defaults to name.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools.","example":false},"enable_pre_launch":{"type":"boolean","description":"If value is set to true, this global application entitlement can be pre-launched. This property can be set to true only if multi_session_mode is set to \"DISABLED\".","example":false},"enabled":{"type":"boolean","description":"Indicates whether the global application entitlement is enabled.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global application entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multi_session_mode":{"type":"string","description":"Multi-session mode for this entitlement. A global application entitlement launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates whether automatic session clean up is enabled.","example":true},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the global application entitlement.","example":"global-application-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this global application entitlement. This property cannot be set to true if use_home_site is set to false.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.","example":false}},"description":"Global Application Entitlement object to be updated."},"GlobalApplicationEntitlementUpdateSpecV4":{"required":["allow_users_to_choose_machines","default_display_protocol","display_name","enable_client_restrictions","enable_pre_launch","enabled","entra_sso_enabled","federated_access_group_id","ignore_preferred_sites_with_high_load","multi_session_mode","multiple_session_auto_clean","name","require_home_site","scope","session_distribution_policy","use_home_site","use_preferred_sites"],"type":"object","properties":{"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch.","example":false},"app_launch_limit_enabled":{"type":"boolean","description":"Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.<br>","example":false},"backup_gae_id":{"type":"string","description":"Global Application Entitlement that can be used as backup for this Global Application Entitlement.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement. The property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the global application entitlement. This can only be set to \"PCOIP\" or \"BLAST\". If this application's Farm's or desktop pool's allow_users_to_choose_protocol is set to false, then default_display_protocol must match that default_display_protocol of farm or desktop pool.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.","example":"PCOIP","enum":["BLAST","PCOIP"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of global application entitlement.","example":"global application entitlement description"},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"The display name is the name that users will see when they connect using Horizon View Client. If display_name is left blank, it defaults to name.","example":"global-application-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools.","example":false},"enable_pre_launch":{"type":"boolean","description":"If value is set to true, this global application entitlement can be pre-launched. This property can be set to true only if multi_session_mode is set to \"DISABLED\".","example":false},"enabled":{"type":"boolean","description":"Indicates whether the global application entitlement is enabled.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled","example":false},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global application entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"ignore_preferred_sites_with_high_load":{"type":"boolean","description":"Ignores preferred site(s) with high load during brokering flow","example":false},"multi_session_mode":{"type":"string","description":"Multi-session mode for this entitlement. A global application entitlement launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance.\n* DISABLED: Multi-session is not supported for this application.\n* ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.\n* ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.\n* ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.","example":"ENABLED_ENFORCED","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates whether automatic session clean up is enabled.","example":true},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the global application entitlement.","example":"global-application-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this global application entitlement. This property cannot be set to true if use_home_site is set to false.","example":false},"scope":{"type":"string","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global application entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.","example":false},"use_preferred_sites":{"type":"boolean","description":"Enabled preferred site(s) during brokering flow","example":false}},"description":"Global Application Entitlement object to be updated."},"GlobalDesktopEntitlementCreateSpec":{"required":["default_display_protocol","name","scope"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser. Default value is false.","example":true},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol. Default value is true.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines. Default value is false.","example":true},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud. Default value is false.","example":false},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Default value is false.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).This property has a default value of \"PCOIP\".\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of Global Desktop Entitlement.\n","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. Default value is false.","example":false},"display_machine_alias":{"type":"boolean","description":"Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\n Default value is false.","example":false},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf display_name is left blank, it defaults to name.\n","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.Default value is true.","example":true},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Default value is false.","example":false},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\n","example":"global-desktop-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Default value is false.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nThis property has a default value of \"ALL_SITES\".\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Default value is false.","example":false},"shortcut_locations":{"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if category_folder_name is provided.","example":["desktop"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if category_folder_name is provided.","example":"[\"desktop\"]"}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used. Default value is false.","example":false}},"description":"Global Desktop Entitlement object to be created."},"GlobalDesktopEntitlementCreateSpecV2":{"required":["default_display_protocol","federated_access_group_id","name","scope"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser. Default value is false.","example":true},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol. Default value is true.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines. Default value is false.","example":true},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud. Default value is false.","example":false},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Default value is false.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).This property has a default value of \"PCOIP\".\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of Global Desktop Entitlement.\n","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. Default value is false.","example":false},"display_machine_alias":{"type":"boolean","description":"Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\n Default value is false.","example":false},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf display_name is left blank, it defaults to name.\n","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.Default value is true.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Default value is false.","example":false},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\n","example":"global-desktop-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Default value is false.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nThis property has a default value of \"ALL_SITES\".\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Default value is false.","example":false},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used. Default value is false.","example":false}},"description":"Global Desktop Entitlement object to be created."},"GlobalDesktopEntitlementCreateSpecV3":{"required":["default_display_protocol","federated_access_group_id","name","scope"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser. Default value is false.","example":true},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol. Default value is true.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines. Default value is false.","example":true},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud. Default value is false.","example":false},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Default value is false.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).This property has a default value of \"PCOIP\".\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of Global Desktop Entitlement.\n","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. Default value is false.","example":false},"display_machine_alias":{"type":"boolean","description":"Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\n Default value is false.","example":false},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf display_name is left blank, it defaults to name.\n","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.Default value is true.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Default value is false.","example":false},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\n","example":"global-desktop-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Default value is false.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nThis property has a default value of \"ALL_SITES\".\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Default value is false.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used. Default value is false.","example":false}},"description":"Global Desktop Entitlement object to be created."},"GlobalDesktopEntitlementCreateSpecV4":{"required":["default_display_protocol","federated_access_group_id","name","scope"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser. Default value is false.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. Not applicable to dedicated user assignment. Default value is false.<br>","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol. Default value is true.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines. Default value is false.","example":true},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud. Default value is false.","example":false},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Default value is false.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).This property has a default value of \"PCOIP\".\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of Global Desktop Entitlement.\n","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. Default value is false.","example":false},"display_machine_alias":{"type":"boolean","description":"Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\n Default value is false.","example":false},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf display_name is left blank, it defaults to name.\n","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.Default value is true.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Default value is false.","example":false},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\n","example":"global-desktop-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Default value is false.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nThis property has a default value of \"ALL_SITES\".\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Default value is false.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used. Default value is false.","example":false}},"description":"Global Desktop Entitlement object to be created."},"GlobalDesktopEntitlementCreateSpecV5":{"required":["default_display_protocol","federated_access_group_id","name","scope"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser. Default value is false.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. Not applicable to dedicated user assignment. Default value is false.<br>","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol. Default value is true.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines. Default value is false.","example":true},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud. Default value is false.","example":false},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Default value is false.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).This property has a default value of \"PCOIP\".\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of Global Desktop Entitlement.\n","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. Default value is false.","example":false},"display_machine_alias":{"type":"boolean","description":"Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\n Default value is false.","example":false},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf display_name is left blank, it defaults to name.\n","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.Default value is true.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Default value is false.","example":false},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\n","example":"global-desktop-entitlement"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this global desktop entitlement. Default value is false.","example":false},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Default value is false.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nThis property has a default value of \"ALL_SITES\".\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Default value is false.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used. Default value is false.","example":false}},"description":"Global Desktop Entitlement object to be created."},"GlobalDesktopEntitlementCreateSpecV6":{"required":["default_display_protocol","entra_sso_enabled","federated_access_group_id","ignore_preferred_sites_with_high_load","name","scope","use_preferred_sites"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser. Default value is false.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. Not applicable to dedicated user assignment. Default value is false.<br>","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol. Default value is true.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines. Default value is false.","example":true},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud. Default value is false.","example":false},"cs_restriction_tags":{"type":"array","description":"List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server","example":["Internal","External"],"items":{"type":"string","description":"List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Default value is false.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).This property has a default value of \"PCOIP\".\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of Global Desktop Entitlement.\n","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client. Default value is false.","example":false},"display_machine_alias":{"type":"boolean","description":"Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\n Default value is false.","example":false},"display_name":{"maxLength":64,"minLength":0,"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf display_name is left blank, it defaults to name.\n","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Default value is false.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.Default value is true.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled","example":false},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"ignore_preferred_sites_with_high_load":{"type":"boolean","description":"Ignores preferred site(s) with high load during brokering flow","example":false},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Default value is false.","example":false},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\n","example":"global-desktop-entitlement"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this global desktop entitlement. Default value is false.","example":false},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Default value is false.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nThis property has a default value of \"ALL_SITES\".\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Default value is false.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used. Default value is false.","example":false},"use_preferred_sites":{"type":"boolean","description":"Enabled preferred site(s) during brokering flow","example":false}},"description":"Global Desktop Entitlement object to be created."},"GlobalDesktopEntitlementInfo":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"local_desktop_pools_count":{"type":"integer","description":"Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_desktop_pools_count":{"type":"integer","description":"Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"shortcut_locations":{"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if categoryFolderName is provided.","example":["desktop"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if categoryFolderName is provided.","example":"[\"desktop\"]"}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Desktop Entitlement"},"GlobalDesktopEntitlementInfoV2":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global desktop entitlement.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"local_desktop_pools_count":{"type":"integer","description":"Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_desktop_pools_count":{"type":"integer","description":"Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Desktop Entitlement."},"GlobalDesktopEntitlementInfoV3":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global desktop entitlement.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"local_desktop_pools_count":{"type":"integer","description":"Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_desktop_pools_count":{"type":"integer","description":"Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Desktop Entitlement."},"GlobalDesktopEntitlementInfoV4":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true.\nThis property will not be set for dedicated user assignment.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global desktop entitlement.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"local_desktop_pools_count":{"type":"integer","description":"Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_desktop_pools_count":{"type":"integer","description":"Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Desktop Entitlement."},"GlobalDesktopEntitlementInfoV5":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true.\nThis property will not be set for dedicated user assignment.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global desktop entitlement.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"local_desktop_pools_count":{"type":"integer","description":"Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this global desktop entitlement","example":false},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_desktop_pools_count":{"type":"integer","description":"Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Desktop Entitlement."},"GlobalDesktopEntitlementInfoV6":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true.\nThis property will not be set for dedicated user assignment.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global desktop entitlement.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"launch_id":{"type":"string","description":"Launch ID used by clients to connect to the pool."},"local_desktop_pools_count":{"type":"integer","description":"Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this global desktop entitlement","example":false},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_desktop_pools_count":{"type":"integer","description":"Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Desktop Entitlement."},"GlobalDesktopEntitlementInfoV7":{"required":["entra_sso_enabled"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true.\nThis property will not be set for dedicated user assignment.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled","example":false},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global desktop entitlement.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"ignore_preferred_sites_with_high_load":{"type":"boolean","description":"Ignores preferred site(s) with high load during brokering flow","example":false},"launch_id":{"type":"string","description":"Launch ID used by clients to connect to the pool."},"local_desktop_pools_count":{"type":"integer","description":"Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement.","format":"int32","example":2},"member_pods":{"type":"array","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"items":{"type":"string","description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"9238c-102b-4ed3-953f-3d23esan0fe\"]"}},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this global desktop entitlement","example":false},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"remote_desktop_pools_count":{"type":"integer","description":"Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement.","format":"int32","example":10},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"use_preferred_sites":{"type":"boolean","description":"Enabled preferred site(s) during brokering flow","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"user_or_group_site_override_count":{"type":"integer","description":"Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups).","format":"int32","example":2}},"description":"Information about Global Desktop Entitlement."},"GlobalDesktopEntitlementSummary":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"shortcut_locations":{"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if categoryFolderName is provided.","example":["desktop"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if categoryFolderName is provided.","example":"[\"desktop\"]"}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false}},"description":"Summary Information about Global Desktop Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalDesktopEntitlementSummaryV2":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global desktop entitlement.<br> Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false}},"description":"Summary Information about Global Desktop Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalDesktopEntitlementSummaryV3":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global desktop entitlement.<br> Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false}},"description":"Summary Information about Global Desktop Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalDesktopEntitlementSummaryV4":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true.\nThis property will not be set for dedicated user assignment.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global desktop entitlement.<br> Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false}},"description":"Summary Information about Global Desktop Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalDesktopEntitlementSummaryV5":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true.\nThis property will not be set for dedicated user assignment.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global desktop entitlement.<br> Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"member_pods":{"type":"array","description":"Pods that have desktops associated with this Global Entitlement.","example":false,"items":{"type":"string","description":"Pods that have desktops associated with this Global Entitlement.","example":"false"}},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this global desktop entitlement","example":false},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Desktop Entitlement.","format":"int32","example":5}},"description":"Summary Information about Global Desktop Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalDesktopEntitlementSummaryV6":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true.\nThis property will not be set for dedicated user assignment.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global desktop entitlement.<br> Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"launch_id":{"type":"string","description":"Launch ID used by clients to connect to the pool."},"member_pods":{"type":"array","description":"Pods that have desktops associated with this Global Entitlement.","example":false,"items":{"type":"string","description":"Pods that have desktops associated with this Global Entitlement.","example":"false"}},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this global desktop entitlement","example":false},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Desktop Entitlement.","format":"int32","example":5}},"description":"Summary Information about Global Desktop Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalDesktopEntitlementSummaryV7":{"required":["entra_sso_enabled"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions with allowMultipleSessionsPerUser\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true.\nThis property will not be set for dedicated user assignment.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"allow_users_to_choose_protocol":{"type":"boolean","description":"Indicates whether the users can choose the protocol used.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to choose display protocol with allowUsersToChooseProtocol.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"allow_users_to_reset_machines":{"type":"boolean","description":"Indicates whether users are allowed to reset/restart their machines.\nIf set to true, the desktop pools that are associated with this Global Desktop Entitlement\nmust also allow users to reset/restart machines with allowUsersToResetMachines.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"backup_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nUnset if the entitlement does not belong to a category.\nThis property can be used for sorting.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"dedicated":{"type":"boolean","description":"Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement.\nOtherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nMust be a protocol in the supportedDisplayProtocols list.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"type":"string","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"display_machine_alias":{"type":"boolean","description":"Decides the visibility of the machine alias to the user.\nThis property can be used for sorting.","example":true},"display_name":{"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled","example":false},"federated_access_group_id":{"type":"string","description":"This represents id of the federated access group associated with the global desktop entitlement.<br> Supported Filters: 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"group_count":{"type":"integer","description":"Count of groups that are associated with this Global Desktop Entitlement.","format":"int32","example":5},"id":{"type":"string","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"ignore_preferred_sites_with_high_load":{"type":"boolean","description":"Ignores preferred site(s) with high load during brokering flow","example":false},"launch_id":{"type":"string","description":"Launch ID used by clients to connect to the pool."},"member_pods":{"type":"array","description":"Pods that have desktops associated with this Global Entitlement.","example":false,"items":{"type":"string","description":"Pods that have desktops associated with this Global Entitlement.","example":"false"}},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"name":{"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\nThis property has a maximum length of 64 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"global-desktop-entitlement"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this global desktop entitlement","example":false},"primary_gde_id":{"type":"string","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"require_home_site":{"type":"boolean","description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol in supportedDisplayProtocols.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","example":["DESKTOP"],"items":{"type":"string","description":"* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","description":"The set of supported display protocols for the Global Desktop Entitlement.\nAll the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols .\nClients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.","example":["PCOIP","BLAST","RDP"],"items":{"type":"string","description":"* ULTRA: Pcoip ULTRA protocol.","example":"[\"PCOIP\",\"BLAST\",\"RDP\"]","enum":["BLAST","PCOIP","RDP","ULTRA"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"use_preferred_sites":{"type":"boolean","description":"Enabled preferred site(s) during brokering flow","example":false},"user_count":{"type":"integer","description":"Count of users that are associated with this Global Desktop Entitlement.","format":"int32","example":5}},"description":"Summary Information about Global Desktop Entitlement. <br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"GlobalDesktopEntitlementUpdateSpec":{"required":["allow_multiple_sessions_per_user","cloud_managed","default_display_protocol","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled","federated_access_group_id","multiple_session_auto_clean","name","require_home_site","scope","session_collaboration_enabled","use_home_site"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions.","example":true},"backup_gde_id":{"type":"string","description":"Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nThe property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of Global Desktop Entitlement.\n","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.","example":false},"display_machine_alias":{"type":"boolean","description":"Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\n","example":false},"display_name":{"maxLength":64,"minLength":1,"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\n","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.","example":false},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\n","example":"global-desktop-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this Global Desktop Entitlement.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.","example":false},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if category_folder_name is provided.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if category_folder_name is provided.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.","example":false}},"description":"Global Desktop Entitlement object to be updated."},"GlobalDesktopEntitlementUpdateSpecV2":{"required":["allow_multiple_sessions_per_user","cloud_managed","default_display_protocol","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled","federated_access_group_id","multiple_session_auto_clean","name","require_home_site","scope","session_collaboration_enabled","session_distribution_policy","use_home_site"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions.","example":true},"backup_gde_id":{"type":"string","description":"Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nThe property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of Global Desktop Entitlement.\n","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.","example":false},"display_machine_alias":{"type":"boolean","description":"Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\n","example":false},"display_name":{"maxLength":64,"minLength":1,"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\n","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.","example":false},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\n","example":"global-desktop-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this Global Desktop Entitlement.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if category_folder_name is provided.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if category_folder_name is provided.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.","example":false}},"description":"Global Desktop Entitlement object to be updated."},"GlobalDesktopEntitlementUpdateSpecV3":{"required":["allow_multiple_sessions_per_user","cloud_managed","default_display_protocol","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled","federated_access_group_id","multiple_session_auto_clean","name","require_home_site","scope","session_collaboration_enabled","session_distribution_policy","use_home_site"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. Not applicable to dedicated global desktop entitlement, mandatory for non dedicated global desktop entitlement.","example":false},"backup_gde_id":{"type":"string","description":"Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nThe property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of Global Desktop Entitlement.\n","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.","example":false},"display_machine_alias":{"type":"boolean","description":"Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\n","example":false},"display_name":{"maxLength":64,"minLength":1,"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\n","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.","example":false},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\n","example":"global-desktop-entitlement"},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this Global Desktop Entitlement.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if category_folder_name is provided.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if category_folder_name is provided.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.","example":false}},"description":"Global Desktop Entitlement object to be updated."},"GlobalDesktopEntitlementUpdateSpecV4":{"required":["allow_multiple_sessions_per_user","cloud_managed","default_display_protocol","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled","federated_access_group_id","multiple_session_auto_clean","name","pcoip_ultra_protocol_enabled","require_home_site","scope","session_collaboration_enabled","session_distribution_policy","use_home_site"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. Not applicable to dedicated global desktop entitlement, mandatory for non dedicated global desktop entitlement.","example":false},"backup_gde_id":{"type":"string","description":"Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nThe property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of Global Desktop Entitlement.\n","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.","example":false},"display_machine_alias":{"type":"boolean","description":"Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\n","example":false},"display_name":{"maxLength":64,"minLength":1,"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\n","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.","example":true},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.","example":false},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\n","example":"global-desktop-entitlement"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this global desktop entitlement","example":false},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this Global Desktop Entitlement.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if category_folder_name is provided.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if category_folder_name is provided.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.","example":false}},"description":"Global Desktop Entitlement object to be updated."},"GlobalDesktopEntitlementUpdateSpecV5":{"required":["allow_multiple_sessions_per_user","cloud_managed","default_display_protocol","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled","entra_sso_enabled","federated_access_group_id","ignore_preferred_sites_with_high_load","multiple_session_auto_clean","name","pcoip_ultra_protocol_enabled","require_home_site","scope","session_collaboration_enabled","session_distribution_policy","use_home_site","use_preferred_sites"],"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","description":"Indicates whether users can have multiple sessions when accessed from different client devices,\nthis is also called Class room mode and applicable only to floating user assignment.\nIf value is set to true, the desktop pools that are associated with this Global Desktop Entitlement \nmust also allow users to have multiple sessions.","example":true},"allow_users_to_choose_machines":{"type":"boolean","description":"Indicates whether the users can specify the machine for session launch. Not applicable to dedicated global desktop entitlement, mandatory for non dedicated global desktop entitlement.","example":false},"backup_gde_id":{"type":"string","description":"Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe"},"category_folder_name":{"pattern":"^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\\\].*|PRN[\\\\].*|AUX[\\\\].*|NUL[\\\\].*|COM[1-9][\\\\].*|LPT[1-9][\\\\].*)$)(?!(?:.*[\\\\]CON|.*[\\\\]PRN|.*[\\\\]AUX|.*[\\\\]NUL|.*[\\\\]COM[1-9]|.*[\\\\]LPT[1-9])$)(?!(?:.*[\\\\]CON[\\\\].*|.*[\\\\]PRN[\\\\].*|.*[\\\\]AUX[\\\\].*|.*[\\\\]NUL[\\\\].*|.*[\\\\]COM[1-9][\\\\].*|.*[\\\\]LPT[1-9][\\\\].*)$))([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64}\\\\){0,3}([^\\\"#$%&'()*+,.\\\\\\/:;<=>?@^`{|}~]{1,64})$|^/$","type":"string","description":"Name of the category folder in the user's OS containing a shortcut to the entitlement.\nThe property will not be set if the entitlement does not belong to a category.","example":"dir1\\dir2\\dir3\\dir4"},"cloud_managed":{"type":"boolean","description":"Indicates whether this global desktop entitlement is managed from cloud.","example":false},"cs_restriction_tags":{"type":"array","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":["Internal","External"],"items":{"type":"string","description":"Connection server restrictions. This is a list of tags that access to the entitlement is restricted to.\nNo list means that the entitlement can be accessed from any connection server.","example":"[\"Internal\",\"External\"]"}},"default_display_protocol":{"type":"string","description":"The default display protocol for the Global Desktop Entitlement.\nClients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value,\nnot the value specified directly on the desktop pool to which they connect (if different).\n* BLAST: BLAST protocol.\n* PCOIP: PCoIP protocol.\n* RDP: Microsoft Remote Desktop Protocol.\n* ULTRA: Pcoip ULTRA protocol.","example":"PCOIP","enum":["BLAST","PCOIP","RDP","ULTRA"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of Global Desktop Entitlement.\n","example":"global desktop entitlement description"},"display_assigned_machine_name":{"type":"boolean","description":"Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\nIf no machine is assigned to the user then \"display_name (No machine assigned)\" will be displayed in the client.","example":false},"display_machine_alias":{"type":"boolean","description":"Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client.\nThis is applicable for dedicated Global Desktop Entitlements only.\n","example":false},"display_name":{"maxLength":64,"minLength":1,"type":"string","description":"Name that users will see when they connect using Horizon Client.\nIf the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.\n","example":"global-desktop-entitlement"},"enable_client_restrictions":{"type":"boolean","description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.","example":false},"enabled":{"type":"boolean","description":"Indicates if this Global Desktop Entitlement is enabled.","example":true},"entra_sso_enabled":{"type":"boolean","description":"Indicates whether Entra SSO is enabled","example":false},"federated_access_group_id":{"type":"string","description":"ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.","example":"310927ee-1195-44c3-b877-5b194b4b4ea8"},"ignore_preferred_sites_with_high_load":{"type":"boolean","description":"Ignores preferred site(s) with high load during brokering flow","example":false},"multiple_session_auto_clean":{"type":"boolean","description":"Indicates if automatic session clean up is enabled.\nThis cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.","example":false},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Unique name used to identify the Global Desktop Entitlement.\n","example":"global-desktop-entitlement"},"pcoip_ultra_protocol_enabled":{"type":"boolean","description":"Indicates if Pcoip ULTRA display protocol is enabled for this global desktop entitlement","example":false},"require_home_site":{"type":"boolean","description":"Indicates whether it should fail if a home site isn't defined for this Global Desktop Entitlement.","example":false},"scope":{"type":"string","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\n* ALL_SITES: All Sites Policy: Any pod can be used for this action.\nIf this policy is for visibility, search for existing session will span all pods in LMV set.\nIf this policy is for placement, session can be placed on any pod in LMV set.\n* WITHIN_POD: Within POD Policy: Local pod will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only in local pod.\nIf this policy is for placement, session will always be placed on local pod.\n* WITHIN_SITE: Within Site Policy: Site will be used for this policy.\nIf this policy is for visibility, search for existing session will happen only from site.\nIf this policy is for placement, session will be placed on site.","example":"ALL_SITES","enum":["ALL_SITES","WITHIN_POD","WITHIN_SITE"]},"session_collaboration_enabled":{"type":"boolean","description":"Session collaboration allows a user to share their remote session with other users.\nBlast must be configured as a supported protocol.\nIndicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.","example":false},"session_distribution_policy":{"type":"string","description":"Session distribution policy to be used for this global desktop entitlement\n* LOAD: Load index based load distribution.\n* NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.\n* SESSION: Session count based load distribution.","example":"NONE","enum":["LOAD","NONE","SESSION"]},"shortcut_locations_v2":{"uniqueItems":true,"type":"array","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if category_folder_name is provided.","example":["DESKTOP"],"items":{"type":"string","description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\nThe value must be set if category_folder_name is provided.\n* START_MENU: Creates a Windows Start menu shortcut on the Windows client device.\n* DESKTOP: Creates a shortcut on the desktop on the Windows client device.","example":"[\"DESKTOP\"]","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used.","example":false},"use_preferred_sites":{"type":"boolean","description":"Enabled preferred site(s) during brokering flow","example":false}},"description":"Global Desktop Entitlement object to be updated."},"GlobalDesktopEntitlementsMetricsInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the global desktop entitlement.","example":"6f93b3a5-e7d0-4ad6-a1e3-48268dd1ed80"},"local_capacity":{"type":"integer","description":"Number of machines in each local desktop pools belongs to the Global Desktop Entitlement.","format":"int32","example":10},"local_connected_sessions":{"type":"integer","description":"Number of connected sessions in local desktop pools belongs to the Global Desktop Entitlement.","format":"int32","example":30},"local_occupancy_count":{"type":"integer","description":"Occupancy count for the desktop pools belongs to the Global Desktop Entitlement.\n* For dedicated assignment desktop pool, it is the number of assigned machine count.\n* For floating assignment desktop pool, it is the summation of the connected and disconnected sessions.","format":"int32","example":80}},"description":"Metrics related to global desktop entitlements"},"GlobalSessionActionSpec":{"required":["ids","pod_id"],"type":"object","properties":{"ids":{"uniqueItems":true,"type":"array","description":"IDs of the sessions on which action is to be performed.","example":["816d44cb-b486-3c97-adcb-cf3806d53657","414927f3-1a3b-3e4c-81b3-d39602f634dc"],"items":{"type":"string","description":"IDs of the sessions on which action is to be performed.","example":"[\"816d44cb-b486-3c97-adcb-cf3806d53657\",\"414927f3-1a3b-3e4c-81b3-d39602f634dc\"]"}},"pod_id":{"type":"string","description":"ID of the hosting pod for the sessions.","example":"54c122e0-d6b5-476c-af91-fd00392e5983"}},"description":"Information required to perform an action on global sessions."},"GlobalSessionClientData":{"type":"object","properties":{"address":{"type":"string","description":"IP Address of the client machine for the session.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"127.0.0.1"},"location_id":{"type":"string","description":"Client location for the session.\nSupported Filters: 'Equals'.","example":"ac9be3c194f62043b274058102d3ce39048ec9c26d0e2c8b8ea475909d497f79"},"name":{"type":"string","description":"Client machine name for the session.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"Client1"},"type":{"type":"string","description":"Client type for the session.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* WINDOWS: Client type is Windows client.\n* MAC: Client type is Mac client.\n* HTMLACCESS: Client type is Web client.\n* LINUX: Client type is Linux client.\n* IOS: Client type is iOS client.\n* ANDROID: Client type is Android client.\n* OTHER: Client type is other.","example":"WINDOWS","enum":["WINDOWS","MAC","HTMLACCESS","LINUX","IOS","ANDROID","OTHER"]},"version":{"type":"string","description":"Client version for the session.\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"5.4.0"}},"description":"Client data for the session."},"GlobalSessionInfo":{"type":"object","properties":{"agent_version":{"type":"string","description":"Version of the agent for the session. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"8.3.0"},"application_names":{"uniqueItems":true,"type":"array","description":"Names of the applications launched in the session. <br>It will only be set when session_type is APPLICATION. \nSupported Filters: 'Contains'.","example":["Calculator","Paint"],"items":{"type":"string","description":"Names of the applications launched in the session. <br>It will only be set when session_type is APPLICATION. \nSupported Filters: 'Contains'.","example":"[\"Calculator\",\"Paint\"]"}},"broker_user_id":{"type":"string","description":"SID for the broker user associated with the session. \nIt will be unset for non-broker sessions. \nSupported Filters: 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"brokered_remotely":{"type":"boolean","description":"Indicates whether the session is brokered from a remote pod. <br>This will be set only if the Horizon View agent where the session resides is version 6.0 or later. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"brokering_pod_id":{"type":"string","description":"ID of the pod that brokered the session.","example":"399eecf2-66ab-4a8f-94d9-b290fda35e4f"},"client_data":{"$ref":"#/components/schemas/GlobalSessionClientData"},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool for the desktop session. \nThis will be unset if the session is not brokered through a desktop pool, such as for direct console access. \nThis will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"53c4de7c-ae7c-471d-a8d0-3489cb9741d7"},"desktop_pool_or_farm_name":{"type":"string","description":"Display name of the desktop pool or name of the farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. \nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Farm-Name"},"desktop_pool_or_farm_source":{"type":"string","description":"Source of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"VIRTUAL_CENTER","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"desktop_pool_or_farm_type":{"type":"string","description":"Type of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"disconnected_time":{"type":"integer","description":"Epoch time in milliseconds, when the session was last disconnected. \nThis will be unset if the machine on which the session resides has an error state, or if the session has never been disconnected. \nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1621512686000},"farm_id":{"type":"string","description":"ID of the farm for the RDS desktop or application session. \nThis will be unset if the session is not brokered through a farm, such as for direct console access. \nThis will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"250f68e8-9e7e-4578-b8fa-25864c63f168"},"federated_access_group_ids":{"uniqueItems":true,"type":"array","description":"IDs of the federated access groups associated with the session. <br>This represents the federated access groups associated with the global desktop entitlement or global application entitlements used to launch the session. Supported Filters : 'Contains'.","example":["310927ee-1195-44c3-b877-5b194b4b4ea8","78669598-45b6-44a3-aa0d-11b16d45ab73"],"items":{"type":"string","description":"IDs of the federated access groups associated with the session. <br>This represents the federated access groups associated with the global desktop entitlement or global application entitlements used to launch the session. Supported Filters : 'Contains'.","example":"[\"310927ee-1195-44c3-b877-5b194b4b4ea8\",\"78669598-45b6-44a3-aa0d-11b16d45ab73\"]"}},"forever_session":{"type":"boolean","description":"Indicates whether the application session will continue to run indefinitely on reaching global idle timeout or max session timeout.\nThis property can be used for sorting.","example":false},"global_application_entitlement_ids":{"uniqueItems":true,"type":"array","description":"IDs of the global application entitlements used to launch applications in the session. \nEither this or global_desktop_entitlement_id may be set, but not both. Supported Filters : 'Contains'.","example":["0d23a254-b873-4534-ad9a-ce8d25c5b40e","89036a3a-5f6f-4dcd-bc78-e2febdc9dc8a"],"items":{"type":"string","description":"IDs of the global application entitlements used to launch applications in the session. \nEither this or global_desktop_entitlement_id may be set, but not both. Supported Filters : 'Contains'.","example":"[\"0d23a254-b873-4534-ad9a-ce8d25c5b40e\",\"89036a3a-5f6f-4dcd-bc78-e2febdc9dc8a\"]"}},"global_desktop_entitlement_id":{"type":"string","description":"ID of the global desktop entitlement used to launch the session. \nEither this or global_application_entitlement_ids may be set, but not both. Supported Filters : 'Equals'.","example":"adcfdefc-c853-4413-8ac7-b299535a509d"},"id":{"type":"string","description":"Unique ID representing a session. \nSupported Filters: 'Equals'.","example":"ac6fc134-d197-3bbc-a6bf-24dc63123ae6"},"idle_duration":{"type":"integer","description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int64","example":30},"last_session_duration_ms":{"type":"integer","description":"Duration of the last connection period of the session in milliseconds. \nIf the session is currently connected, this is the duration that the session has been in connected state. \nIf the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int64","example":120290},"local_access_group_id":{"type":"string","description":"ID of the local access group associated with the session. \nFor a non-RDS desktop session, this is the access group ID of the desktop pool. \nFor an RDS desktop session, this is access group ID of the farm of the RDS desktop pool. \nFor an application session, this is the access group ID of the farm of the application pool. \nThis will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"95061b82-92fa-4285-b90d-a5e1d8e38c3d"},"machine_id":{"type":"string","description":"ID of the machine for the session. \nThis will be unset for RDS desktop or application sessions. \nIf desktop_pool_id is unset, it is the id of registered unmanaged physical machine. \nThis will be unset if the session is hosted by remote pod.\nSupported Filters: 'Equals'.","example":"3205f64e-1d3d-43c0-942b-0bb6707c481d"},"machine_or_rds_server_dns_name":{"type":"string","description":"DNS name of the machine or RDS server for the session.\nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"pod_id":{"type":"string","description":"ID of the pod that provided the resource for the session.","example":"b7ade226-ca2a-4805-b7be-c4bc8cec5188"},"rds_server_id":{"type":"string","description":"ID of the RDS server for the RDS desktop or application session. <br>This will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"a6cddaeb-4477-468d-90ea-593c716790b8"},"resourced_remotely":{"type":"boolean","description":"Indicates whether the session is running on a remote pod resource. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"security_gateway_data":{"$ref":"#/components/schemas/GlobalSessionSecurityGatewayData"},"session_protocol":{"type":"string","description":"Protocol for session. This will be unset for disconnected sessions. \nSupported Filters: 'Equals', 'Contains'. \nThis property can be used for sorting.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"BLAST","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]},"session_state":{"type":"string","description":"State of session. \nSupported Filters: 'Equals', 'NotEquals', 'Contains'.\nThis property can be used for sorting.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","description":"Type of session. \nSupported Filters: 'Equals', 'Contains'. \nThis property can be used for sorting.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","example":"DESKTOP","enum":["DESKTOP","APPLICATION"]},"site_id":{"type":"string","description":"ID of the site where the pod that resourced the session belongs.","example":"037e6be2-9aa3-4676-93d3-25a519efedf4"},"start_time":{"type":"integer","description":"Epoch time in milliseconds when this session was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences between. \nThe first connection time will be shortly after this time. \nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1621512606000},"unauthenticated":{"type":"boolean","description":"Indicates whether the session belongs to unauthenticated access user. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_id":{"type":"string","description":" SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"}},"description":"Information related to Global Session."},"GlobalSessionInfoV2":{"type":"object","properties":{"agent_version":{"type":"string","description":"Version of the agent for the session. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"8.3.0"},"application_names":{"uniqueItems":true,"type":"array","description":"Names of the applications launched in the session. <br>It will only be set when session_type is APPLICATION. \nSupported Filters: 'Contains'.","example":["Calculator","Paint"],"items":{"type":"string","description":"Names of the applications launched in the session. <br>It will only be set when session_type is APPLICATION. \nSupported Filters: 'Contains'.","example":"[\"Calculator\",\"Paint\"]"}},"broker_user_id":{"type":"string","description":"SID for the broker user associated with the session. \nIt will be unset for non-broker sessions. \nSupported Filters: 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"brokered_remotely":{"type":"boolean","description":"Indicates whether the session is brokered from a remote pod. <br>This will be set only if the Horizon View agent where the session resides is version 6.0 or later. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"brokering_pod_id":{"type":"string","description":"ID of the pod that brokered the session.","example":"399eecf2-66ab-4a8f-94d9-b290fda35e4f"},"client_data":{"$ref":"#/components/schemas/GlobalSessionClientData"},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool for the desktop session. \nThis will be unset if the session is not brokered through a desktop pool, such as for direct console access. \nThis will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"53c4de7c-ae7c-471d-a8d0-3489cb9741d7"},"desktop_pool_or_farm_name":{"type":"string","description":"Display name of the desktop pool or name of the farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. \nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Farm-Name"},"desktop_pool_or_farm_source":{"type":"string","description":"Source of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"VIRTUAL_CENTER","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"desktop_pool_or_farm_type":{"type":"string","description":"Type of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"disconnected_time":{"type":"integer","description":"Epoch time in milliseconds, when the session was last disconnected. \nThis will be unset if the machine on which the session resides has an error state, or if the session has never been disconnected. \nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1621512686000},"farm_id":{"type":"string","description":"ID of the farm for the RDS desktop or application session. \nThis will be unset if the session is not brokered through a farm, such as for direct console access. \nThis will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"250f68e8-9e7e-4578-b8fa-25864c63f168"},"federated_access_group_ids":{"uniqueItems":true,"type":"array","description":"IDs of the federated access groups associated with the session. <br>This represents the federated access groups associated with the global desktop entitlement or global application entitlements used to launch the session. Supported Filters : 'Contains'.","example":["310927ee-1195-44c3-b877-5b194b4b4ea8","78669598-45b6-44a3-aa0d-11b16d45ab73"],"items":{"type":"string","description":"IDs of the federated access groups associated with the session. <br>This represents the federated access groups associated with the global desktop entitlement or global application entitlements used to launch the session. Supported Filters : 'Contains'.","example":"[\"310927ee-1195-44c3-b877-5b194b4b4ea8\",\"78669598-45b6-44a3-aa0d-11b16d45ab73\"]"}},"forever_session":{"type":"boolean","description":"Indicates whether the application session will continue to run indefinitely on reaching global idle timeout or max session timeout.\nThis property can be used for sorting.","example":false},"global_application_entitlement_ids":{"uniqueItems":true,"type":"array","description":"IDs of the global application entitlements used to launch applications in the session. \nEither this or global_desktop_entitlement_id may be set, but not both. Supported Filters : 'Contains'.","example":["0d23a254-b873-4534-ad9a-ce8d25c5b40e","89036a3a-5f6f-4dcd-bc78-e2febdc9dc8a"],"items":{"type":"string","description":"IDs of the global application entitlements used to launch applications in the session. \nEither this or global_desktop_entitlement_id may be set, but not both. Supported Filters : 'Contains'.","example":"[\"0d23a254-b873-4534-ad9a-ce8d25c5b40e\",\"89036a3a-5f6f-4dcd-bc78-e2febdc9dc8a\"]"}},"global_desktop_entitlement_id":{"type":"string","description":"ID of the global desktop entitlement used to launch the session. \nEither this or global_application_entitlement_ids may be set, but not both. Supported Filters : 'Equals'.","example":"adcfdefc-c853-4413-8ac7-b299535a509d"},"id":{"type":"string","description":"Unique ID representing a session. \nSupported Filters: 'Equals'.","example":"ac6fc134-d197-3bbc-a6bf-24dc63123ae6"},"idle_duration":{"type":"integer","description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int64","example":30},"internal_session_id":{"type":"string","description":"Internal session Id Supported Filters : Equals","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A="},"last_session_duration_ms":{"type":"integer","description":"Duration of the last connection period of the session in milliseconds. \nIf the session is currently connected, this is the duration that the session has been in connected state. \nIf the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int64","example":120290},"local_access_group_id":{"type":"string","description":"ID of the local access group associated with the session. \nFor a non-RDS desktop session, this is the access group ID of the desktop pool. \nFor an RDS desktop session, this is access group ID of the farm of the RDS desktop pool. \nFor an application session, this is the access group ID of the farm of the application pool. \nThis will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"95061b82-92fa-4285-b90d-a5e1d8e38c3d"},"machine_id":{"type":"string","description":"ID of the machine for the session. \nThis will be unset for RDS desktop or application sessions. \nIf desktop_pool_id is unset, it is the id of registered unmanaged physical machine. \nThis will be unset if the session is hosted by remote pod.\nSupported Filters: 'Equals'.","example":"3205f64e-1d3d-43c0-942b-0bb6707c481d"},"machine_or_rds_server_dns_name":{"type":"string","description":"DNS name of the machine or RDS server for the session.\nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"pod_id":{"type":"string","description":"ID of the pod that provided the resource for the session.","example":"b7ade226-ca2a-4805-b7be-c4bc8cec5188"},"rds_server_id":{"type":"string","description":"ID of the RDS server for the RDS desktop or application session. <br>This will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"a6cddaeb-4477-468d-90ea-593c716790b8"},"resourced_remotely":{"type":"boolean","description":"Indicates whether the session is running on a remote pod resource. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"security_gateway_data":{"$ref":"#/components/schemas/GlobalSessionSecurityGatewayData"},"session_protocol":{"type":"string","description":"Protocol for session. This will be unset for disconnected sessions. \nSupported Filters: 'Equals', 'Contains'. \nThis property can be used for sorting.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"BLAST","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]},"session_state":{"type":"string","description":"State of session. \nSupported Filters: 'Equals', 'NotEquals', 'Contains'.\nThis property can be used for sorting.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","description":"Type of session. \nSupported Filters: 'Equals', 'Contains'. \nThis property can be used for sorting.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","example":"DESKTOP","enum":["DESKTOP","APPLICATION"]},"site_id":{"type":"string","description":"ID of the site where the pod that resourced the session belongs.","example":"037e6be2-9aa3-4676-93d3-25a519efedf4"},"start_time":{"type":"integer","description":"Epoch time in milliseconds when this session was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences between. \nThe first connection time will be shortly after this time. \nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1621512606000},"unauthenticated":{"type":"boolean","description":"Indicates whether the session belongs to unauthenticated access user. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_id":{"type":"string","description":" SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"}},"description":"Information related to Global Session."},"GlobalSessionInfoV3":{"type":"object","properties":{"agent_version":{"type":"string","description":"Version of the agent for the session. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"8.3.0"},"application_names":{"uniqueItems":true,"type":"array","description":"Names of the applications launched in the session. <br>It will only be set when session_type is APPLICATION. \nSupported Filters: 'Contains'.","example":["Calculator","Paint"],"items":{"type":"string","description":"Names of the applications launched in the session. <br>It will only be set when session_type is APPLICATION. \nSupported Filters: 'Contains'.","example":"[\"Calculator\",\"Paint\"]"}},"broker_user_id":{"type":"string","description":"SID for the broker user associated with the session. \nIt will be unset for non-broker sessions. \nSupported Filters: 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"brokered_remotely":{"type":"boolean","description":"Indicates whether the session is brokered from a remote pod. <br>This will be set only if the Horizon View agent where the session resides is version 6.0 or later. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"brokering_pod_id":{"type":"string","description":"ID of the pod that brokered the session.","example":"399eecf2-66ab-4a8f-94d9-b290fda35e4f"},"brokering_pod_name":{"type":"string","description":"Name of the Brokering pod that provided the resource for the session.\nSupported Filters: 'Equals', 'Contains'.\n\nThis property can be used for sorting.","example":"pod1"},"client_data":{"$ref":"#/components/schemas/GlobalSessionClientData"},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool for the desktop session. \nThis will be unset if the session is not brokered through a desktop pool, such as for direct console access. \nThis will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"53c4de7c-ae7c-471d-a8d0-3489cb9741d7"},"desktop_pool_or_farm_name":{"type":"string","description":"Display name of the desktop pool or name of the farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. \nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Farm-Name"},"desktop_pool_or_farm_source":{"type":"string","description":"Source of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"VIRTUAL_CENTER","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"desktop_pool_or_farm_type":{"type":"string","description":"Type of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"disconnected_time":{"type":"integer","description":"Epoch time in milliseconds, when the session was last disconnected. \nThis will be unset if the machine on which the session resides has an error state, or if the session has never been disconnected. \nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1621512686000},"farm_id":{"type":"string","description":"ID of the farm for the RDS desktop or application session. \nThis will be unset if the session is not brokered through a farm, such as for direct console access. \nThis will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"250f68e8-9e7e-4578-b8fa-25864c63f168"},"federated_access_group_ids":{"uniqueItems":true,"type":"array","description":"IDs of the federated access groups associated with the session. <br>This represents the federated access groups associated with the global desktop entitlement or global application entitlements used to launch the session. Supported Filters : 'Contains'.","example":["310927ee-1195-44c3-b877-5b194b4b4ea8","78669598-45b6-44a3-aa0d-11b16d45ab73"],"items":{"type":"string","description":"IDs of the federated access groups associated with the session. <br>This represents the federated access groups associated with the global desktop entitlement or global application entitlements used to launch the session. Supported Filters : 'Contains'.","example":"[\"310927ee-1195-44c3-b877-5b194b4b4ea8\",\"78669598-45b6-44a3-aa0d-11b16d45ab73\"]"}},"forever_session":{"type":"boolean","description":"Indicates whether the application session will continue to run indefinitely on reaching global idle timeout or max session timeout.\nThis property can be used for sorting.","example":false},"global_application_entitlement_ids":{"uniqueItems":true,"type":"array","description":"IDs of the global application entitlements used to launch applications in the session. \nEither this or global_desktop_entitlement_id may be set, but not both. Supported Filters : 'Contains'.","example":["0d23a254-b873-4534-ad9a-ce8d25c5b40e","89036a3a-5f6f-4dcd-bc78-e2febdc9dc8a"],"items":{"type":"string","description":"IDs of the global application entitlements used to launch applications in the session. \nEither this or global_desktop_entitlement_id may be set, but not both. Supported Filters : 'Contains'.","example":"[\"0d23a254-b873-4534-ad9a-ce8d25c5b40e\",\"89036a3a-5f6f-4dcd-bc78-e2febdc9dc8a\"]"}},"global_application_entitlement_names":{"uniqueItems":true,"type":"array","description":"Names of the global application entitlements used to launch applications in the session. \nEither this or global_desktop_entitlement_name will be set, but not both. Supported Filters : 'Contains'.","example":["GAE1","GAE2"],"items":{"type":"string","description":"Names of the global application entitlements used to launch applications in the session. \nEither this or global_desktop_entitlement_name will be set, but not both. Supported Filters : 'Contains'.","example":"[\"GAE1\",\"GAE2\"]"}},"global_desktop_entitlement_id":{"type":"string","description":"ID of the global desktop entitlement used to launch the session. \nEither this or global_application_entitlement_ids may be set, but not both. Supported Filters : 'Equals'.","example":"adcfdefc-c853-4413-8ac7-b299535a509d"},"global_desktop_entitlement_name":{"type":"string","description":"Name of the global desktop entitlement used to launch the session. \nEither this or global_application_entitlement_ids may be set, but not both. Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.","example":"GDE1"},"id":{"type":"string","description":"Unique ID representing a session. \nSupported Filters: 'Equals'.","example":"ac6fc134-d197-3bbc-a6bf-24dc63123ae6"},"idle_duration":{"type":"integer","description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int64","example":30},"internal_session_id":{"type":"string","description":"Internal session Id Supported Filters : Equals","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A="},"last_session_duration_ms":{"type":"integer","description":"Duration of the last connection period of the session in milliseconds. \nIf the session is currently connected, this is the duration that the session has been in connected state. \nIf the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int64","example":120290},"local_access_group_id":{"type":"string","description":"ID of the local access group associated with the session. \nFor a non-RDS desktop session, this is the access group ID of the desktop pool. \nFor an RDS desktop session, this is access group ID of the farm of the RDS desktop pool. \nFor an application session, this is the access group ID of the farm of the application pool. \nThis will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"95061b82-92fa-4285-b90d-a5e1d8e38c3d"},"machine_id":{"type":"string","description":"ID of the machine for the session. \nThis will be unset for RDS desktop or application sessions. \nIf desktop_pool_id is unset, it is the id of registered unmanaged physical machine. \nThis will be unset if the session is hosted by remote pod.\nSupported Filters: 'Equals'.","example":"3205f64e-1d3d-43c0-942b-0bb6707c481d"},"machine_or_rds_server_dns_name":{"type":"string","description":"DNS name of the machine or RDS server for the session.\nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"machine_or_rds_server_name":{"type":"string","description":"Name of the machine for the session. \nThis will be unset for RDS desktop or application sessions. \nIf desktop_pool_id is unset, it is the id of registered unmanaged physical machine. \nThis will be unset if the session is hosted by remote pod.\nSupported Filters: 'Equals', 'Contains'.\n\nThis property can be used for sorting.","example":"Machine-1"},"pod_id":{"type":"string","description":"ID of the pod that provided the resource for the session.","example":"b7ade226-ca2a-4805-b7be-c4bc8cec5188"},"pod_name":{"type":"string","description":"Name of the pod that provided the resource for the session.\nSupported Filters: 'Equals', 'Contains'.\n\nThis property can be used for sorting.","example":"pod1"},"rds_server_id":{"type":"string","description":"ID of the RDS server for the RDS desktop or application session. <br>This will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"a6cddaeb-4477-468d-90ea-593c716790b8"},"resourced_remotely":{"type":"boolean","description":"Indicates whether the session is running on a remote pod resource. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"security_gateway_data":{"$ref":"#/components/schemas/GlobalSessionSecurityGatewayData"},"session_protocol":{"type":"string","description":"Protocol for session. This will be unset for disconnected sessions. \nSupported Filters: 'Equals', 'Contains'. \nThis property can be used for sorting.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"BLAST","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]},"session_state":{"type":"string","description":"State of session. \nSupported Filters: 'Equals', 'NotEquals', 'Contains'.\nThis property can be used for sorting.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","description":"Type of session. \nSupported Filters: 'Equals', 'Contains'. \nThis property can be used for sorting.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","example":"DESKTOP","enum":["DESKTOP","APPLICATION"]},"site_id":{"type":"string","description":"ID of the site where the pod that resourced the session belongs.","example":"037e6be2-9aa3-4676-93d3-25a519efedf4"},"site_name":{"type":"string","description":"Name of the site where the pod that resourced the session belongs.\n\nSupported Filters: 'Equals', 'Contains'.\n\nThis property can be used for sorting.","example":"site1"},"start_time":{"type":"integer","description":"Epoch time in milliseconds when this session was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences between. \nThe first connection time will be shortly after this time. \nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1621512606000},"unauthenticated":{"type":"boolean","description":"Indicates whether the session belongs to unauthenticated access user. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_id":{"type":"string","description":" SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"user_name":{"type":"string","description":" Name of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.but not both. Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.","example":"User1"}},"description":"Information related to Global Session."},"GlobalSessionInfoV4":{"type":"object","properties":{"agent_version":{"type":"string","description":"Version of the agent for the session. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"8.3.0"},"application_names":{"uniqueItems":true,"type":"array","description":"Names of the applications launched in the session. <br>It will only be set when session_type is APPLICATION. \nSupported Filters: 'Contains'.","example":["Calculator","Paint"],"items":{"type":"string","description":"Names of the applications launched in the session. <br>It will only be set when session_type is APPLICATION. \nSupported Filters: 'Contains'.","example":"[\"Calculator\",\"Paint\"]"}},"broker_user_id":{"type":"string","description":"SID for the broker user associated with the session. \nIt will be unset for non-broker sessions. \nSupported Filters: 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"brokered_remotely":{"type":"boolean","description":"Indicates whether the session is brokered from a remote pod. <br>This will be set only if the Horizon View agent where the session resides is version 6.0 or later. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"brokering_pod_id":{"type":"string","description":"ID of the pod that brokered the session.","example":"399eecf2-66ab-4a8f-94d9-b290fda35e4f"},"brokering_pod_name":{"type":"string","description":"Name of the Brokering pod that provided the resource for the session.\nSupported Filters: 'Equals', 'Contains'.\n\nThis property can be used for sorting.","example":"pod1"},"client_data":{"$ref":"#/components/schemas/GlobalSessionClientData"},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool for the desktop session. \nThis will be unset if the session is not brokered through a desktop pool, such as for direct console access. \nThis will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"53c4de7c-ae7c-471d-a8d0-3489cb9741d7"},"desktop_pool_or_farm_name":{"type":"string","description":"Display name of the desktop pool or name of the farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. \nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Farm-Name"},"desktop_pool_or_farm_source":{"type":"string","description":"Source of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"VIRTUAL_CENTER","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"desktop_pool_or_farm_type":{"type":"string","description":"Type of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"disconnected_time":{"type":"integer","description":"Epoch time in milliseconds, when the session was last disconnected. \nThis will be unset if the machine on which the session resides has an error state, or if the session has never been disconnected. \nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1621512686000},"farm_id":{"type":"string","description":"ID of the farm for the RDS desktop or application session. \nThis will be unset if the session is not brokered through a farm, such as for direct console access. \nThis will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"250f68e8-9e7e-4578-b8fa-25864c63f168"},"federated_access_group_ids":{"uniqueItems":true,"type":"array","description":"IDs of the federated access groups associated with the session. <br>This represents the federated access groups associated with the global desktop entitlement or global application entitlements used to launch the session. Supported Filters : 'Contains'.","example":["310927ee-1195-44c3-b877-5b194b4b4ea8","78669598-45b6-44a3-aa0d-11b16d45ab73"],"items":{"type":"string","description":"IDs of the federated access groups associated with the session. <br>This represents the federated access groups associated with the global desktop entitlement or global application entitlements used to launch the session. Supported Filters : 'Contains'.","example":"[\"310927ee-1195-44c3-b877-5b194b4b4ea8\",\"78669598-45b6-44a3-aa0d-11b16d45ab73\"]"}},"forever_session":{"type":"boolean","description":"Indicates whether the application session will continue to run indefinitely on reaching global idle timeout or max session timeout.\nThis property can be used for sorting.","example":false},"global_application_entitlement_ids":{"uniqueItems":true,"type":"array","description":"IDs of the global application entitlements used to launch applications in the session. \nEither this or global_desktop_entitlement_id may be set, but not both. Supported Filters : 'Contains'.","example":["0d23a254-b873-4534-ad9a-ce8d25c5b40e","89036a3a-5f6f-4dcd-bc78-e2febdc9dc8a"],"items":{"type":"string","description":"IDs of the global application entitlements used to launch applications in the session. \nEither this or global_desktop_entitlement_id may be set, but not both. Supported Filters : 'Contains'.","example":"[\"0d23a254-b873-4534-ad9a-ce8d25c5b40e\",\"89036a3a-5f6f-4dcd-bc78-e2febdc9dc8a\"]"}},"global_application_entitlement_names":{"uniqueItems":true,"type":"array","description":"Names of the global application entitlements used to launch applications in the session. \nEither this or global_desktop_entitlement_name will be set, but not both. Supported Filters : 'Contains'.","example":["GAE1","GAE2"],"items":{"type":"string","description":"Names of the global application entitlements used to launch applications in the session. \nEither this or global_desktop_entitlement_name will be set, but not both. Supported Filters : 'Contains'.","example":"[\"GAE1\",\"GAE2\"]"}},"global_desktop_entitlement_id":{"type":"string","description":"ID of the global desktop entitlement used to launch the session. \nEither this or global_application_entitlement_ids may be set, but not both. Supported Filters : 'Equals'.","example":"adcfdefc-c853-4413-8ac7-b299535a509d"},"global_desktop_entitlement_name":{"type":"string","description":"Name of the global desktop entitlement used to launch the session. \nEither this or global_application_entitlement_ids may be set, but not both. Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.","example":"GDE1"},"id":{"type":"string","description":"Unique ID representing a session. \nSupported Filters: 'Equals'.","example":"ac6fc134-d197-3bbc-a6bf-24dc63123ae6"},"idle_duration":{"type":"integer","description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int64","example":30},"internal_session_id":{"type":"string","description":"Internal session Id Supported Filters : Equals","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A="},"last_session_duration_ms":{"type":"integer","description":"Duration of the last connection period of the session in milliseconds. \nIf the session is currently connected, this is the duration that the session has been in connected state. \nIf the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","format":"int64","example":120290},"local_access_group_id":{"type":"string","description":"ID of the local access group associated with the session. \nFor a non-RDS desktop session, this is the access group ID of the desktop pool. \nFor an RDS desktop session, this is access group ID of the farm of the RDS desktop pool. \nFor an application session, this is the access group ID of the farm of the application pool. \nThis will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"95061b82-92fa-4285-b90d-a5e1d8e38c3d"},"machine_id":{"type":"string","description":"ID of the machine for the session. \nThis will be unset for RDS desktop or application sessions. \nIf desktop_pool_id is unset, it is the id of registered unmanaged physical machine. \nThis will be unset if the session is hosted by remote pod.\nSupported Filters: 'Equals'.","example":"3205f64e-1d3d-43c0-942b-0bb6707c481d"},"machine_or_rds_server_dns_name":{"type":"string","description":"DNS name of the machine or RDS server for the session.\nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"machine_or_rds_server_name":{"type":"string","description":"Name of the machine for the session. \nThis will be unset for RDS desktop or application sessions. \nIf desktop_pool_id is unset, it is the id of registered unmanaged physical machine. \nThis will be unset if the session is hosted by remote pod.\nSupported Filters: 'Equals', 'Contains'.\n\nThis property can be used for sorting.","example":"Machine-1"},"pod_id":{"type":"string","description":"ID of the pod that provided the resource for the session.","example":"b7ade226-ca2a-4805-b7be-c4bc8cec5188"},"pod_name":{"type":"string","description":"Name of the pod that provided the resource for the session.\nSupported Filters: 'Equals', 'Contains'.\n\nThis property can be used for sorting.","example":"pod1"},"rds_server_id":{"type":"string","description":"ID of the RDS server for the RDS desktop or application session. <br>This will be unset if the session is hosted by remote pod. \nSupported Filters: 'Equals'.","example":"a6cddaeb-4477-468d-90ea-593c716790b8"},"resourced_remotely":{"type":"boolean","description":"Indicates whether the session is running on a remote pod resource. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"security_gateway_data":{"$ref":"#/components/schemas/GlobalSessionSecurityGatewayData"},"session_protocol":{"type":"string","description":"Protocol for session. This will be unset for disconnected sessions. \nSupported Filters: 'Equals', 'Contains'. \nThis property can be used for sorting.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"BLAST","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]},"session_state":{"type":"string","description":"State of session. \nSupported Filters: 'Equals', 'NotEquals', 'Contains'.\nThis property can be used for sorting.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","description":"Type of session. \nSupported Filters: 'Equals', 'Contains'. \nThis property can be used for sorting.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","example":"DESKTOP","enum":["DESKTOP","APPLICATION"]},"site_id":{"type":"string","description":"ID of the site where the pod that resourced the session belongs.","example":"037e6be2-9aa3-4676-93d3-25a519efedf4"},"site_name":{"type":"string","description":"Name of the site where the pod that resourced the session belongs.\n\nSupported Filters: 'Equals', 'Contains'.\n\nThis property can be used for sorting.","example":"site1"},"start_time":{"type":"integer","description":"Epoch time in milliseconds when this session was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences between. \nThe first connection time will be shortly after this time. \nSupported Filters: 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1621512606000},"total_session_duration_ms":{"type":"integer","description":"Epoch time in milli seconds, for the total session duration since it was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences in between. The total connection time will be from the start time till now. \nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181831000},"unauthenticated":{"type":"boolean","description":"Indicates whether the session belongs to unauthenticated access user. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_id":{"type":"string","description":" SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"user_name":{"type":"string","description":" Name of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.but not both. Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.","example":"User1"}},"description":"Information related to Global Session. <br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'Contains' and 'StartsWith'.<br>See the field description to know the filter types it supports."},"GlobalSessionSecurityGatewayData":{"type":"object","properties":{"address":{"type":"string","description":"IP Address of the security gateway for the session. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"127.0.0.1"},"domain_name":{"type":"string","description":"Computer machine name or DNS name of the security gateway for the session. Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"SECURE-GW.example.com"},"location":{"type":"string","description":"IP Address of the security gateway for the session. \nSupported Filters: 'Equals'.\nThis property can be used for sorting.\n* EXTERNAL: Gateway location is external.\n* INTERNAL: Gateway location is internal.\n* UNKNOWN: Gateway location is unknown.","example":"EXTERNAL","enum":["EXTERNAL","INTERNAL","UNKNOWN"]}},"description":"Security gateway data for the session."},"GlobalSessionSendMessageSpec":{"required":["global_session_action_specs","message","message_type"],"type":"object","properties":{"global_session_action_specs":{"type":"array","description":"Sessions to which message is to be sent.","items":{"$ref":"#/components/schemas/GlobalSessionActionSpec"}},"message":{"type":"string","description":"Message to be sent to sessions.","example":"Sample Info Message"},"message_type":{"type":"string","description":"Type of message to be sent to sessions.\n* ERROR: Message is of error type.\n* WARNING: Message is of warning type.\n* INFO: Message is of information type.","example":"INFO","enum":["ERROR","WARNING","INFO"]}},"description":"Global sessions to which message is to be sent."},"HealthMetricsInfo":{"type":"object","properties":{"additional_info":{"type":"object","additionalProperties":{"type":"string","description":"Additional details.","example":"capacity MB 1024, freespace MB 100"},"description":"Additional details.","example":"capacity MB 1024, freespace MB 100"},"component":{"type":"string","description":"Indicates components\n* CONNECTION_SERVER: Connection Server.\n* EVENT_DATABASE: Event Database.\n* TRUE_SSO: TRUE SSO Connector.\n* VIRTUAL_CENTER: Virtual Center.\n* ESX_HOST: ESX Host managed by one of the Virtual Center Configured.\n* DATASTORE: Datastore of the ESX Host.\n* GATEWAY: Gateway configured.\n* RDS_SERVER: RDS Server.\n* FARM: Farm.\n* AD_DOMAIN: AD Domain controller.\n* SAML_AUTHENTICATOR: SAML 2.0 Authenticator.\n* REMOTE_CONNECTION_SERVER: Connection Server from the Remote Pod.\n* LICENSE: License added to the connection server.\n* MESSAGE_CLIENT: Message client.\n* ALL: Represents all the components.","example":"ALL","enum":["CONNECTION_SERVER","EVENT_DATABASE","TRUE_SSO","VIRTUAL_CENTER","ESX_HOST","DATASTORE","GATEWAY","RDS_SERVER","FARM","AD_DOMAIN","SAML_AUTHENTICATOR","REMOTE_CONNECTION_SERVER","LICENSE","MESSAGE_CLIENT","ALL"]},"error_count":{"type":"integer","description":"Number of items in the system those are in error state.","format":"int32","example":3},"healthy_count":{"type":"integer","description":"Number of healthy items of the component.","format":"int32","example":5},"total_count":{"type":"integer","description":"Total number of items of the component.","format":"int32","example":13},"unknown_count":{"type":"integer","description":"Number of items in the system those are in unknown state.","format":"int32","example":2},"warning_count":{"type":"integer","description":"Number of items in the system those are in warning state.","format":"int32","example":3}},"description":"Monitoring health information of components."},"HeldUserOrGroupInfo":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","description":"Unique SID representing held user or group.","example":"S-1-5-21-1111111111-2222222222-3333333333-513"}},"description":"Information related to Held User or Group."},"HeldUserOrGroupResponseInfo":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","description":"Unique SID representing held user or group.","example":"S-1-5-21-1111111111-2222222222-3333333333-513"},"errors":{"type":"array","description":"List of error objects containing error key and error message.","items":{"$ref":"#/components/schemas/APIError"}},"machines_data":{"type":"array","description":"List of objects containing information related to held Virtual Machines.","items":{"$ref":"#/components/schemas/HeldVMInfo"}},"status_code":{"type":"integer","description":"Response HTTP status code of the operation.","format":"int32","example":200},"timestamp":{"type":"integer","description":"Timestamp in milliseconds when the operation failed. Measured as epoch time.","format":"int64","example":1561939200000}},"description":"Contains information about all the VMs assigned to the held user and their states. Also contains other general information related to the held user or group."},"HeldVMInfo":{"type":"object","properties":{"machine_id":{"type":"string","description":"Unique virtual center moid representing the virtual machine.","example":"vm-416"},"machine_state":{"type":"string","description":"Machine state\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.\n* DELETING: The machine is marked for deletion.\n* DISABLED: The machine is disabled.\n* DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* ERROR: An unknown error occurred in the machine.\n* IN_PROGRESS: There is a machine operation in progress.\n* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* WAITING_FOR_AGENT: Horizon Connection Server is waiting to establish communication with Horizon Agent for one of these cases - a virtual machine in a manual desktop pool, unmanaged machine or RDS server.","example":"Connected","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_ERROR_DOMAIN_FAILURE","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","WAITING_FOR_AGENT"]},"name":{"type":"string","description":"VM name.","example":"Win10"}},"description":"Information related to a held Virtual Machine."},"HistoricalPerformanceInfo":{"type":"object","properties":{"cpu":{"type":"number","description":"The cpu utilization.","format":"double","example":3.96},"disk_iops":{"type":"integer","description":"The disk average IOPS.","format":"int64","example":1687202598},"disk_latency":{"type":"integer","description":"The disk average latency (ms).","format":"int64","example":1687202598},"disk_read_iops":{"type":"integer","description":"The disk read IO requests completed over a period of one second.","format":"int64","example":1687202598},"disk_write_iops":{"type":"integer","description":"The disk write IO requests completed over a period of one second.","format":"int64","example":1687202598},"latency":{"type":"integer","description":"The PCoIP/Blast protocol round trip latency (ms).","format":"int64","example":1687202598},"memory":{"type":"number","description":"The memory utilization.","format":"double","example":0.075},"overall_cpu":{"type":"number","description":"The overall cpu utilization.","format":"double","example":0.35},"overall_memory":{"type":"number","description":"The overall memory utilization.","format":"double","example":9.825},"timestamp":{"type":"integer","description":"The timestamp for data collection time.","format":"int64","example":1687202598}},"description":"Information about historical performance data."},"HomeSiteCreateSpec":{"required":["ad_user_or_group_id","site_id"],"type":"object","properties":{"ad_user_or_group_id":{"type":"string","description":"SID of the user or group for whom the home site is to be configured.","example":"S-1-5-32-551"},"global_application_entitlement_id":{"type":"string","description":"ID of the Global Application Entitlement for which this site is the overriding home site.","example":"e285ebe1-194b-4563-80e0-0ad21134c503"},"global_desktop_entitlement_id":{"type":"string","description":"ID of the Global Desktop Entitlement for which this site is the overriding home site.","example":"7493bfc7-834a-4d9b-ac7d-b5f60893a3a6"},"site_id":{"type":"string","description":"ID of the site for this home site configuration.","example":"32a5ea06-cd09-4609-b3e5-df8379e99c13"}},"description":"Information required to create a Home Site in the pod federation.<br>If both Global Desktop Entitlement ID and Global Application Entitlement ID are unset, then this site is the global home site.<br>"},"HomeSiteCreateSpecV2":{"required":["ad_user_or_group_id","site_id"],"type":"object","properties":{"ad_user_or_group_id":{"type":"string","description":"SID of the user or group for whom the home site is to be configured.","example":"S-1-5-32-551"},"global_application_entitlement_id":{"type":"string","description":"ID of the Global Application Entitlement for which this site is the overriding home site.","example":"e285ebe1-194b-4563-80e0-0ad21134c503"},"global_desktop_entitlement_id":{"type":"string","description":"ID of the Global Desktop Entitlement for which this site is the overriding home site.","example":"7493bfc7-834a-4d9b-ac7d-b5f60893a3a6"},"site_id":{"type":"string","description":"ID of the site for this home site configuration.","example":"32a5ea06-cd09-4609-b3e5-df8379e99c13"},"use_homesite_for_redirection":{"type":"boolean","description":"Indicates whether the homesite can be used for redirection","example":false}},"description":"Information required to create a Home Site in the pod federation.<br>If both Global Desktop Entitlement ID and Global Application Entitlement ID are unset, then this site is the global home site.<br>"},"HomeSiteInfo":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","description":"SID of the user or group for whom this is the home site.<br>Supported Filters: 'Equals'.","example":"S-1-5-32-551"},"global_application_entitlement_id":{"type":"string","description":"ID of the Global Application Entitlement for which this site is the overriding home site.<br>Supported Filters: 'Equals'.","example":"e285ebe1-194b-4563-80e0-0ad21134c503"},"global_desktop_entitlement_id":{"type":"string","description":"ID of the Global Desktop Entitlement for which this site is the overriding home site.<br>Supported Filters: 'Equals'.","example":"7493bfc7-834a-4d9b-ac7d-b5f60893a3a6"},"id":{"type":"string","description":"Unique ID representing this home site assignment.<br>Supported Filters: 'Equals'.","example":"28deeb70-97d5-409e-abb4-497196f1ee18"},"site_id":{"type":"string","description":"ID representing this home site.<br>Supported Filters: 'Equals'.","example":"32a5ea06-cd09-4609-b3e5-df8379e99c13"}},"description":"Information related to home sites in a pod federation.<br>If both global Desktop Entitlement ID and global Application Entitlement ID are unset, then this site is the global home site.<br>Supported Filters : 'And', 'Or' and 'Equals'.<br>See the field description to know the filter types it supports."},"HomeSiteInfoV2":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","description":"SID of the user or group for whom this is the home site.<br>Supported Filters: 'Equals'.","example":"S-1-5-32-551"},"description":{"type":"string","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.","example":"Test User account"},"domain":{"type":"string","description":"DNS name of the domain in which this user or group belongs.\nSupported Filters : 'Equals'.\n Also, if 'Or' filter is used anywhere in filter string for this model class, then that 'Or' filter should nest only 'Equals' filter on 'domain' or 'id' field. \nThis property can be used for sorting.","example":"example.com"},"email":{"type":"string","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'. \nThis property can be used for sorting.","example":"testuser@example.com"},"global_application_entitlement_id":{"type":"string","description":"ID of the Global Application Entitlement for which this site is the overriding home site.<br>Supported Filters: 'Equals'.","example":"e285ebe1-194b-4563-80e0-0ad21134c503"},"global_desktop_entitlement_id":{"type":"string","description":"ID of the Global Desktop Entitlement for which this site is the overriding home site.<br>Supported Filters: 'Equals'.","example":"7493bfc7-834a-4d9b-ac7d-b5f60893a3a6"},"group":{"type":"boolean","description":"Indicates if this object represents a group.\n\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"id":{"type":"string","description":"Unique ID representing this home site assignment.<br>Supported Filters: 'Equals'.","example":"28deeb70-97d5-409e-abb4-497196f1ee18"},"site_id":{"type":"string","description":"ID representing this home site.<br>Supported Filters: 'Equals'.","example":"32a5ea06-cd09-4609-b3e5-df8379e99c13"},"site_name":{"type":"string","description":"Name of the site.\n\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":"US Site"},"use_homesite_for_redirection":{"type":"boolean","description":"Indicates whether the homesite can be used for redirection.\n\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"user_name":{"type":"string","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'. \nThis property can be used for sorting.","example":"Test User"}},"description":"Information related to home sites in a pod federation.<br>If both global Desktop Entitlement ID and global Application Entitlement ID are unset, then this site is the global home site.<br>Supported Filters : 'And', 'Or', 'StartsWith', 'Contains' and 'Equals'.<br>See the field description to know the filter types it supports."},"HomeSiteResolutionData":{"type":"object","properties":{"group_id":{"type":"string","description":"SID of the group through which the user gets this home site.","example":"S-1-5-32-568"},"id":{"type":"string","description":"ID of the Home Site Configuration.","example":"28deeb70-97d5-409e-abb4-497196f1ee18"},"resolved":{"type":"boolean","description":"Indicates whether this is the resolved home site.","example":true},"site_id":{"type":"string","description":"ID of the Site configured as Home Site.","example":"52457bcd-9641-48b1-a1ac-a8c58069ef48"},"type":{"type":"string","description":"Indicates whether the home site is directly assigned to the user or group and whether it is associated with a global entitlement.\n* USER_OVERRIDE: Indicates that a home site override is associated with a global entitlement for the user.\n* GROUP_OVERRIDE: Indicates that a home site override is associated with a global entitlement for a group that the user belongs to.\n* USER_DEFAULT: Indicates that a home site is directly assigned to the user.\n* GROUP_DEFAULT: Indicates that a home site is directly assigned to a group that the user belongs to.","example":"USER_DEFAULT","enum":["USER_OVERRIDE","GROUP_OVERRIDE","USER_DEFAULT","GROUP_DEFAULT"]}},"description":"Information representing data for a home site resolution."},"HomeSiteResolutionDataV2":{"type":"object","properties":{"group_id":{"type":"string","description":"SID of the group through which the user gets this home site.","example":"S-1-5-32-568"},"group_name":{"type":"string","description":"Name of the group through which the user gets this home site.","example":"groupName"},"id":{"type":"string","description":"ID of the Home Site Configuration.","example":"28deeb70-97d5-409e-abb4-497196f1ee18"},"resolved":{"type":"boolean","description":"Indicates whether this is the resolved home site.","example":true},"site_id":{"type":"string","description":"ID of the Site configured as Home Site.","example":"52457bcd-9641-48b1-a1ac-a8c58069ef48"},"site_name":{"type":"string","description":"Name of the Site configured as Home Site.","example":"sitename"},"type":{"type":"string","description":"Indicates whether the home site is directly assigned to the user or group and whether it is associated with a global entitlement.\n* USER_OVERRIDE: Indicates that a home site override is associated with a global entitlement for the user.\n* GROUP_OVERRIDE: Indicates that a home site override is associated with a global entitlement for a group that the user belongs to.\n* USER_DEFAULT: Indicates that a home site is directly assigned to the user.\n* GROUP_DEFAULT: Indicates that a home site is directly assigned to a group that the user belongs to.","example":"USER_DEFAULT","enum":["USER_OVERRIDE","GROUP_OVERRIDE","USER_DEFAULT","GROUP_DEFAULT"]}},"description":"Information representing data for a home site resolution."},"HomeSiteResolutionInfo":{"type":"object","properties":{"global_application_entitlement_id":{"type":"string","description":"ID of the Global Application Entitlement this home site resolution is for.","example":"f309c150-ff8b-4391-ad5d-96e1a3c3cb70"},"global_desktop_entitlement_id":{"type":"string","description":"ID of the Global Desktop Entitlement this home site resolution is for.","example":"dc2c29ce-baae-47b5-90e6-d7ab1d3b82288"},"resolution_data":{"type":"array","description":"Home Site Resolution Data for this Global Entitlement.","items":{"$ref":"#/components/schemas/HomeSiteResolutionData"}}},"description":"Information related to home site resolution for a user and a global entitlement.<br>Only one of Global Desktop Entitlement ID and Global Application Entitlement ID will be set.<br>Resolution Data will only be available if home site configuration exists for the global entitlement."},"HomeSiteResolutionInfoV2":{"type":"object","properties":{"global_application_entitlement_id":{"type":"string","description":"ID of the Global Application Entitlement this home site resolution is for.","example":"f309c150-ff8b-4391-ad5d-96e1a3c3cb70"},"global_application_entitlement_name":{"type":"string","description":"Name of the Global Application Entitlement this home site resolution is for.","example":"name"},"global_desktop_entitlement_id":{"type":"string","description":"ID of the Global Desktop Entitlement this home site resolution is for.","example":"dc2c29ce-baae-47b5-90e6-d7ab1d3b82288"},"global_desktop_entitlement_name":{"type":"string","description":"Name of the Global Desktop Entitlement this home site resolution is for.","example":"name"},"resolution_data_v2":{"type":"array","description":"Home Site Resolution Data for this Global Entitlement.","items":{"$ref":"#/components/schemas/HomeSiteResolutionDataV2"}}},"description":"Information related to home site resolution for a user and a global entitlement.<br>Only one of Global Desktop Entitlement ID and Global Application Entitlement ID will be set.<br>Resolution Data will only be available if home site configuration exists for the global entitlement."},"HomeSiteResolutionSpec":{"required":["user_id"],"type":"object","properties":{"global_application_entitlement_id":{"type":"string","description":"ID of the Global Application Entitlement this home site resolution is for.","example":"751c7619-bc3b-48cd-80d1-29960375b6d8"},"global_desktop_entitlement_id":{"type":"string","description":"ID of the Global Desktop Entitlement this home site resolution is for.","example":"9e94a90d-e7c2-40b6-a702-bd781512408d"},"user_id":{"type":"string","description":"SID of the user for whom home site is to be resolved.","example":"S-1-5-21-3623811015-3361044348"}},"description":"Home site specification to be resolved."},"HomeSiteUpdateSpecV2":{"required":["site_id"],"type":"object","properties":{"site_id":{"type":"string","description":"ID of the site for this home site configuration.","example":"32a5ea06-cd09-4609-b3e5-df8379e99c13"},"use_homesite_for_redirection":{"type":"boolean","description":"Indicates whether the homesite can be used for redirection","example":false}},"description":"List of home sites objects to be updated."},"HostOrClusterContainer":{"type":"object","properties":{"children":{"type":"array","description":"Contents of the container. These may be hosts or clusters or further nested containers.","items":{"$ref":"#/components/schemas/HostOrClusterInfo"}},"name":{"type":"string","description":"Host or cluster container node display name.","example":"ServicesFolder"},"path":{"type":"string","description":"Host or cluster container node path.","example":"/Datacenter/host/ServicesFolder"},"type":{"type":"string","description":"Type of container.\n* FOLDER: A folder container.\n* OTHER: Other container type.","example":"FOLDER","enum":["FOLDER","OTHER"]}},"description":"Details of the host or cluster container node."},"HostOrClusterDetails":{"type":"object","properties":{"cluster":{"type":"boolean","description":"Whether or not this is a cluster or a host.","example":true},"datacenter_id":{"type":"string","description":"Datacenter id for this host or cluster.","example":"datacenter-1"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this Host Or Cluster from being used in desktop pool creation.","items":{"type":"string","description":"* UNSUPPORTED_ESX_VERSION: When the host or at least one host in the cluster has an ESX version unsupported by Horizon Server.\n* ALL_HOSTS_DISCONNECTED: When the host or at least one host in the cluster is disconnected.\n* NO_HOSTS_IN_CLUSTER: When this is a cluster and does not contain any hosts.\n* INCOMPATIBLE_VSAN: When the host or at least one host in the cluster is incompatible with VSAN. This validates against the host or cluster's VC version, the host or cluster's own version, and whether or not at least one datastore in the host or cluster has a VSAN filesystem. Such host or cluster cannot be used in desktop creation with VSAN enabled.\n* INCOMPATIBLE_STORAGE_ACCELERATOR: When the host or at least one host in the cluster is incompatible with the storage accelerator feature. This validates against the host or cluster's version. Such host or cluster cannot be used in desktop creation with storage accelerator enabled.\n* INCOMPATIBLE_NATIVE_SNAPSHOTS: When the host or at least one host in the cluster is incompatible with the native snapshot feature. This validates against the host or cluster's VC version and the host or cluster's own version. This does not validate whether or not all datastores in the host or cluster support native snapshots. Such host or cluster cannot be used in desktop creation with native snapshots enabled.\n* INCOMPATIBLE_INSTANT_CLONE_DESKTOP_POOLS: When this cluster and all the hosts in this cluster support instant clone feature. This check validates that the Cluster's version and version of all the hosts in this cluster are at least 6.0 or above. Such cluster cannot be used in instant clone desktop creation. Note that only clusters can be selected for instant clone desktop pools.\n* INCOMPATIBLE_STANDALONE_HOST_FOR_INSTANT_CLONE: When this host is part of a cluster. Standalone hosts can not be used for Instant clones. This is not applicable for hosts.\n* INCOMPATIBLE_VGPU_TYPE: When this host or at least one host on this cluster supports NVIDIA GRID vGPUs.","enum":["UNSUPPORTED_ESX_VERSION","ALL_HOSTS_DISCONNECTED","NO_HOSTS_IN_CLUSTER","INCOMPATIBLE_VSAN","INCOMPATIBLE_STORAGE_ACCELERATOR","INCOMPATIBLE_NATIVE_SNAPSHOTS","INCOMPATIBLE_INSTANT_CLONE_DESKTOP_POOLS","INCOMPATIBLE_STANDALONE_HOST_FOR_INSTANT_CLONE","INCOMPATIBLE_VGPU_TYPE"]}},"name":{"type":"string","description":"Host or cluster display name.","example":"Cluster"},"path":{"type":"string","description":"Host or cluster path.","example":"/Datacenter/host/ServicesFolder/Cluster"},"vcenter_id":{"type":"string","description":"Virtual Center id for this host or cluster.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"vgpu_types":{"type":"array","description":"Types of NVIDIA GRID vGPUs supported by this host or at least one host on this cluster. If unset, this host or cluster does not support NVIDIA GRID vGPUs and cannot be used for desktop creation with NVIDIA GRID vGPU support enabled.","items":{"type":"string","description":"Types of NVIDIA GRID vGPUs supported by this host or at least one host on this cluster. If unset, this host or cluster does not support NVIDIA GRID vGPUs and cannot be used for desktop creation with NVIDIA GRID vGPU support enabled."}}},"description":"Details of the host or cluster."},"HostOrClusterInfo":{"type":"object","properties":{"container":{"$ref":"#/components/schemas/HostOrClusterContainer"},"details":{"$ref":"#/components/schemas/HostOrClusterDetails"},"id":{"type":"string","description":"Unique ID representing a host or cluster.","example":"domain-s425"}},"description":"Information related to host or cluster."},"HostOverrideData":{"type":"object","properties":{"cache_size_mb":{"type":"integer","description":"Size of the cache in megabytes. This property has a minimum value of 100. This property has a maximum value of 2048.","format":"int32","example":2048},"path":{"type":"string","description":"The path of the host that supports View Storage Accelerator.","example":"/path/host"}},"description":"Details of the Hypervisor hosts involved in Content Based Read Caching (CBRC)"},"HostOverrideDataCreateSpec":{"type":"object","properties":{"cache_size_mb":{"maximum":32768,"minimum":100,"type":"integer","description":"Size of the cache in megabytes. This property has a minimum value of 100. This property has a maximum value of 32768.","format":"int32","example":2048},"path":{"type":"string","description":"The path of the host that supports View Storage Accelerator.","example":"/path/host"}},"description":"Details of the Hypervisor hosts involved in Content Based Read Caching (CBRC)"},"HostOverrideDataUpdateSpec":{"required":["cache_size_mb","path"],"type":"object","properties":{"cache_size_mb":{"maximum":32768,"minimum":100,"type":"integer","description":"Size of the cache in megabytes. This property has a minimum value of 100. This property has a maximum value of 32768.","format":"int32","example":2048},"path":{"type":"string","description":"The path of the host that supports View Storage Accelerator.","example":"/path/host"}},"description":"Details of the Hypervisor hosts involved in Content Based Read Caching (CBRC)"},"ImageInfo":{"type":"object","properties":{"additional_details":{"type":"object","description":"Additional details of the Capacity provider's image ","example":"{\n   \"Used_For\": \"Client_Machines\",\n   \"CREATED_DATE\": \"04-11-2024\",\n}"},"description":{"type":"string","description":"Image description.","example":"image description"},"id":{"type":"string","description":"Unique identifier for the image.","example":"648617e9-9ec1-43aa-9a4f-cf308136e0cc"},"name":{"type":"string","description":"Image name.","example":"image-1"}},"description":"Information about image of a capacity provider."},"ImageManagementAssetCreateSpec":{"required":["clone_type","im_stream_id","im_version_id","image_type","status","vcenter_id"],"type":"object","properties":{"additional_details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details about image management asset."},"description":"Additional details about image management asset."},"base_snapshot_id":{"type":"string","description":"Virtual machine snapshot. Must be set if vm_template_id is unset.","example":"snapshot-1"},"base_vm_id":{"type":"string","description":"Virtual machine ID. Must be set if vm_template_id is unset.","example":"vm-2"},"clone_type":{"type":"string","description":"Image management asset clone type.\n* FULL_CLONE: Image management asset to be used in full clone automated desktop pool.\n* INSTANT_CLONE: Image management asset to be used in instant clone desktop pool/farm.","example":"INSTANT_CLONE","enum":["FULL_CLONE","INSTANT_CLONE"]},"im_stream_id":{"type":"string","description":"Image management stream to which this asset belongs to.","example":"abc16e8f-9ba0-4789-a5dd-6880f32c52df"},"im_version_id":{"type":"string","description":"Image management version to which this asset belongs to.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_type":{"type":"string","description":"Image management asset image type.\n* RDSH_APPS: Image management asset to be used for farm creation which is be used in application.\n* RDSH_DESKTOP: Image management asset is for farm creation to be created.\n* VDI_DESKTOP: Image management asset is available for desktops/farms to be created.","example":"RDSH_APPS","enum":["RDSH_APPS","RDSH_DESKTOP","VDI_DESKTOP"]},"status":{"type":"string","description":"Image management asset status.\n* AVAILABLE: Image management asset is available for desktop pools/farms to be created.\n* DELETED: Image management asset has been deleted.\n* DEPLOYING_VM: Image management asset is deploying VM on the virtual center.\n* DEPLOYMENT_DONE: Image management asset VM deployed on the virtual center.\n* DISABLED: Image management asset has been disabled and no further pool/farm operation can be done using the same.\n* FAILED: Image management asset creation has failed.\n* REPLICATING: Copying the specialized images across all virtual centers.\n* RETRY_PENDING: When image management asset creation has failed, retry action is pending for asset to be created.\n* SPECIALIZING_VM: Image management asset is being published and specialized internally like installing agents etc.","example":"AVAILABLE","enum":["AVAILABLE","DELETED","DEPLOYING_VM","DEPLOYMENT_DONE","DISABLED","FAILED","REPLICATING","RETRY_PENDING","SPECIALIZING_VM"]},"vcenter_id":{"type":"string","description":"Virtual Center where this asset is created.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"vm_template_id":{"type":"string","description":"Virtual machine template ID.","example":"vm-1"}},"description":"Image management asset object to be created."},"ImageManagementAssetInfo":{"required":["clone_type","image_type","status"],"type":"object","properties":{"additional_details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details about image management asset."},"description":"Additional details about image management asset."},"base_snapshot_id":{"type":"string","description":"Virtual machine snapshot. Must be set if vm_template_id is unset.\nSupported Filters : 'Equals'.","example":"snapshot-1"},"base_vm_id":{"type":"string","description":"Virtual machine ID. Must be set if vm_template_id is unset.\nSupported Filters : 'Equals'.","example":"vm-2"},"clone_type":{"type":"string","description":"Image management asset clone type.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.\n* FULL_CLONE: Image management asset to be used in full clone automated desktop pool.\n* INSTANT_CLONE: Image management asset to be used in instant clone desktop pool/farm.","example":"INSTANT_CLONE","enum":["FULL_CLONE","INSTANT_CLONE"]},"datacenter_id":{"type":"string","description":"Datacenter where this asset is created.\nSupported Filters : 'Equals'.","example":"datacenter-1"},"id":{"type":"string","description":"Unique ID representing image management asset.\nSupported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"im_stream_id":{"type":"string","description":"Image management stream to which this asset belongs to.\nSupported Filters : 'Equals'.","example":"abc16e8f-9ba0-4789-a5dd-6880f32c52df"},"im_version_id":{"type":"string","description":"Image management version to which this asset belongs to.\nSupported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_type":{"type":"string","description":"Image management asset image type.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.\n* RDSH_APPS: Image management asset to be used for farm creation which is be used in application.\n* RDSH_DESKTOP: Image management asset is for farm creation to be created.\n* VDI_DESKTOP: Image management asset is available for desktops/farms to be created.","example":"RDSH_APPs","enum":["RDSH_APPS","RDSH_DESKTOP","VDI_DESKTOP"]},"status":{"type":"string","description":"Image management asset status.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.\n* AVAILABLE: Image management asset is available for desktop pools/farms to be created.\n* DELETED: Image management asset has been deleted.\n* DEPLOYING_VM: Image management asset is deploying VM on the virtual center.\n* DEPLOYMENT_DONE: Image management asset VM deployed on the virtual center.\n* DISABLED: Image management asset has been disabled and no further pool/farm operation can be done using the same.\n* FAILED: Image management asset creation has failed.\n* REPLICATING: Copying the specialized images across all virtual centers.\n* RETRY_PENDING: When image management asset creation has failed, retry action is pending for asset to be created.\n* SPECIALIZING_VM: Image management asset is being published and specialized internally like installing agents etc.","example":"AVAILABLE","enum":["AVAILABLE","DELETED","DEPLOYING_VM","DEPLOYMENT_DONE","DISABLED","FAILED","REPLICATING","RETRY_PENDING","SPECIALIZING_VM"]},"vcenter_id":{"type":"string","description":"Virtual Center where this asset is created.\nSupported Filters : 'Equals'.","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360"},"vm_template_id":{"type":"string","description":"Virtual machine template ID.\nSupported Filters : 'Equals'.","example":"vm-1"}},"description":"Information related to image management asset.\nSupported Filters : 'And', 'Or', 'Equals'."},"ImageManagementAssetUpdateSpec":{"required":["clone_type","image_type","status"],"type":"object","properties":{"additional_details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details about image management asset."},"description":"Additional details about image management asset."},"clone_type":{"type":"string","description":"Image management asset clone type.\n* FULL_CLONE: Image management asset to be used in full clone automated desktop pool.\n* INSTANT_CLONE: Image management asset to be used in instant clone desktop pool/farm.","example":"INSTANT_CLONE","enum":["FULL_CLONE","INSTANT_CLONE"]},"image_type":{"type":"string","description":"Image management asset image type.\n* RDSH_APPS: Image management asset to be used for farm creation which is be used in application.\n* RDSH_DESKTOP: Image management asset is for farm creation to be created.\n* VDI_DESKTOP: Image management asset is available for desktops/farms to be created.","example":"RDSH_APPS","enum":["RDSH_APPS","RDSH_DESKTOP","VDI_DESKTOP"]},"status":{"type":"string","description":"Image management asset status.\n* AVAILABLE: Image management asset is available for desktop pools/farms to be created.\n* DELETED: Image management asset has been deleted.\n* DEPLOYING_VM: Image management asset is deploying VM on the virtual center.\n* DEPLOYMENT_DONE: Image management asset VM deployed on the virtual center.\n* DISABLED: Image management asset has been disabled and no further pool/farm operation can be done using the same.\n* FAILED: Image management asset creation has failed.\n* REPLICATING: Copying the specialized images across all virtual centers.\n* RETRY_PENDING: When image management asset creation has failed, retry action is pending for asset to be created.\n* SPECIALIZING_VM: Image management asset is being published and specialized internally like installing agents etc.","example":"AVAILABLE","enum":["AVAILABLE","DELETED","DEPLOYING_VM","DEPLOYMENT_DONE","DISABLED","FAILED","REPLICATING","RETRY_PENDING","SPECIALIZING_VM"]}},"description":"Image management asset object to be updated."},"ImageManagementStreamCreateSpec":{"required":["name","operating_system","source","status"],"type":"object","properties":{"additional_details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details about image management stream."},"description":"Additional details about image management stream."},"description":{"pattern":"[\\S\\s]{0,1024}","type":"string","description":"Image management stream description.","example":"Windows 10 Stream"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Image management stream name.","example":"Win10"},"operating_system":{"type":"string","description":"Operating system.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_10","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"publisher":{"type":"string","description":"Image management stream publisher","example":"VMware"},"source":{"type":"string","description":"Image management stream source.\n* COPIED_FROM_STREAM: Image management stream is copied from another stream.\n* COPIED_FROM_VERSION: Image management stream is copied from a version.\n* MARKET_PLACE: Image management stream is from market place.\n* UPLOADED: Image management stream is uploaded.","example":"MARKET_PLACE","enum":["COPIED_FROM_STREAM","COPIED_FROM_VERSION","MARKET_PLACE","UPLOADED"]},"status":{"type":"string","description":"Image management stream status.\n* AVAILABLE: Image management stream is available for desktop pools/farms to be created.\n* DELETED: Image management stream is deleted.\n* DISABLED: Image management stream is disabled and no further desktop pools/farms can be created using the same.\n* FAILED: Image management stream creation has failed.\n* IN_PROGRESS: Image management stream creation is in progress.\n* PARTIALLY_AVAILABLE: Image management version for this stream could not be created in one or more environments.\n* PENDING: Image management stream is in pending state.","example":"AVAILABLE","enum":["AVAILABLE","DELETED","DISABLED","FAILED","IN_PROGRESS","PARTIALLY_AVAILABLE","PENDING"]}},"description":"Image management stream object to be created."},"ImageManagementStreamInfo":{"type":"object","properties":{"additional_details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details about image management stream.","example":"true"},"description":"Additional details about image management stream.","example":true},"description":{"type":"string","description":"Image management stream description.\nThis property can be used for sorting.","example":"Windows 10 Stream"},"id":{"type":"string","description":"Unique ID representing image management stream. Supported Filters: 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"name":{"type":"string","description":"Image management stream name. Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Win10"},"operating_system":{"type":"string","description":"Operating system. Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_10","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"publisher":{"type":"string","description":"Image management stream publisher. Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"VMware"},"source":{"type":"string","description":"Image management stream source. Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* COPIED_FROM_STREAM: Image management stream is copied from another stream.\n* COPIED_FROM_VERSION: Image management stream is copied from a version.\n* MARKET_PLACE: Image management stream is from market place.\n* UPLOADED: Image management stream is uploaded.","example":"MARKET_PLACE","enum":["COPIED_FROM_STREAM","COPIED_FROM_VERSION","MARKET_PLACE","UPLOADED"]},"status":{"type":"string","description":"Image management stream status. Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* AVAILABLE: Image management stream is available for desktop pools/farms to be created.\n* DELETED: Image management stream is deleted.\n* DISABLED: Image management stream is disabled and no further desktop pools/farms can be created using the same.\n* FAILED: Image management stream creation has failed.\n* IN_PROGRESS: Image management stream creation is in progress.\n* PARTIALLY_AVAILABLE: Image management version for this stream could not be created in one or more environments.\n* PENDING: Image management stream is in pending state.","example":"AVAILABLE","enum":["AVAILABLE","DELETED","DISABLED","FAILED","IN_PROGRESS","PARTIALLY_AVAILABLE","PENDING"]},"usable":{"type":"boolean","description":"Specifies whether the image management stream can be used in desktop pool or farm. This will be set to true when: <ul><li>Image management stream is in AVAILABLE or PARTIALLY_AVAILABLE state. </li><li>There is at least one image management version in AVAILABLE or PARTIALLY_AVAILABLE state for this stream. </li><li>There is at least one image management tag associated with the image management version.</li> </ul>For a specific virtual center, image management tag information will be retrieved.\nThis property can be used for sorting.","example":true}},"description":"Information related to image management stream.List API returning this information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters: 'And, Or, Equals, StartsWith and Contains'.<br>See the field description to know the filter types it supports."},"ImageManagementStreamUpdateSpec":{"required":["name","operating_system","source","status"],"type":"object","properties":{"additional_details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details about image management stream."},"description":"Additional details about image management stream."},"description":{"pattern":"[\\S\\s]{0,1024}","type":"string","description":"Image management stream description.","example":"Windows 10 Stream"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Image management stream name.","example":"Win10"},"operating_system":{"type":"string","description":"Operating system.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_10","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"publisher":{"type":"string","description":"Image management stream publisher","example":"VMware"},"source":{"type":"string","description":"Image management stream source.\n* COPIED_FROM_STREAM: Image management stream is copied from another stream.\n* COPIED_FROM_VERSION: Image management stream is copied from a version.\n* MARKET_PLACE: Image management stream is from market place.\n* UPLOADED: Image management stream is uploaded.","example":"MARKET_PLACE","enum":["COPIED_FROM_STREAM","COPIED_FROM_VERSION","MARKET_PLACE","UPLOADED"]},"status":{"type":"string","description":"Image management stream status.\n* AVAILABLE: Image management stream is available for desktop pools/farms to be created.\n* DELETED: Image management stream is deleted.\n* DISABLED: Image management stream is disabled and no further desktop pools/farms can be created using the same.\n* FAILED: Image management stream creation has failed.\n* IN_PROGRESS: Image management stream creation is in progress.\n* PARTIALLY_AVAILABLE: Image management version for this stream could not be created in one or more environments.\n* PENDING: Image management stream is in pending state.","example":"AVAILABLE","enum":["AVAILABLE","DELETED","DISABLED","FAILED","IN_PROGRESS","PARTIALLY_AVAILABLE","PENDING"]}},"description":"Image management stream object to be updated."},"ImageManagementTagCreateSpec":{"required":["im_stream_id","im_version_id","name"],"type":"object","properties":{"additional_details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details about image management tag."},"description":"Additional details about image management tag."},"im_stream_id":{"type":"string","description":"Image management stream ID to which this tag belongs.","example":"abc16e8f-9ba0-4789-a5dd-6880f32c52df"},"im_version_id":{"type":"string","description":"Image management version ID to which this tag belongs.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Image management tag name. It is unique among all the tags of a stream.","example":"PROD"}},"description":"Image management tag object to be created."},"ImageManagementTagInfo":{"type":"object","properties":{"additional_details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details about image management tag."},"description":"Additional details about image management tag."},"description":{"type":"string","description":"Image management tag description.\nSupported Filters : 'Equals','Contains','StartsWith'.\nThis property can be used for sorting."},"id":{"type":"string","description":"Unique ID representing image management tag.\nSupported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"im_stream_id":{"type":"string","description":"Image management stream ID to which this tag belongs.\nSupported Filters : 'Equals'.","example":"abc16e8f-9ba0-4789-a5dd-6880f32c52df"},"im_version_id":{"type":"string","description":"Image management version ID to which this tag belongs.\nSupported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"name":{"type":"string","description":"Image management tag name.\nSupported Filters : 'Equals','Contains','StartsWith'.\nThis property can be used for sorting.","example":"STAGE"}},"description":"Information related to image management tag.\nSupported Filters :'And', 'Or', 'Equals', 'StartsWith', 'Contains'."},"ImageManagementTagUpdateSpec":{"required":["im_version_id","name"],"type":"object","properties":{"additional_details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details about image management tag."},"description":"Additional details about image management tag."},"im_version_id":{"type":"string","description":"Image management version ID to which this tag belongs.","example":"7e85b3a5-e7d0-4ad6-a1e3-37168dd1ed62"},"name":{"pattern":"[a-zA-Z0-9_-]{1,64}","type":"string","description":"Image management tag name.","example":"PROD"}},"description":"Image management tag object to be updated."},"ImageManagementVersionCreateSpec":{"required":["im_stream_id","name","status"],"type":"object","properties":{"additional_details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details about image management version."},"description":"Additional details about image management version."},"description":{"pattern":"[\\S\\s]{0,1024}","type":"string","description":"Image management version description."},"im_stream_id":{"type":"string","description":"Image management stream ID","example":"abc16e8f-9ba0-4789-a5dd-6880f32c52df"},"name":{"pattern":"[a-zA-Z0-9_.-]{1,64}","type":"string","description":"Image management version name.","example":"v1"},"status":{"type":"string","description":"Image management version status.\n* AVAILABLE: Image management version is available for desktop pools/farms to be created.\n* DELETED: Image management version has been deleted.\n* DEPLOYING_VM: Image management version is deploying VM on the selected pod.\n* DEPLOYMENT_DONE: Image management version status when VM deployment is done for the selected pod.\n* DISABLED: Image management version has been disabled and no further pool operation can be done using the same.\n* FAILED: Image management version creation has failed.\n* PARTIALLY_AVAILABLE: Some of the image management asset creation in some of the virtual centers have failed.\n* PUBLISHING: Image management version is being published and specialized internally like installing agents etc.\n* REPLICATING: Copying the specialized images across all virtual centers.","example":"AVAILABLE","enum":["AVAILABLE","DELETED","DEPLOYING_VM","DEPLOYMENT_DONE","DISABLED","FAILED","PARTIALLY_AVAILABLE","PUBLISHING","REPLICATING"]}},"description":"Image management version object to be created."},"ImageManagementVersionInfo":{"required":["status"],"type":"object","properties":{"additional_details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details about image management version."},"description":"Additional details about image management version."},"description":{"type":"string","description":"Image management version description.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting."},"id":{"type":"string","description":"Unique ID representing image management version.\nSupported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"im_stream_id":{"type":"string","description":"Image management stream ID\nSupported Filters : 'Equals'.","example":"abc16e8f-9ba0-4789-a5dd-6880f32c52df"},"name":{"type":"string","description":"Image management version name.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting.","example":"v1"},"status":{"type":"string","description":"Image management version status.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.\n* AVAILABLE: Image management version is available for desktop pools/farms to be created.\n* DELETED: Image management version has been deleted.\n* DEPLOYING_VM: Image management version is deploying VM on the selected pod.\n* DEPLOYMENT_DONE: Image management version status when VM deployment is done for the selected pod.\n* DISABLED: Image management version has been disabled and no further pool operation can be done using the same.\n* FAILED: Image management version creation has failed.\n* PARTIALLY_AVAILABLE: Some of the image management asset creation in some of the virtual centers have failed.\n* PUBLISHING: Image management version is being published and specialized internally like installing agents etc.\n* REPLICATING: Copying the specialized images across all virtual centers.","example":"AVAILABLE","enum":["AVAILABLE","DELETED","DEPLOYING_VM","DEPLOYMENT_DONE","DISABLED","FAILED","PARTIALLY_AVAILABLE","PUBLISHING","REPLICATING"]}},"description":"Information related to image management version.\nSupported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'."},"ImageManagementVersionUpdateSpec":{"required":["name","status"],"type":"object","properties":{"additional_details":{"type":"object","additionalProperties":{"type":"string","description":"Additional details about image management version."},"description":"Additional details about image management version."},"description":{"pattern":"[\\S\\s]{0,1024}","type":"string","description":"Image management version description."},"name":{"pattern":"[a-zA-Z0-9_.-]{1,64}","type":"string","description":"Image management version name.","example":"v1"},"status":{"type":"string","description":"Image management version status.\n* AVAILABLE: Image management version is available for desktop pools/farms to be created.\n* DELETED: Image management version has been deleted.\n* DEPLOYING_VM: Image management version is deploying VM on the selected pod.\n* DEPLOYMENT_DONE: Image management version status when VM deployment is done for the selected pod.\n* DISABLED: Image management version has been disabled and no further pool operation can be done using the same.\n* FAILED: Image management version creation has failed.\n* PARTIALLY_AVAILABLE: Some of the image management asset creation in some of the virtual centers have failed.\n* PUBLISHING: Image management version is being published and specialized internally like installing agents etc.\n* REPLICATING: Copying the specialized images across all virtual centers.","example":"AVAILABLE","enum":["AVAILABLE","DELETED","DEPLOYING_VM","DEPLOYMENT_DONE","DISABLED","FAILED","PARTIALLY_AVAILABLE","PUBLISHING","REPLICATING"]}},"description":"Image management version object to be updated."},"InstalledApplicationInfo":{"type":"object","properties":{"executable_path":{"type":"string","description":"Path to application executable.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk"},"file_types":{"uniqueItems":true,"type":"array","description":"Set of file types reported by the application as supported. If unset, this application does not present any file type support.","items":{"$ref":"#/components/schemas/ApplicationFileTypeData"}},"name":{"type":"string","description":"Application name information, as sent by RDSServer/machine during application discovery.","example":"Firefox"},"other_file_types":{"uniqueItems":true,"type":"array","description":"This represents the different file types reported by Application that can be passed from horizon agent to horizon client via connection server. If unset, this application does not present any other file type support.","items":{"$ref":"#/components/schemas/ApplicationOtherFileTypeData"}},"publisher":{"type":"string","description":"Application publisher","example":"Mozilla Corporation"},"version":{"type":"string","description":"Application version.","example":"72.0.2"}},"description":"Information about the application installed on RDS server/machine of a farm/desktop pool."},"InstalledApplicationValidationInfo":{"type":"object","properties":{"application_exe_path":{"type":"string","description":"Application executable path.","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Accessibility\\Speech Recognition.lnk"},"machine_or_rds_server_ids":{"type":"array","description":"Machine/RDS server ids on which this application has not been installed on. This will be populated only when application is not installed on one or more RDS servers/machines.","example":["c617fd51-e118-4cae-970c-54a7144aaadc","bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"],"items":{"type":"string","description":"Machine/RDS server ids on which this application has not been installed on. This will be populated only when application is not installed on one or more RDS servers/machines.","example":"[\"c617fd51-e118-4cae-970c-54a7144aaadc\",\"bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c\"]"}},"status":{"type":"string","description":"Status of application installation on all RDS servers/machines.\n* SUCCESS: The given application is installed on all RDS Servers/machines of a given farm/desktop pool.\n* NOT_INSTALLED: The given application is not installed on one or more RDS Servers/machines of a given farm/desktop pool.","example":"SUCCESS","enum":["SUCCESS","NOT_INSTALLED"]}},"description":"Information about the application installed on RDS server/machine of a farm/desktop pool based on a given application execution path."},"InstantCloneDomainAccountCreateSpec":{"required":["ad_domain_id","password","username"],"type":"object","properties":{"ad_domain_id":{"type":"string","description":"SID of the AD Domain that this account user belongs to.","example":"S-1-5-21-1085031214-1563985344-725345543"},"password":{"type":"array","description":"Password of the account.","example":"<password>","items":{"type":"string","description":"Password of the account.","example":"<password>"}},"username":{"type":"string","description":"User name of the account.","example":"testuser"}},"description":"Instant clone domain account object to be created."},"InstantCloneDomainAccountInfo":{"type":"object","properties":{"ad_domain_id":{"type":"string","description":"SID of the AD Domain that this account user belongs to.","example":"S-1-5-21-1085031214-1563985344-725345543"},"id":{"type":"string","description":"Unique ID representing instant clone domain account.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"username":{"type":"string","description":"User name of the account.","example":"testuser"}},"description":"Information related to instant clone domain accounts of the environment."},"InstantCloneDomainAccountInfoV2":{"type":"object","properties":{"ad_domain_id":{"type":"string","description":"SID of the AD Domain that this account user belongs to.","example":"S-1-5-21-1085031214-1563985344-725345543"},"dns_name":{"type":"string","description":"FQDN of the domain","example":"Example.net"},"id":{"type":"string","description":"Unique ID representing instant clone domain account.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"username":{"type":"string","description":"User name of the account.","example":"testuser"}},"description":"Information related to instant clone domain accounts of the environment."},"InstantCloneDomainAccountUpdateSpec":{"required":["password"],"type":"object","properties":{"password":{"type":"array","description":"Password of the account.","example":"<password>","items":{"type":"string","description":"Password of the account.","example":"<password>"}}},"description":"Instant clone domain account object to be updated."},"JWTAuthenticatorAssociationSpec":{"required":["connection_server_id","jwt_support"],"type":"object","properties":{"connection_server_id":{"type":"string","description":"Connection server ID"},"jwt_support":{"type":"string","description":"JWT support state to set on connection servers\n* DISABLED: Indicates that the JWT support is disabled.\n* MULTI_ENABLED: Indicates that the JWT multi-auth support is enabled.\n* MULTI_REQUIRED: Indicates that the JWT multi-auth support is mandatory.","enum":["DISABLED","MULTI_ENABLED","MULTI_REQUIRED"]}},"description":"Request specification for associating JWT authenticator with connection servers"},"JWTAuthenticatorCreateSpec":{"required":["issuer","name"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of this JWT authenticator.","example":"Jwt Authenticator Description"},"issuer":{"maxLength":256,"minLength":0,"type":"string","description":"The issuer of this JWT authenticator. The configured value is matched against the \"iss\" claim of the JWT.","example":"portal"},"name":{"maxLength":32,"minLength":0,"type":"string","description":"The name of the JWT authenticator. It must be unique among all other JWT authenticators.","example":"Jwt Authenticator"},"public_keys":{"uniqueItems":true,"type":"array","description":"The publicKeys as Json strings for this JWT authenticator. If \"publicKeys\" is blank, then \"url\" must not be blank.","example":["{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"],"items":{"type":"string","description":"The publicKeys as Json strings for this JWT authenticator. If \"publicKeys\" is blank, then \"url\" must not be blank.","example":"[\"{\\\"kid\\\":\\\"keyId\\\",\\\"kty\\\":\\\"RSA\\\",\\\"n\\\":\\\"modulus\\\",\\\"e\\\":\\\"exponent\\\"}\"]"}},"url":{"maxLength":2096,"minLength":0,"type":"string","description":"The URL to fetch the public keys for this authenticator. If \"url\" is blank, then \"publicKeys\" must not be blank.","example":"https://example.com/portal/.well-known/openid-configuration"}},"description":"JWT authenticator object to be created."},"JWTAuthenticatorCreateSpecV2":{"required":["issuer","name"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of this JWT authenticator.","example":"Jwt Authenticator Description"},"issuer":{"maxLength":256,"minLength":0,"type":"string","description":"The issuer of this JWT authenticator. The configured value is matched against the \"iss\" claim of the JWT.","example":"portal"},"name":{"maxLength":32,"minLength":0,"type":"string","description":"The name of the JWT authenticator. It must be unique among all other JWT authenticators.","example":"Jwt Authenticator"},"pod_level_enabled":{"type":"boolean","description":"Indicates if the authenticator is enabled at pod level. Default is false","example":true},"public_keys":{"uniqueItems":true,"type":"array","description":"The publicKeys as Json strings for this JWT authenticator. If \"publicKeys\" is blank, then \"url\" must not be blank.","example":["{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"],"items":{"type":"string","description":"The publicKeys as Json strings for this JWT authenticator. If \"publicKeys\" is blank, then \"url\" must not be blank.","example":"[\"{\\\"kid\\\":\\\"keyId\\\",\\\"kty\\\":\\\"RSA\\\",\\\"n\\\":\\\"modulus\\\",\\\"e\\\":\\\"exponent\\\"}\"]"}},"url":{"maxLength":2096,"minLength":0,"type":"string","description":"The URL to fetch the public keys for this authenticator. If \"url\" is blank, then \"publicKeys\" must not be blank.","example":"https://example.com/portal/.well-known/openid-configuration"},"user_sid":{"type":"string","description":"Admin Account SID that can update keys."}},"description":"JWT authenticator object to be created."},"JWTAuthenticatorInfo":{"type":"object","properties":{"description":{"type":"string","description":"The description of this JWT authenticator.","example":"Jwt Authenticator Description"},"id":{"type":"string","description":"Unique ID of this JWT authenticator.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"issuer":{"type":"string","description":"The issuer of this JWT authenticator. The configured value is matched against the \"iss\" claim of the JWT.","example":"portal"},"name":{"type":"string","description":"The name of this JWT authenticator.","example":"Jwt Authenticator"},"public_keys":{"uniqueItems":true,"type":"array","description":"The stored public keys for this JWT authenticator.","example":["{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"],"items":{"type":"string","description":"The stored public keys for this JWT authenticator.","example":"[\"{\\\"kid\\\":\\\"keyId\\\",\\\"kty\\\":\\\"RSA\\\",\\\"n\\\":\\\"modulus\\\",\\\"e\\\":\\\"exponent\\\"}\"]"}},"url":{"type":"string","description":"The URL to fetch the public keys for this authenticator.","example":"https://example.com/portal/.well-known/openid-configuration"}},"description":"Information about JWT authenticator."},"JWTAuthenticatorInfoV2":{"type":"object","properties":{"description":{"type":"string","description":"The description of this JWT authenticator.","example":"Jwt Authenticator Description"},"id":{"type":"string","description":"Unique ID of this JWT authenticator.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"issuer":{"type":"string","description":"The issuer of this JWT authenticator. The configured value is matched against the \"iss\" claim of the JWT.","example":"portal"},"name":{"type":"string","description":"The name of this JWT authenticator.","example":"Jwt Authenticator"},"pod_level_enabled":{"type":"boolean","description":"Indicates if the authenticator is enabled at pod level.","example":true},"public_keys":{"uniqueItems":true,"type":"array","description":"The stored public keys for this JWT authenticator.","example":["{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"],"items":{"type":"string","description":"The stored public keys for this JWT authenticator.","example":"[\"{\\\"kid\\\":\\\"keyId\\\",\\\"kty\\\":\\\"RSA\\\",\\\"n\\\":\\\"modulus\\\",\\\"e\\\":\\\"exponent\\\"}\"]"}},"url":{"type":"string","description":"The URL to fetch the public keys for this authenticator.","example":"https://example.com/portal/.well-known/openid-configuration"},"user_sid":{"type":"string","description":"Admin Account SID that can update keys."}},"description":"Information about JWT authenticator."},"JWTAuthenticatorRefreshKeysSpec":{"required":["issuer"],"type":"object","properties":{"issuer":{"maxLength":256,"minLength":0,"type":"string","description":"The issuer of this JWT authenticator. The configured value is matched against the \"iss\" claim of the JWT.","example":"portal"},"public_keys":{"uniqueItems":true,"type":"array","description":"The publicKeys for this JWT authenticator.","example":["{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"],"items":{"type":"string","description":"The publicKeys for this JWT authenticator.","example":"[\"{\\\"kid\\\":\\\"keyId\\\",\\\"kty\\\":\\\"RSA\\\",\\\"n\\\":\\\"modulus\\\",\\\"e\\\":\\\"exponent\\\"}\"]"}}},"description":"Specification object containing the issuer and public keys."},"JWTAuthenticatorUpdateSpec":{"required":["issuer","name"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of this JWT authenticator.","example":"Jwt Authenticator Description"},"issuer":{"maxLength":256,"minLength":0,"type":"string","description":"The issuer of this JWT authenticator. The configured value is matched against the \"iss\" claim of the JWT.","example":"portal"},"name":{"maxLength":32,"minLength":0,"type":"string","description":"The name of the JWT authenticator. It must be unique among all other JWT authenticators.","example":"Jwt Authenticator"},"public_keys":{"uniqueItems":true,"type":"array","description":"The publicKeys as Json strings for this JWT authenticator. If \"publicKeys\" is blank, then \"url\" must not be blank.","example":["{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"],"items":{"type":"string","description":"The publicKeys as Json strings for this JWT authenticator. If \"publicKeys\" is blank, then \"url\" must not be blank.","example":"[\"{\\\"kid\\\":\\\"keyId\\\",\\\"kty\\\":\\\"RSA\\\",\\\"n\\\":\\\"modulus\\\",\\\"e\\\":\\\"exponent\\\"}\"]"}},"url":{"maxLength":2096,"minLength":0,"type":"string","description":"The URL to fetch the public keys for this authenticator. If \"url\" is blank, then \"publicKeys\" must not be blank.","example":"https://example.com/portal/.well-known/openid-configuration"}},"description":"JWT authenticator object to be updated."},"JWTAuthenticatorUpdateSpecV2":{"required":["issuer","name","pod_level_enabled"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of this JWT authenticator.","example":"Jwt Authenticator Description"},"issuer":{"maxLength":256,"minLength":0,"type":"string","description":"The issuer of this JWT authenticator. The configured value is matched against the \"iss\" claim of the JWT.","example":"portal"},"name":{"maxLength":32,"minLength":0,"type":"string","description":"The name of the JWT authenticator. It must be unique among all other JWT authenticators.","example":"Jwt Authenticator"},"pod_level_enabled":{"type":"boolean","description":"Indicates if the authenticator is enabled at pod level.","example":true},"public_keys":{"uniqueItems":true,"type":"array","description":"The publicKeys as Json strings for this JWT authenticator. If \"publicKeys\" is blank, then \"url\" must not be blank.","example":["{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"],"items":{"type":"string","description":"The publicKeys as Json strings for this JWT authenticator. If \"publicKeys\" is blank, then \"url\" must not be blank.","example":"[\"{\\\"kid\\\":\\\"keyId\\\",\\\"kty\\\":\\\"RSA\\\",\\\"n\\\":\\\"modulus\\\",\\\"e\\\":\\\"exponent\\\"}\"]"}},"url":{"maxLength":2096,"minLength":0,"type":"string","description":"The URL to fetch the public keys for this authenticator. If \"url\" is blank, then \"publicKeys\" must not be blank.","example":"https://example.com/portal/.well-known/openid-configuration"},"user_sid":{"type":"string","description":"Admin Account SID that can update keys."}},"description":"JWT authenticator object to be updated."},"LicenseInfo":{"type":"object","properties":{"application_pool_launch_enabled":{"type":"boolean","description":"Whether application pool launch is enabled.","example":false},"desktop_pool_launch_enabled":{"type":"boolean","description":"Whether desktop pool launch is enabled.","example":false},"expiration_time":{"type":"integer","description":"The expiration date of the license. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","format":"int64","example":1656527400000},"grace_period_days":{"type":"integer","description":"The grace period in days. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","format":"int32","example":100},"help_desk_enabled":{"type":"boolean","description":"Whether help desk is enabled.","example":false},"instant_clone_enabled":{"type":"boolean","description":"Whether instant clone is enabled.","example":true},"license_edition":{"type":"string","description":"The license edition. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.\n* ENTERPRISE_CONCURRENT_USER: VMware Enterprise.\n* HORIZON_ADVANCED_CONCURRENT_USER: VMware Horizon Advanced (Concurrent User).\n* HORIZON_ADVANCED_NAMED_USER: VMware Horizon Advanced (Named User).\n* HORIZON_APPS_ADVANCED_CONCURRENT_USER: Mware Horizon Apps 7 Advanced (Concurrent User).\n* HORIZON_APPS_ADVANCED_NAMED_USER: VMware Horizon Apps 7 Advanced (Named User).\n* HORIZON_APPS_STANDARD_CONCURRENT_USER: VMware Horizon Apps 7 Standard  (Concurrent User).\n* HORIZON_APPS_STANDARD_NAMED_USER: VMware Horizon Apps 7 Standard (Named User).\n* HORIZON_ENTERPRISE_CONCURRENT_USER: Horizon Enterprise (Concurrent User).\n* HORIZON_ENTERPRISE_NAMED_USER: Horizon Enterprise (Named User).\n* HORIZON_STANDARD_CONCURRENT_USER: VMware Horizon Standard  (Concurrent User).\n* WS1_ENTERPRISE_NAMED_USER: Workspace ONE Enterprise.\n* WS1_ENTERPRISE_WITH_VDI_NAMED_USER: Workspace ONE Enterprise with VDI.","example":"HORIZON_STANDARD_CONCURRENT_USER","enum":["ENTERPRISE_CONCURRENT_USER","HORIZON_ADVANCED_CONCURRENT_USER","HORIZON_ADVANCED_NAMED_USER","HORIZON_APPS_ADVANCED_CONCURRENT_USER","HORIZON_APPS_ADVANCED_NAMED_USER","HORIZON_APPS_STANDARD_CONCURRENT_USER","HORIZON_APPS_STANDARD_NAMED_USER","HORIZON_ENTERPRISE_CONCURRENT_USER","HORIZON_ENTERPRISE_NAMED_USER","HORIZON_STANDARD_CONCURRENT_USER","WS1_ENTERPRISE_NAMED_USER","WS1_ENTERPRISE_WITH_VDI_NAMED_USER"]},"license_health":{"type":"string","description":"The license health. The property will only be set when license_mode is set to SUBSCRIPTION. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.\n* GREEN: License is not expired.\n* RED: License is expired.\n* YELLOW: License is expiring.","example":"GREEN","enum":["GREEN","RED","YELLOW"]},"license_key":{"type":"string","description":"The license key in partially redacted form. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","example":"KHJL-XXXXX-XXXXX-XXXXX-E3HNJ"},"license_mode":{"type":"string","description":"The license mode used. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.\n* DEFAULT: Perpetual license is in use.\n* PERPETUAL_ONLY: Perpetual license is in use.\n* SUBSCRIPTION: Cloud subscription license is in use.","example":"SUBSCRIPTION","enum":["DEFAULT","PERPETUAL_ONLY","SUBSCRIPTION"]},"licensed":{"type":"boolean","description":"Whether the horizon is licensed.","example":true},"session_collaboration_enabled":{"type":"boolean","description":"Whether session collaboration is enabled.","example":true},"subscription_slice_expiry":{"type":"integer","description":"The expiry of subscription slice. The property will only be set  when license_mode is set to SUBSCRIPTION. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","format":"int64","example":1465711500000},"usage_model":{"type":"string","description":"TThe usage model for this license.\n* CONCURRENT_USER: The is the license usage model for a standalone install.\n* NAMED_USER: This is the license usage model for an install as part of a suite.","example":"NAMED_USER","enum":["CONCURRENT_USER","NAMED_USER"]}},"description":"Information about a license."},"LicenseInfoV2":{"type":"object","properties":{"agent_auto_upgrade_enabled":{"type":"boolean","description":"Indicates whether agent auto upgrade is enabled.","example":true},"application_pool_launch_enabled":{"type":"boolean","description":"Whether application pool launch is enabled.","example":false},"desktop_pool_launch_enabled":{"type":"boolean","description":"Whether desktop pool launch is enabled.","example":false},"expiration_time":{"type":"integer","description":"The expiration date of the license. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","format":"int64","example":1656527400000},"grace_period_days":{"type":"integer","description":"The grace period in days. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","format":"int32","example":100},"help_desk_enabled":{"type":"boolean","description":"Whether help desk is enabled.","example":false},"instant_clone_enabled":{"type":"boolean","description":"Whether instant clone is enabled.","example":true},"license_edition":{"type":"string","description":"The license edition. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.\n* ENTERPRISE_CONCURRENT_USER: VMware Enterprise.\n* HORIZON_ADVANCED_CONCURRENT_USER: VMware Horizon Advanced (Concurrent User).\n* HORIZON_ADVANCED_NAMED_USER: VMware Horizon Advanced (Named User).\n* HORIZON_APPS_ADVANCED_CONCURRENT_USER: Mware Horizon Apps 7 Advanced (Concurrent User).\n* HORIZON_APPS_ADVANCED_NAMED_USER: VMware Horizon Apps 7 Advanced (Named User).\n* HORIZON_APPS_STANDARD_CONCURRENT_USER: VMware Horizon Apps 7 Standard  (Concurrent User).\n* HORIZON_APPS_STANDARD_NAMED_USER: VMware Horizon Apps 7 Standard (Named User).\n* HORIZON_ENTERPRISE_CONCURRENT_USER: Horizon Enterprise (Concurrent User).\n* HORIZON_ENTERPRISE_NAMED_USER: Horizon Enterprise (Named User).\n* HORIZON_STANDARD_CONCURRENT_USER: VMware Horizon Standard  (Concurrent User).\n* WS1_ENTERPRISE_NAMED_USER: Workspace ONE Enterprise.\n* WS1_ENTERPRISE_WITH_VDI_NAMED_USER: Workspace ONE Enterprise with VDI.","example":"HORIZON_STANDARD_CONCURRENT_USER","enum":["ENTERPRISE_CONCURRENT_USER","HORIZON_ADVANCED_CONCURRENT_USER","HORIZON_ADVANCED_NAMED_USER","HORIZON_APPS_ADVANCED_CONCURRENT_USER","HORIZON_APPS_ADVANCED_NAMED_USER","HORIZON_APPS_STANDARD_CONCURRENT_USER","HORIZON_APPS_STANDARD_NAMED_USER","HORIZON_ENTERPRISE_CONCURRENT_USER","HORIZON_ENTERPRISE_NAMED_USER","HORIZON_STANDARD_CONCURRENT_USER","WS1_ENTERPRISE_NAMED_USER","WS1_ENTERPRISE_WITH_VDI_NAMED_USER"]},"license_health":{"type":"string","description":"The license health. The property will only be set when license_mode is set to SUBSCRIPTION. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.\n* GREEN: License is not expired.\n* RED: License is expired.\n* YELLOW: License is expiring.","example":"GREEN","enum":["GREEN","RED","YELLOW"]},"license_key":{"type":"string","description":"The license key in partially redacted form. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","example":"KHJL-XXXXX-XXXXX-XXXXX-E3HNJ"},"license_mode":{"type":"string","description":"The license mode used. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.\n* DEFAULT: Perpetual license is in use.\n* PERPETUAL_ONLY: Perpetual license is in use.\n* SUBSCRIPTION: Cloud subscription license is in use.","example":"SUBSCRIPTION","enum":["DEFAULT","PERPETUAL_ONLY","SUBSCRIPTION"]},"licensed":{"type":"boolean","description":"Whether the horizon is licensed.","example":true},"session_collaboration_enabled":{"type":"boolean","description":"Whether session collaboration is enabled.","example":true},"subscription_slice_expiry":{"type":"integer","description":"The expiry of subscription slice. The property will only be set  when license_mode is set to SUBSCRIPTION. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","format":"int64","example":1465711500000},"usage_model":{"type":"string","description":"TThe usage model for this license.\n* CONCURRENT_USER: The is the license usage model for a standalone install.\n* NAMED_USER: This is the license usage model for an install as part of a suite.","example":"NAMED_USER","enum":["CONCURRENT_USER","NAMED_USER"]}},"description":"Information about a license."},"LicenseInfoV3":{"type":"object","properties":{"agent_auto_upgrade_enabled":{"type":"boolean","description":"Indicates whether agent auto upgrade is enabled.","example":true},"application_pool_launch_enabled":{"type":"boolean","description":"Whether application pool launch is enabled.","example":false},"consent":{"type":"boolean","description":"Specifies for a perpetual key if the admin has provided a consent stating that the admin owns this perpetual key and have no other Horizon license.","example":true},"desktop_pool_launch_enabled":{"type":"boolean","description":"Whether desktop pool launch is enabled.","example":false},"expiration_time":{"type":"integer","description":"The expiration date of the license. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","format":"int64","example":1656527400000},"grace_period_days":{"type":"integer","description":"The grace period in days. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","format":"int32","example":100},"help_desk_enabled":{"type":"boolean","description":"Whether help desk is enabled.","example":false},"instant_clone_enabled":{"type":"boolean","description":"Whether instant clone is enabled.","example":true},"license_edition":{"type":"string","description":"The license edition. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.\n* ENTERPRISE_CONCURRENT_USER: VMware Enterprise.\n* HORIZON_ADVANCED_CONCURRENT_USER: VMware Horizon Advanced (Concurrent User).\n* HORIZON_ADVANCED_NAMED_USER: VMware Horizon Advanced (Named User).\n* HORIZON_APPS_ADVANCED_CONCURRENT_USER: Mware Horizon Apps 7 Advanced (Concurrent User).\n* HORIZON_APPS_ADVANCED_NAMED_USER: VMware Horizon Apps 7 Advanced (Named User).\n* HORIZON_APPS_STANDARD_CONCURRENT_USER: VMware Horizon Apps 7 Standard  (Concurrent User).\n* HORIZON_APPS_STANDARD_NAMED_USER: VMware Horizon Apps 7 Standard (Named User).\n* HORIZON_ENTERPRISE_CONCURRENT_USER: Horizon Enterprise (Concurrent User).\n* HORIZON_ENTERPRISE_NAMED_USER: Horizon Enterprise (Named User).\n* HORIZON_STANDARD_CONCURRENT_USER: VMware Horizon Standard  (Concurrent User).\n* WS1_ENTERPRISE_NAMED_USER: Workspace ONE Enterprise.\n* WS1_ENTERPRISE_WITH_VDI_NAMED_USER: Workspace ONE Enterprise with VDI.","example":"HORIZON_STANDARD_CONCURRENT_USER","enum":["ENTERPRISE_CONCURRENT_USER","HORIZON_ADVANCED_CONCURRENT_USER","HORIZON_ADVANCED_NAMED_USER","HORIZON_APPS_ADVANCED_CONCURRENT_USER","HORIZON_APPS_ADVANCED_NAMED_USER","HORIZON_APPS_STANDARD_CONCURRENT_USER","HORIZON_APPS_STANDARD_NAMED_USER","HORIZON_ENTERPRISE_CONCURRENT_USER","HORIZON_ENTERPRISE_NAMED_USER","HORIZON_STANDARD_CONCURRENT_USER","WS1_ENTERPRISE_NAMED_USER","WS1_ENTERPRISE_WITH_VDI_NAMED_USER"]},"license_health":{"type":"string","description":"The license health. The property will only be set when license_mode is set to SUBSCRIPTION. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.\n* GREEN: License is not expired.\n* RED: License is expired.\n* YELLOW: License is expiring.","example":"GREEN","enum":["GREEN","RED","YELLOW"]},"license_key":{"type":"string","description":"The license key in partially redacted form. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","example":"KHJL-XXXXX-XXXXX-XXXXX-E3HNJ"},"license_mode":{"type":"string","description":"The license mode used. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.\n* DEFAULT: Perpetual license is in use.\n* PERPETUAL_ONLY: Perpetual license is in use.\n* SUBSCRIPTION: Cloud subscription license is in use.","example":"SUBSCRIPTION","enum":["DEFAULT","PERPETUAL_ONLY","SUBSCRIPTION"]},"license_sync_time":{"type":"integer","description":"Set only when licenseMode is set to SUBSCRIPTION. Last time when subscription license was synced.","format":"int64","example":1656527400000},"licensed":{"type":"boolean","description":"Whether the horizon is licensed.","example":true},"originator":{"type":"boolean","description":"Set only when licenseMode is set to SUBSCRIPTION. Originator of set subscription license request. True = Edge and False = Non-Edge/Unknown.","example":true},"session_collaboration_enabled":{"type":"boolean","description":"Whether session collaboration is enabled.","example":true},"subscription_slice_expiry":{"type":"integer","description":"The expiry of subscription slice. The property will only be set  when license_mode is set to SUBSCRIPTION. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","format":"int64","example":1465711500000},"usage_model":{"type":"string","description":"TThe usage model for this license.\n* CONCURRENT_USER: The is the license usage model for a standalone install.\n* NAMED_USER: This is the license usage model for an install as part of a suite.","example":"NAMED_USER","enum":["CONCURRENT_USER","NAMED_USER"]}},"description":"Information about a license."},"LicenseInfoV4":{"type":"object","properties":{"agent_auto_upgrade_enabled":{"type":"boolean","description":"Indicates whether agent auto upgrade is enabled.","example":true},"application_pool_launch_enabled":{"type":"boolean","description":"Whether application pool launch is enabled.","example":false},"consent":{"type":"boolean","description":"Specifies for a perpetual key if the admin has provided a consent stating that the admin owns this perpetual key and have no other Horizon license.","example":true},"days_remaining_to_migrate_license_key":{"type":"integer","description":"The number of days left to update the Omnissa license key.","format":"int32","example":60},"desktop_pool_launch_enabled":{"type":"boolean","description":"Whether desktop pool launch is enabled.","example":false},"expiration_time":{"type":"integer","description":"The expiration date of the license. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","format":"int64","example":1656527400000},"grace_period_days":{"type":"integer","description":"The grace period in days. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","format":"int32","example":100},"help_desk_enabled":{"type":"boolean","description":"Whether help desk is enabled.","example":false},"instant_clone_enabled":{"type":"boolean","description":"Whether instant clone is enabled.","example":true},"license_edition":{"type":"string","description":"The license edition. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.\n* ENTERPRISE_CONCURRENT_USER: VMware Enterprise.\n* HORIZON_ADVANCED_CONCURRENT_USER: VMware Horizon Advanced (Concurrent User).\n* HORIZON_ADVANCED_NAMED_USER: VMware Horizon Advanced (Named User).\n* HORIZON_APPS_ADVANCED_CONCURRENT_USER: Mware Horizon Apps 7 Advanced (Concurrent User).\n* HORIZON_APPS_ADVANCED_NAMED_USER: VMware Horizon Apps 7 Advanced (Named User).\n* HORIZON_APPS_STANDARD_CONCURRENT_USER: VMware Horizon Apps 7 Standard  (Concurrent User).\n* HORIZON_APPS_STANDARD_NAMED_USER: VMware Horizon Apps 7 Standard (Named User).\n* HORIZON_ENTERPRISE_CONCURRENT_USER: Horizon Enterprise (Concurrent User).\n* HORIZON_ENTERPRISE_NAMED_USER: Horizon Enterprise (Named User).\n* HORIZON_STANDARD_CONCURRENT_USER: VMware Horizon Standard  (Concurrent User).\n* WS1_ENTERPRISE_NAMED_USER: Workspace ONE Enterprise.\n* WS1_ENTERPRISE_WITH_VDI_NAMED_USER: Workspace ONE Enterprise with VDI.","example":"HORIZON_STANDARD_CONCURRENT_USER","enum":["ENTERPRISE_CONCURRENT_USER","HORIZON_ADVANCED_CONCURRENT_USER","HORIZON_ADVANCED_NAMED_USER","HORIZON_APPS_ADVANCED_CONCURRENT_USER","HORIZON_APPS_ADVANCED_NAMED_USER","HORIZON_APPS_STANDARD_CONCURRENT_USER","HORIZON_APPS_STANDARD_NAMED_USER","HORIZON_ENTERPRISE_CONCURRENT_USER","HORIZON_ENTERPRISE_NAMED_USER","HORIZON_STANDARD_CONCURRENT_USER","WS1_ENTERPRISE_NAMED_USER","WS1_ENTERPRISE_WITH_VDI_NAMED_USER"]},"license_health":{"type":"string","description":"The license health. The property will only be set when license_mode is set to SUBSCRIPTION. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.\n* GREEN: License is not expired.\n* RED: License is expired.\n* YELLOW: License is expiring.","example":"GREEN","enum":["GREEN","RED","YELLOW"]},"license_key":{"type":"string","description":"The license key in partially redacted form. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","example":"KHJL-XXXXX-XXXXX-XXXXX-E3HNJ"},"license_mode":{"type":"string","description":"The license mode used. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.\n* DEFAULT: Perpetual license is in use.\n* PERPETUAL_ONLY: Perpetual license is in use.\n* SUBSCRIPTION: Cloud subscription license is in use.","example":"SUBSCRIPTION","enum":["DEFAULT","PERPETUAL_ONLY","SUBSCRIPTION"]},"license_sync_time":{"type":"integer","description":"Set only when licenseMode is set to SUBSCRIPTION. Last time when subscription license was synced.","format":"int64","example":1656527400000},"licensed":{"type":"boolean","description":"Whether the horizon is licensed.","example":true},"originator":{"type":"boolean","description":"Set only when licenseMode is set to SUBSCRIPTION. Originator of set subscription license request. True = Edge and False = Non-Edge/Unknown.","example":true},"session_collaboration_enabled":{"type":"boolean","description":"Whether session collaboration is enabled.","example":true},"subscription_slice_expiry":{"type":"integer","description":"The expiry of subscription slice. The property will only be set  when license_mode is set to SUBSCRIPTION. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.","format":"int64","example":1465711500000},"usage_model":{"type":"string","description":"TThe usage model for this license.\n* CONCURRENT_USER: The is the license usage model for a standalone install.\n* NAMED_USER: This is the license usage model for an install as part of a suite.","example":"NAMED_USER","enum":["CONCURRENT_USER","NAMED_USER"]}},"description":"Information about a license."},"LicenseKeySpec":{"required":["license_key"],"type":"object","properties":{"license_key":{"type":"string","description":"The license key to set.","example":"Z16CH-J2QDL-P8TJT-0CX2M-949MH"}},"description":"The specification to set the license key."},"LicenseKeySpecV3":{"required":["license_key"],"type":"object","properties":{"consent":{"type":"boolean","description":"Specifies for a perpetual key if the admin has provided a consent stating that the admin owns this perpetual key and have no other Horizon license."},"license_key":{"type":"string","description":"The license key to set.","example":"Z16CH-J2QDL-P8TJT-0CX2M-949MH"}},"description":"The specification to set the license key."},"LicenseModeSpec":{"required":["license_mode"],"type":"object","properties":{"license_mode":{"type":"string","description":"The license mode used.\n* DEFAULT: Perpetual license is in use.\n* PERPETUAL_ONLY: Perpetual license is in use.\n* SUBSCRIPTION: Cloud subscription license is in use.","example":"SUBSCRIPTION","enum":["DEFAULT","PERPETUAL_ONLY","SUBSCRIPTION"]}},"description":"The specification to set the license mode."},"LicenseUsageMetricsInfo":{"type":"object","properties":{"current_usage":{"$ref":"#/components/schemas/UsageStatisticsLicensingMetrics"},"highest_usage":{"$ref":"#/components/schemas/UsageStatisticsLicensingMetrics"}},"description":"Metrics related to current and highest historical usage numbers of the product license"},"LicenseValidateInfo":{"type":"object","properties":{"expiration_time":{"type":"integer","description":"The expiration date of the license.","format":"int64","example":1656527400000},"license_mode":{"type":"string","description":"The license mode.\n* DEFAULT: Perpetual license is in use.\n* PERPETUAL_ONLY: Perpetual license is in use.\n* SUBSCRIPTION: Cloud subscription license is in use.","example":"PERPETUAL_ONLY","enum":["DEFAULT","PERPETUAL_ONLY","SUBSCRIPTION"]}},"description":"Information about validated license key."},"LoadBalancerMetricSettings":{"type":"object","properties":{"cpu_threshold":{"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0,then this metric will not be considered for load balancing. Default value is 0.","format":"int32","example":50},"disk_queue_length_threshold":{"type":"integer","description":"Represents the threshold of average number of both read and write requests that werequeued for the selected disk during the sample interval. If the value is 0,then this metric will not be considered for load balancing. Default value is 0.","format":"int32","example":50},"disk_read_latency_threshold":{"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0,then this metric will not be considered for load balancing. Default value is 0.","format":"int32","example":50},"disk_write_latency_threshold":{"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk.If the value is 0, then this metric will not be considered for load balancing. Default value is 0.","format":"int32","example":50},"include_session_count":{"type":"boolean","description":"Whether to include session count for load balancing. Default value is true.","example":true},"memory_threshold":{"type":"integer","description":"Represents threshold of memory usage, in percentage.If the value is 0, then this metric will not be considered for load balancing.","format":"int32","example":50}},"description":"Load Balancer Metric settings for Farm."},"LocalAccessGroupCreateSpec":{"required":["name"],"type":"object","properties":{"description":{"pattern":"[\\S\\s]{0,400}","type":"string","description":"Access group description.","example":"This access group can be used to delegate administration of sales team inventories to specific administrators."},"name":{"pattern":"[a-zA-Z0-9_-]{1,32}","type":"string","description":"Access group name. This property must contain only alphanumerics, underscores, and dashes.","example":"Sales"}},"description":"Local access group object to be created."},"LocalAccessGroupInfo":{"type":"object","properties":{"deletable":{"type":"boolean","description":"Indicates whether this access group can be deleted.","example":true},"description":{"type":"string","description":"Access group description.","example":"This access group can be used to delegate administration of sales team inventories to specific administrators."},"id":{"type":"string","description":"Unique ID representing this access group.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"name":{"type":"string","description":"Access group name.","example":"Sales"}},"description":"Information about a local access group."},"LocalAccessGroupInfoV2":{"type":"object","properties":{"deletable":{"type":"boolean","description":"Indicates whether this access group can be deleted.","example":true},"description":{"type":"string","description":"Access group description.","example":"This access group can be used to delegate administration of sales team inventories to specific administrators."},"id":{"type":"string","description":"Unique ID representing this access group.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"name":{"type":"string","description":"Access group name.","example":"Sales"},"permission_ids":{"type":"array","description":"List of permission ids associated with the access group","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","6fd4638a-381f-4518-aed6-042aa3d9f14c"],"items":{"type":"string","description":"List of permission ids associated with the access group","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"6fd4638a-381f-4518-aed6-042aa3d9f14c\"]"}}},"description":"Information about a local access group."},"LogCollectorCollectSpec":{"required":["component_id","component_type"],"type":"object","properties":{"component_id":{"type":"string","description":"Represents the ID of the log collector component type for which logs are to be collected.\n\nRepresents CS id if CS logs are collected, Machine id if Agent logs are collected and\n\nRDS server id if Agent RDS logs are collected.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"component_type":{"type":"string","description":"Represents the type of the log collector component.\n* CONNECTION_SERVER: Log component type is Connection Server.\n* AGENT: Log component type is agent machine from desktop pool.\n* AGENT_RDS: Log component type is agent RDSH server from farm.","example":"AGENT","enum":["CONNECTION_SERVER","AGENT","AGENT_RDS"]},"feature_list":{"uniqueItems":true,"type":"array","description":"List of features for which the logs need to be collected. Feature wise log collection is supported only for component_type AGENT and AGENT_RDS. If feature_list is null then by default logs are collected for all the features.","example":["all","blast"],"items":{"type":"string","description":"List of features for which the logs need to be collected. Feature wise log collection is supported only for component_type AGENT and AGENT_RDS. If feature_list is null then by default logs are collected for all the features.","example":"[\"all\",\"blast\"]"}},"filter_type":{"uniqueItems":true,"type":"array","description":"Filter type to be used while collecting the logs bundle. Filter is set to DEFAULT if none specified.","example":["DEFAULT"],"items":{"type":"string","description":"* PRODUCT_DUMP: Collect the product dumps, if present.\n* WINDOWS_DUMP: Collects the windows dumps, if present.","example":"[\"DEFAULT\"]","enum":["DEFAULT","PRODUCT_DUMP","WINDOWS_DUMP"]}},"sticky_log_collection":{"type":"boolean","description":"Indicates the connection server processing the LogCollectorCollectSpec becomes the download owner.","example":false}},"description":"Information required to collect logs."},"LogCollectorDownloadURLInfo":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/APIError"},"log_collector_bundle_profile":{"type":"array","description":"Provides additional information about log collection bundle.","example":"LOG_FILTER_NOT_HONORED","items":{"type":"string","description":"* LOG_FILTER_NOT_HONORED: Indicates only default log collection filter is applied on the logs bundle.","example":"LOG_FILTER_NOT_HONORED","enum":["LOG_FILTER_NOT_HONORED"]}},"status_code":{"type":"integer","description":"Response HTTP status code of the operation.","format":"int32","example":200},"task_id":{"type":"string","description":"Unique identifier of a log collector task.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"url":{"type":"string","description":"Download URL of log bundle.","example":"https://connection-server-FQDN/dct/ZDk2NDYzMDktOTc3My00YWRiLWExNmEtY2FkODljNzYwYzVl"}},"description":"Information about download URL for a log collector component."},"LogCollectorLogLevelInfo":{"type":"object","properties":{"component_id":{"type":"string","description":"Represents the ID of the log collector component type for which logs are to be collected.\n\nRepresents CS id if CS logs are collected, Machine id if Agent logs are collected and\n\nRDS server id if Agent RDS logs are collected.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"component_type":{"type":"string","description":"Represents the type of the log collector component.\n* CONNECTION_SERVER: Log component type is Connection Server.\n* AGENT: Log component type is agent machine from desktop pool.\n* AGENT_RDS: Log component type is agent RDSH server from farm.","example":"AGENT","enum":["CONNECTION_SERVER","AGENT","AGENT_RDS"]},"feature_log_level_info":{"type":"array","description":"List of log level info where each object in the list represents the log levels for a feature.","items":{"$ref":"#/components/schemas/FeatureLogLevelInfo"}},"last_modified_time":{"type":"integer","description":"The duration in seconds since the last log level modification. This property has a minimum value of 0.","format":"int64","example":1656527400000}},"description":"Log level information for a component."},"LogCollectorLogLevelSpec":{"required":["component_id","component_type","reset"],"type":"object","properties":{"component_id":{"type":"string","description":"Represents the ID of the log collector component type for which logs are to be collected.\n\nRepresents CS id if CS logs are collected, Machine id if Agent logs are collected and\n\nRDS server id if Agent RDS logs are collected.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"component_type":{"type":"string","description":"Represents the type of the log collector component.\n* CONNECTION_SERVER: Log component type is Connection Server.\n* AGENT: Log component type is agent machine from desktop pool.\n* AGENT_RDS: Log component type is agent RDSH server from farm.","example":"AGENT","enum":["CONNECTION_SERVER","AGENT","AGENT_RDS"]},"feature_key":{"type":"string","description":"Short name of feature for which log level needs to be configured. This property is required if reset is set to false.","example":"all"},"log_level":{"type":"string","description":"New log level for the provided feature. This property is required if reset is set to false.\n* INFO: Represents INFO log level.\n* DEBUG: Represents DEBUG log level..\n* TRACE: Represents TRACE log level.\n* VERBOSE: Represents VERBOSE log level.","example":"INFO","enum":["INFO","DEBUG","TRACE","VERBOSE"]},"reset":{"type":"boolean","description":"Indicates if the log level need to be reset to installation default. This property has a default value of false.","example":false}},"description":"Specification for setting the log levels"},"LogCollectorTaskInfo":{"type":"object","properties":{"component_id":{"type":"string","description":"Represents the ID of the log collector component type for which logs are to be collected.\n\nRepresents CS id if CS logs are collected, Machine id if Agent logs are collected and\n\nRDS server id if Agent RDS logs are collected.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"component_type":{"type":"string","description":"Represents the type of the log collector component.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.\n* CONNECTION_SERVER: Log component type is Connection Server.\n* AGENT: Log component type is agent machine from desktop pool.\n* AGENT_RDS: Log component type is agent RDSH server from farm.","example":"AGENT","enum":["CONNECTION_SERVER","AGENT","AGENT_RDS"]},"end_time":{"type":"integer","description":"End time of the log collection.\nSupported Filters : 'Between', 'Equals.\nThis property can be used for sorting.","format":"int64","example":1652079610000},"id":{"type":"string","description":"Unique identifier of a log collector task.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"initiated_by":{"type":"string","description":"User identity information.\nSupported Filters : 'Equals.\nThis property can be used for sorting.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"start_time":{"type":"integer","description":"Start time of the log collection.\nSupported Filters : 'Between', 'Equals.\nThis property can be used for sorting.","format":"int64","example":1656527400000},"task_state":{"type":"string","description":"Log collector task state.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.\n* IDLE: Log Collection task is in IDLE state.\n* COLLECT: Log Collection task has started collecting logs bundle.\n* COLLECT_COMPLETE: Log collection task has completed collection of logs bundle.\n* PURGE_COMPLETE: Log collection task has completed purge operation.\n* PURGE: Log collection task is in purge operation.\n* COLLECT_TIMED_OUT: Log collection task has timed out and the process has been interrupted.\n* ERROR: Log collection task has ended in error.\n* ABORT_COMPLETE: Log collection task has been aborted.\n* NON_RESPONSIVE: In rare occasions, the log collection process becomes non-responsive. A connection server restart is required to remediate it.","example":"IDLE","enum":["IDLE","COLLECT","COLLECT_COMPLETE","PURGE_COMPLETE","PURGE","COLLECT_TIMED_OUT","ERROR","ABORT_COMPLETE","NON_RESPONSIVE"]}},"description":"Information about Log collector Task."},"LogonSegmentInfo":{"type":"object","properties":{"logon_segment_data":{"type":"string","description":"Logon segment data of the session.","example":"<logon Segment>"}},"description":"Information about session timing data."},"MachineAgentUpgradeSpec":{"required":["agent_installer_package_id","end_time","machine_ids","start_time"],"type":"object","properties":{"agent_installer_package_id":{"type":"string","description":"ID of the agent installer package.","example":"2b6eaeb8-2e91-11ed-a261-0242ac120002"},"custom_install_parameters":{"type":"string","description":"Indicates any parameters to be used by the agent for silent install.","example":"ADDLOCAL=Core,USB"},"end_time":{"type":"integer","description":"Agent upgrade end time.","format":"int64","example":1652079610000},"machine_ids":{"uniqueItems":true,"type":"array","description":"Machine Ids representing the machines to be upgraded.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machine Ids representing the machines to be upgraded.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"skip_for_logged_in_users":{"type":"boolean","description":"Indicates whether to skip agent upgrade for logged in users.","example":true},"start_time":{"type":"integer","description":"Agent upgrade start time.","format":"int64","example":1652079610000}},"description":"Machine agent upgrade spec."},"MachineAlias":{"type":"object","properties":{"ad_user_id":{"type":"string","description":"Sid of the user","example":"S-1-5-21-2898529287-1016622242-505487308-1553"},"alias_name":{"type":"string","description":"Alias name of the user.","example":"Alias1"}},"description":"Info for reading machine aliases of assigned users."},"MachineAliasSpec":{"required":["ad_user_id","alias_name"],"type":"object","properties":{"ad_user_id":{"type":"string","description":"Sid of the user","example":"S-1-5-21-2898529287-1016622242-505487308-1553"},"alias_name":{"type":"string","description":"Alias name of the user.","example":"Alias1"}},"description":"The specification for updating machine aliases of assigned users."},"MachineDeleteData":{"type":"object","properties":{"allow_delete_from_multi_desktop_pools":{"type":"boolean","description":"Determines whether the machines from different desktop pools can be deleted. This defaults to false in which case only machines belonging to single desktop pool can be deleted. If true, machines from different desktop pools can be deleted.","example":true},"archive_datastore_id":{"type":"string","description":"Determines the datastore where the persistent user disk will be saved for future use. Both this as well as the archiveDatastorePathId need to be set. If this is unset and archivePersistentDisk is specified, the persistent disk is archived in place.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"archive_datastore_path_id":{"type":"string","description":"Determines the location in the datastore where the persistent user disk will be saved for future use. If this is set, then archiveDatastoreId also needs to be specified.If this is unset and archivePersistentDisk is specified, the persistent disk is archived in place.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"archive_persistent_disk":{"type":"boolean","description":"Determines whether to detach the persistent user disk and save it for future use. This can only be specified for linked-clone desktops with redirectWindowsProfile enabled, in which case it defaults to true. ","example":true},"delete_from_disk":{"type":"boolean","description":"Determines whether the Machine VM should be deleted from vCenter Server. This is only applicable for managed machines. This must always be true for machines in linked and instant clone desktops. This defaults to true for linked and instant clone machines and false for all other types. If this is true, then machine being deleted must not have any active user session, otherwise delete operation would fail.","example":true},"force_logoff_session":{"type":"boolean","description":"Determines whether active session on the machine to be logged off before deletion. This is only applicable for managed machines. If true, active session on the machine will be logged off before Machine delete. Otherwise,it will result in an exception. ","example":true}},"description":"The specification applicable to deleting the machine."},"MachineDeleteSpec":{"required":["machine_ids"],"type":"object","properties":{"machine_delete_data":{"$ref":"#/components/schemas/MachineDeleteData"},"machine_ids":{"type":"array","description":"Machine Ids representing the machines to be deleted.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Machine Ids representing the machines to be deleted.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}}},"description":"The machines and specification for deletion."},"MachineInfo":{"type":"object","properties":{"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"attempted_theft_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com"}},"configured_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com"}},"desktop_pool_id":{"type":"string","description":"The id of the Desktop Pool that the machine belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"managed_machine_data":{"$ref":"#/components/schemas/ManagedMachineData"},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The guest operating system.\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","description":"Horizon Agent pairing state.\n* NOT_AVAILABLE: Agent pairing state is not available.\n* IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.\n* PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.","example":"IN_PAIRING","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.\n* DELETING: The machine is marked for deletion.\n* DISABLED: The machine is disabled.\n* DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* ERROR: An unknown error occurred in the machine.\n* IN_PROGRESS: There is a machine operation in progress.\n* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* WAITING_FOR_AGENT: Horizon Connection Server is waiting to establish communication with Horizon Agent for one of these cases - a virtual machine in a manual desktop pool, unmanaged machine or RDS server.","example":"PROVISIONING","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_ERROR_DOMAIN_FAILURE","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","WAITING_FOR_AGENT"]},"type":{"type":"string","description":"The type of machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.\n* AWS_CORE_MACHINE: The machine is an AWS Core managed machine\n* CP_MANAGED: The machine is an capacity provider managed machine","example":"MANAGED_MACHINE","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE","AWS_CORE_MACHINE","CP_MANAGED"]},"user_ids":{"type":"array","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"items":{"type":"string","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\",\"S-1-2-3-3123456786-1012345398-3123456784-124\"]"}}},"description":"Information related to a Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"MachineInfoV10":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id of this Machine<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_data":{"type":"array","description":"List of agents data info\n","deprecated":true,"items":{"$ref":"#/components/schemas/AgentData_Machines"}},"agent_id":{"type":"string","description":"Agent Id.<br>Supported Filters: 'Equals'.","example":"agent/4ffe3d72-a490-4dd1-9a61-7a221c54c94f"},"agent_ipv4_address":{"type":"string","description":"The agent ipv4 address.","example":"192.168.1.1"},"agent_ipv6_address":{"type":"string","description":"The agent ipv6 address.","example":"2001:db8:3333:4444:5555:6666:7777:8888"},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true","deprecated":true},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","deprecated":true,"enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","deprecated":true,"enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"alias_names":{"type":"array","description":"Alias names for the machines \nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"Alias names for the machines \nSupported Filters : 'Contains'","example":"datastore-1"}},"alias_user_ids":{"type":"array","description":"User SIDs having alias\nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"User SIDs having alias\nSupported Filters : 'Contains'","example":"datastore-1"}},"aliases":{"type":"array","description":"List of MachineAlias","items":{"$ref":"#/components/schemas/MachineAlias"}},"appv_agent_upgrade_error_message":{"type":"string","description":"Error message of the AppVolumes Agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"appv_agent_version_build":{"type":"string","description":"AppVolumes Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"appv_has_new_agent_version":{"type":"boolean","description":"newer AppVolumes agent version is available","example":true},"appv_last_update_date_time":{"type":"string","description":"Date of the last AppVolumes Agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"appv_upgrade_result":{"type":"string","description":"Result of the AppVolumes Agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"appv_upgrade_state":{"type":"string","description":"State of the AppVolumes Agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"attempted_theft_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com"}},"aws_workspace_id":{"type":"string","description":"Id of the aws workspace this machine is associated to\nSupported Filters: 'Equals'.","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"configured_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com"}},"deem_agent_upgrade_error_message":{"type":"string","description":"Error message of the DEEM Agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"deem_agent_version_build":{"type":"string","description":"DEEM Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"deem_has_new_agent_version":{"type":"boolean","description":"newer DEEM agent version is available","example":true},"deem_last_update_date_time":{"type":"string","description":"Date of the last DEEM Agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"deem_upgrade_result":{"type":"string","description":"Result of the DEEM Agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"deem_upgrade_state":{"type":"string","description":"State of the DEEM Agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"dem_agent_upgrade_error_message":{"type":"string","description":"Error message of the DEM Agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"dem_agent_version_build":{"type":"string","description":"DEM Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"dem_has_new_agent_version":{"type":"boolean","description":"newer DEM agent version is available","example":true},"dem_last_update_date_time":{"type":"string","description":"Date of the last DEM Agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"dem_upgrade_result":{"type":"string","description":"Result of the DEM Agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"dem_upgrade_state":{"type":"string","description":"State of the DEM Agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"desktop_pool_id":{"type":"string","description":"The id of the Desktop Pool that the machine belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"desktop_pool_name":{"type":"string","description":"The name of the desktop that the machine belongs to.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"desktopExample"},"desktop_pool_source":{"type":"string","description":"The Source of the desktop that the machine belongs to.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"desktopExample","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"desktop_pool_type":{"type":"string","description":"The type of the desktop that the machine belongs to.\n\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"desktopExample","enum":["AUTOMATED","MANUAL","RDS"]},"desktop_pool_user_assignment":{"type":"string","description":"The user assignment of the desktop that the machine belongs to.\n\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"desktopExample","enum":["DEDICATED","FLOATING"]},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"held_machine":{"type":"boolean","description":"Indicates whether the machine is in held state.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"hze_agent_upgrade_error_message":{"type":"string","description":"Error message of the Horizon Agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"hze_agent_version_build":{"type":"string","description":"Horizon Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"hze_has_new_agent_version":{"type":"boolean","description":"newer agent version is available","example":true},"hze_last_update_date_time":{"type":"string","description":"Date of the last Horizon Agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"hze_upgrade_result":{"type":"string","description":"Result of the Horizon Agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"hze_upgrade_state":{"type":"string","description":"State of the Horizon Agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"managed_machine_data":{"$ref":"#/components/schemas/ManagedMachineDataV6"},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The guest operating system.\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","description":"Horizon Agent pairing state.\n* NOT_AVAILABLE: Agent pairing state is not available.\n* IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.\n* PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.","example":"IN_PAIRING","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"re_agent_version":{"type":"string","description":"Remote Experience Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_id":{"type":"string","description":"The ID of the session on the Machine (if one exists).","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"session_protocol":{"type":"string","description":"The protocol for the session. It will be unset for disconnected sessions","example":"BLAST"},"session_user_id":{"type":"string","description":"The name of the user that the session belongs to.\n","example":"User1"},"session_user_name":{"type":"string","description":"The name of user associated with the session","example":"sessionUser"},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.\n* DELETING: The machine is marked for deletion.\n* DISABLED: The machine is disabled.\n* DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* ERROR: An unknown error occurred in the machine.\n* IN_PROGRESS: There is a machine operation in progress.\n* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* WAITING_FOR_AGENT: Horizon Connection Server is waiting to establish communication with Horizon Agent for one of these cases - a virtual machine in a manual desktop pool, unmanaged machine or RDS server.","example":"PROVISIONING","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_ERROR_DOMAIN_FAILURE","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","WAITING_FOR_AGENT"]},"type":{"type":"string","description":"The type of machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.\n* AWS_CORE_MACHINE: The machine is an AWS Core managed machine\n* CP_MANAGED: The machine is an capacity provider managed machine","example":"MANAGED_MACHINE","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE","AWS_CORE_MACHINE","CP_MANAGED"]},"uem_enrolment_last_error_code":{"type":"string","description":"UEM Enrolment last error code.\nSupported Filters : 'Equals'\nThis property can be used for sorting.","example":"FAILED_TO_ENROL"},"uem_enrolment_status":{"type":"string","description":"UEM Enrolment Status.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"Completed"},"user_ids":{"type":"array","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"items":{"type":"string","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\",\"S-1-2-3-3123456786-1012345398-3123456784-124\"]"}},"user_names":{"type":"array","description":"The name of the desktop that the machine belongs to.","example":["user1"],"items":{"type":"string","description":"The name of the desktop that the machine belongs to.","example":"[\"user1\"]"}}},"description":"Information related to a Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"MachineInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id of this Machine<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"aliases":{"type":"array","description":"List of MachineAlias","items":{"$ref":"#/components/schemas/MachineAlias"}},"attempted_theft_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com"}},"configured_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com"}},"desktop_pool_id":{"type":"string","description":"The id of the Desktop Pool that the machine belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"managed_machine_data":{"$ref":"#/components/schemas/ManagedMachineDataV2"},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The guest operating system.\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","description":"Horizon Agent pairing state.\n* NOT_AVAILABLE: Agent pairing state is not available.\n* IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.\n* PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.","example":"IN_PAIRING","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_id":{"type":"string","description":"The ID of the session on the Machine (if one exists).","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.\n* DELETING: The machine is marked for deletion.\n* DISABLED: The machine is disabled.\n* DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* ERROR: An unknown error occurred in the machine.\n* IN_PROGRESS: There is a machine operation in progress.\n* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* WAITING_FOR_AGENT: Horizon Connection Server is waiting to establish communication with Horizon Agent for one of these cases - a virtual machine in a manual desktop pool, unmanaged machine or RDS server.","example":"PROVISIONING","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_ERROR_DOMAIN_FAILURE","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","WAITING_FOR_AGENT"]},"type":{"type":"string","description":"The type of machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.\n* AWS_CORE_MACHINE: The machine is an AWS Core managed machine\n* CP_MANAGED: The machine is an capacity provider managed machine","example":"MANAGED_MACHINE","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE","AWS_CORE_MACHINE","CP_MANAGED"]},"user_ids":{"type":"array","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"items":{"type":"string","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\",\"S-1-2-3-3123456786-1012345398-3123456784-124\"]"}}},"description":"Information related to a Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"MachineInfoV3":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id of this Machine<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"aliases":{"type":"array","description":"List of MachineAlias","items":{"$ref":"#/components/schemas/MachineAlias"}},"attempted_theft_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com"}},"configured_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com"}},"desktop_pool_id":{"type":"string","description":"The id of the Desktop Pool that the machine belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"held_machine":{"type":"boolean","description":"Indicates whether the machine is in held state.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"managed_machine_data":{"$ref":"#/components/schemas/ManagedMachineDataV2"},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The guest operating system.\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","description":"Horizon Agent pairing state.\n* NOT_AVAILABLE: Agent pairing state is not available.\n* IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.\n* PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.","example":"IN_PAIRING","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_id":{"type":"string","description":"The ID of the session on the Machine (if one exists).","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.\n* DELETING: The machine is marked for deletion.\n* DISABLED: The machine is disabled.\n* DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* ERROR: An unknown error occurred in the machine.\n* IN_PROGRESS: There is a machine operation in progress.\n* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* WAITING_FOR_AGENT: Horizon Connection Server is waiting to establish communication with Horizon Agent for one of these cases - a virtual machine in a manual desktop pool, unmanaged machine or RDS server.","example":"PROVISIONING","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_ERROR_DOMAIN_FAILURE","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","WAITING_FOR_AGENT"]},"type":{"type":"string","description":"The type of machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.\n* AWS_CORE_MACHINE: The machine is an AWS Core managed machine\n* CP_MANAGED: The machine is an capacity provider managed machine","example":"MANAGED_MACHINE","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE","AWS_CORE_MACHINE","CP_MANAGED"]},"user_ids":{"type":"array","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"items":{"type":"string","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\",\"S-1-2-3-3123456786-1012345398-3123456784-124\"]"}}},"description":"Information related to a Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"MachineInfoV4":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id of this Machine<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true","deprecated":true},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","deprecated":true,"enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","deprecated":true,"enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"aliases":{"type":"array","description":"List of MachineAlias","items":{"$ref":"#/components/schemas/MachineAlias"}},"attempted_theft_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com"}},"configured_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com"}},"desktop_pool_id":{"type":"string","description":"The id of the Desktop Pool that the machine belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"held_machine":{"type":"boolean","description":"Indicates whether the machine is in held state.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"managed_machine_data":{"$ref":"#/components/schemas/ManagedMachineDataV2"},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The guest operating system.\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","description":"Horizon Agent pairing state.\n* NOT_AVAILABLE: Agent pairing state is not available.\n* IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.\n* PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.","example":"IN_PAIRING","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_id":{"type":"string","description":"The ID of the session on the Machine (if one exists).","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.\n* DELETING: The machine is marked for deletion.\n* DISABLED: The machine is disabled.\n* DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* ERROR: An unknown error occurred in the machine.\n* IN_PROGRESS: There is a machine operation in progress.\n* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* WAITING_FOR_AGENT: Horizon Connection Server is waiting to establish communication with Horizon Agent for one of these cases - a virtual machine in a manual desktop pool, unmanaged machine or RDS server.","example":"PROVISIONING","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_ERROR_DOMAIN_FAILURE","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","WAITING_FOR_AGENT"]},"type":{"type":"string","description":"The type of machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.\n* AWS_CORE_MACHINE: The machine is an AWS Core managed machine\n* CP_MANAGED: The machine is an capacity provider managed machine","example":"MANAGED_MACHINE","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE","AWS_CORE_MACHINE","CP_MANAGED"]},"user_ids":{"type":"array","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"items":{"type":"string","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\",\"S-1-2-3-3123456786-1012345398-3123456784-124\"]"}}},"description":"Information related to a Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"MachineInfoV5":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id of this Machine<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_id":{"type":"string","description":"Agent Id.<br>Supported Filters: 'Equals'.","example":"agent/4ffe3d72-a490-4dd1-9a61-7a221c54c94f"},"agent_ipv4_address":{"type":"string","description":"The agent ipv4 address.","example":"192.168.1.1"},"agent_ipv6_address":{"type":"string","description":"The agent ipv6 address.","example":"2001:db8:3333:4444:5555:6666:7777:8888"},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true","deprecated":true},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","deprecated":true,"enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","deprecated":true,"enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"aliases":{"type":"array","description":"List of MachineAlias","items":{"$ref":"#/components/schemas/MachineAlias"}},"attempted_theft_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com"}},"configured_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com"}},"desktop_pool_id":{"type":"string","description":"The id of the Desktop Pool that the machine belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"held_machine":{"type":"boolean","description":"Indicates whether the machine is in held state.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"managed_machine_data":{"$ref":"#/components/schemas/ManagedMachineDataV3"},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The guest operating system.\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","description":"Horizon Agent pairing state.\n* NOT_AVAILABLE: Agent pairing state is not available.\n* IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.\n* PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.","example":"IN_PAIRING","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_id":{"type":"string","description":"The ID of the session on the Machine (if one exists).","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.\n* DELETING: The machine is marked for deletion.\n* DISABLED: The machine is disabled.\n* DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* ERROR: An unknown error occurred in the machine.\n* IN_PROGRESS: There is a machine operation in progress.\n* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* WAITING_FOR_AGENT: Horizon Connection Server is waiting to establish communication with Horizon Agent for one of these cases - a virtual machine in a manual desktop pool, unmanaged machine or RDS server.","example":"PROVISIONING","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_ERROR_DOMAIN_FAILURE","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","WAITING_FOR_AGENT"]},"type":{"type":"string","description":"The type of machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.\n* AWS_CORE_MACHINE: The machine is an AWS Core managed machine\n* CP_MANAGED: The machine is an capacity provider managed machine","example":"MANAGED_MACHINE","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE","AWS_CORE_MACHINE","CP_MANAGED"]},"user_ids":{"type":"array","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"items":{"type":"string","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\",\"S-1-2-3-3123456786-1012345398-3123456784-124\"]"}}},"description":"Information related to a Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"MachineInfoV6":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id of this Machine<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_id":{"type":"string","description":"Agent Id.<br>Supported Filters: 'Equals'.","example":"agent/4ffe3d72-a490-4dd1-9a61-7a221c54c94f"},"agent_ipv4_address":{"type":"string","description":"The agent ipv4 address.","example":"192.168.1.1"},"agent_ipv6_address":{"type":"string","description":"The agent ipv6 address.","example":"2001:db8:3333:4444:5555:6666:7777:8888"},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true","deprecated":true},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","deprecated":true,"enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","deprecated":true,"enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"aliases":{"type":"array","description":"List of MachineAlias","items":{"$ref":"#/components/schemas/MachineAlias"}},"attempted_theft_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com"}},"configured_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com"}},"desktop_pool_id":{"type":"string","description":"The id of the Desktop Pool that the machine belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"desktop_pool_name":{"type":"string","description":"The name of the desktop that the machine belongs to.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"desktopExample"},"desktop_pool_source":{"type":"string","description":"The Source of the desktop that the machine belongs to.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"desktopExample","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"desktop_pool_type":{"type":"string","description":"The type of the desktop that the machine belongs to.\n\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"desktopExample","enum":["AUTOMATED","MANUAL","RDS"]},"desktop_pool_user_assignment":{"type":"string","description":"The user assignment of the desktop that the machine belongs to.\n\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"desktopExample","enum":["DEDICATED","FLOATING"]},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"held_machine":{"type":"boolean","description":"Indicates whether the machine is in held state.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"managed_machine_data":{"$ref":"#/components/schemas/ManagedMachineDataV4"},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The guest operating system.\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","description":"Horizon Agent pairing state.\n* NOT_AVAILABLE: Agent pairing state is not available.\n* IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.\n* PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.","example":"IN_PAIRING","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_id":{"type":"string","description":"The ID of the session on the Machine (if one exists).","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"session_protocol":{"type":"string","description":"The protocol for the session. It will be unset for disconnected sessions","example":"BLAST"},"session_user_id":{"type":"string","description":"The name of the user that the session belongs to.\n","example":"User1"},"session_user_name":{"type":"string","description":"The name of user associated with the session","example":"sessionUser"},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.\n* DELETING: The machine is marked for deletion.\n* DISABLED: The machine is disabled.\n* DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* ERROR: An unknown error occurred in the machine.\n* IN_PROGRESS: There is a machine operation in progress.\n* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* WAITING_FOR_AGENT: Horizon Connection Server is waiting to establish communication with Horizon Agent for one of these cases - a virtual machine in a manual desktop pool, unmanaged machine or RDS server.","example":"PROVISIONING","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_ERROR_DOMAIN_FAILURE","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","WAITING_FOR_AGENT"]},"type":{"type":"string","description":"The type of machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.\n* AWS_CORE_MACHINE: The machine is an AWS Core managed machine\n* CP_MANAGED: The machine is an capacity provider managed machine","example":"MANAGED_MACHINE","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE","AWS_CORE_MACHINE","CP_MANAGED"]},"user_ids":{"type":"array","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"items":{"type":"string","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\",\"S-1-2-3-3123456786-1012345398-3123456784-124\"]"}},"user_names":{"type":"array","description":"The name of the desktop that the machine belongs to.","example":["user1"],"items":{"type":"string","description":"The name of the desktop that the machine belongs to.","example":"[\"user1\"]"}}},"description":"Information related to a Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains', 'EndsWith'<br>See the field description to know the filter types it supports."},"MachineInfoV7":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id of this Machine<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_id":{"type":"string","description":"Agent Id.<br>Supported Filters: 'Equals'.","example":"agent/4ffe3d72-a490-4dd1-9a61-7a221c54c94f"},"agent_ipv4_address":{"type":"string","description":"The agent ipv4 address.","example":"192.168.1.1"},"agent_ipv6_address":{"type":"string","description":"The agent ipv6 address.","example":"2001:db8:3333:4444:5555:6666:7777:8888"},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true","deprecated":true},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","deprecated":true,"enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","deprecated":true,"enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"aliases":{"type":"array","description":"List of MachineAlias","items":{"$ref":"#/components/schemas/MachineAlias"}},"attempted_theft_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com"}},"aws_workspace_id":{"type":"string","description":"Id of the aws workspace this machine is associated to\nSupported Filters: 'Equals'.","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"configured_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com"}},"desktop_pool_id":{"type":"string","description":"The id of the Desktop Pool that the machine belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"desktop_pool_name":{"type":"string","description":"The name of the desktop that the machine belongs to.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"desktopExample"},"desktop_pool_source":{"type":"string","description":"The Source of the desktop that the machine belongs to.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"desktopExample","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"desktop_pool_type":{"type":"string","description":"The type of the desktop that the machine belongs to.\n\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"desktopExample","enum":["AUTOMATED","MANUAL","RDS"]},"desktop_pool_user_assignment":{"type":"string","description":"The user assignment of the desktop that the machine belongs to.\n\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"desktopExample","enum":["DEDICATED","FLOATING"]},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"held_machine":{"type":"boolean","description":"Indicates whether the machine is in held state.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"managed_machine_data":{"$ref":"#/components/schemas/ManagedMachineDataV4"},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The guest operating system.\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","description":"Horizon Agent pairing state.\n* NOT_AVAILABLE: Agent pairing state is not available.\n* IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.\n* PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.","example":"IN_PAIRING","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_id":{"type":"string","description":"The ID of the session on the Machine (if one exists).","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"session_protocol":{"type":"string","description":"The protocol for the session. It will be unset for disconnected sessions","example":"BLAST"},"session_user_id":{"type":"string","description":"The name of the user that the session belongs to.\n","example":"User1"},"session_user_name":{"type":"string","description":"The name of user associated with the session","example":"sessionUser"},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.\n* DELETING: The machine is marked for deletion.\n* DISABLED: The machine is disabled.\n* DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* ERROR: An unknown error occurred in the machine.\n* IN_PROGRESS: There is a machine operation in progress.\n* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* WAITING_FOR_AGENT: Horizon Connection Server is waiting to establish communication with Horizon Agent for one of these cases - a virtual machine in a manual desktop pool, unmanaged machine or RDS server.","example":"PROVISIONING","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_ERROR_DOMAIN_FAILURE","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","WAITING_FOR_AGENT"]},"type":{"type":"string","description":"The type of machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.\n* AWS_CORE_MACHINE: The machine is an AWS Core managed machine\n* CP_MANAGED: The machine is an capacity provider managed machine","example":"MANAGED_MACHINE","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE","AWS_CORE_MACHINE","CP_MANAGED"]},"user_ids":{"type":"array","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"items":{"type":"string","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\",\"S-1-2-3-3123456786-1012345398-3123456784-124\"]"}},"user_names":{"type":"array","description":"The name of the desktop that the machine belongs to.","example":["user1"],"items":{"type":"string","description":"The name of the desktop that the machine belongs to.","example":"[\"user1\"]"}}},"description":"Information related to a Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"MachineInfoV8":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id of this Machine<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_data":{"type":"array","description":"List of agents data info\n","deprecated":true,"items":{"$ref":"#/components/schemas/AgentData_Machines"}},"agent_id":{"type":"string","description":"Agent Id.<br>Supported Filters: 'Equals'.","example":"agent/4ffe3d72-a490-4dd1-9a61-7a221c54c94f"},"agent_ipv4_address":{"type":"string","description":"The agent ipv4 address.","example":"192.168.1.1"},"agent_ipv6_address":{"type":"string","description":"The agent ipv6 address.","example":"2001:db8:3333:4444:5555:6666:7777:8888"},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true","deprecated":true},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","deprecated":true,"enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","deprecated":true,"enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"alias_names":{"type":"array","description":"Alias names for the machines \nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"Alias names for the machines \nSupported Filters : 'Contains'","example":"datastore-1"}},"alias_user_ids":{"type":"array","description":"User SIDs having alias\nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"User SIDs having alias\nSupported Filters : 'Contains'","example":"datastore-1"}},"aliases":{"type":"array","description":"List of MachineAlias","items":{"$ref":"#/components/schemas/MachineAlias"}},"attempted_theft_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com"}},"aws_workspace_id":{"type":"string","description":"Id of the aws workspace this machine is associated to\nSupported Filters: 'Equals'.","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"configured_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com"}},"desktop_pool_id":{"type":"string","description":"The id of the Desktop Pool that the machine belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"desktop_pool_name":{"type":"string","description":"The name of the desktop that the machine belongs to.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"desktopExample"},"desktop_pool_source":{"type":"string","description":"The Source of the desktop that the machine belongs to.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"desktopExample","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"desktop_pool_type":{"type":"string","description":"The type of the desktop that the machine belongs to.\n\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"desktopExample","enum":["AUTOMATED","MANUAL","RDS"]},"desktop_pool_user_assignment":{"type":"string","description":"The user assignment of the desktop that the machine belongs to.\n\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"desktopExample","enum":["DEDICATED","FLOATING"]},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"held_machine":{"type":"boolean","description":"Indicates whether the machine is in held state.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"managed_machine_data":{"$ref":"#/components/schemas/ManagedMachineDataV5"},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The guest operating system.\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","description":"Horizon Agent pairing state.\n* NOT_AVAILABLE: Agent pairing state is not available.\n* IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.\n* PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.","example":"IN_PAIRING","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_id":{"type":"string","description":"The ID of the session on the Machine (if one exists).","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"session_protocol":{"type":"string","description":"The protocol for the session. It will be unset for disconnected sessions","example":"BLAST"},"session_user_id":{"type":"string","description":"The name of the user that the session belongs to.\n","example":"User1"},"session_user_name":{"type":"string","description":"The name of user associated with the session","example":"sessionUser"},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.\n* DELETING: The machine is marked for deletion.\n* DISABLED: The machine is disabled.\n* DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* ERROR: An unknown error occurred in the machine.\n* IN_PROGRESS: There is a machine operation in progress.\n* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* WAITING_FOR_AGENT: Horizon Connection Server is waiting to establish communication with Horizon Agent for one of these cases - a virtual machine in a manual desktop pool, unmanaged machine or RDS server.","example":"PROVISIONING","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_ERROR_DOMAIN_FAILURE","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","WAITING_FOR_AGENT"]},"type":{"type":"string","description":"The type of machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.\n* AWS_CORE_MACHINE: The machine is an AWS Core managed machine\n* CP_MANAGED: The machine is an capacity provider managed machine","example":"MANAGED_MACHINE","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE","AWS_CORE_MACHINE","CP_MANAGED"]},"user_ids":{"type":"array","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"items":{"type":"string","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\",\"S-1-2-3-3123456786-1012345398-3123456784-124\"]"}},"user_names":{"type":"array","description":"The name of the desktop that the machine belongs to.","example":["user1"],"items":{"type":"string","description":"The name of the desktop that the machine belongs to.","example":"[\"user1\"]"}}},"description":"Information related to a Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"MachineInfoV9":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id of this Machine<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_data":{"type":"array","description":"List of agents data info\n","deprecated":true,"items":{"$ref":"#/components/schemas/AgentData_Machines"}},"agent_id":{"type":"string","description":"Agent Id.<br>Supported Filters: 'Equals'.","example":"agent/4ffe3d72-a490-4dd1-9a61-7a221c54c94f"},"agent_ipv4_address":{"type":"string","description":"The agent ipv4 address.","example":"192.168.1.1"},"agent_ipv6_address":{"type":"string","description":"The agent ipv6 address.","example":"2001:db8:3333:4444:5555:6666:7777:8888"},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true","deprecated":true},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","deprecated":true,"enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","deprecated":true,"enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"alias_names":{"type":"array","description":"Alias names for the machines \nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"Alias names for the machines \nSupported Filters : 'Contains'","example":"datastore-1"}},"alias_user_ids":{"type":"array","description":"User SIDs having alias\nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"User SIDs having alias\nSupported Filters : 'Contains'","example":"datastore-1"}},"aliases":{"type":"array","description":"List of MachineAlias","items":{"$ref":"#/components/schemas/MachineAlias"}},"attempted_theft_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","example":"connection-server2.example.com"}},"aws_workspace_id":{"type":"string","description":"Id of the aws workspace this machine is associated to\nSupported Filters: 'Equals'.","example":"d5dd82ec-a38d-470b-bb47-64149c022d8a"},"configured_by_connection_server":{"type":"array","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com","items":{"type":"string","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","example":"connection-server1.example.com"}},"desktop_pool_id":{"type":"string","description":"The id of the Desktop Pool that the machine belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"desktop_pool_name":{"type":"string","description":"The name of the desktop that the machine belongs to.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"desktopExample"},"desktop_pool_source":{"type":"string","description":"The Source of the desktop that the machine belongs to.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"desktopExample","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"desktop_pool_type":{"type":"string","description":"The type of the desktop that the machine belongs to.\n\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"desktopExample","enum":["AUTOMATED","MANUAL","RDS"]},"desktop_pool_user_assignment":{"type":"string","description":"The user assignment of the desktop that the machine belongs to.\n\n* DEDICATED: With dedicated assignment, a user returns to the same machine at each session.\n* FLOATING: With floating assignment, a user may return to one of the available machines for the next session.","example":"desktopExample","enum":["DEDICATED","FLOATING"]},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"held_machine":{"type":"boolean","description":"Indicates whether the machine is in held state.Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"managed_machine_data":{"$ref":"#/components/schemas/ManagedMachineDataV6"},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The guest operating system.\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_architecture":{"type":"string","description":"The guest operating system architecture.\n* UNKNOWN: Operating System cannot be determined.\n* BIT_32: 32 bit Operating System Architecture.\n* BIT_64: 64 bit Operating System Architecture.","example":"BIT_64","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","description":"Horizon Agent pairing state.\n* NOT_AVAILABLE: Agent pairing state is not available.\n* IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.\n* PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.","example":"IN_PAIRING","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_id":{"type":"string","description":"The ID of the session on the Machine (if one exists).","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"session_protocol":{"type":"string","description":"The protocol for the session. It will be unset for disconnected sessions","example":"BLAST"},"session_user_id":{"type":"string","description":"The name of the user that the session belongs to.\n","example":"User1"},"session_user_name":{"type":"string","description":"The name of user associated with the session","example":"sessionUser"},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.\n* DELETING: The machine is marked for deletion.\n* DISABLED: The machine is disabled.\n* DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* ERROR: An unknown error occurred in the machine.\n* IN_PROGRESS: There is a machine operation in progress.\n* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* WAITING_FOR_AGENT: Horizon Connection Server is waiting to establish communication with Horizon Agent for one of these cases - a virtual machine in a manual desktop pool, unmanaged machine or RDS server.","example":"PROVISIONING","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_ERROR_DOMAIN_FAILURE","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","WAITING_FOR_AGENT"]},"type":{"type":"string","description":"The type of machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.\n* AWS_CORE_MACHINE: The machine is an AWS Core managed machine\n* CP_MANAGED: The machine is an capacity provider managed machine","example":"MANAGED_MACHINE","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE","AWS_CORE_MACHINE","CP_MANAGED"]},"uem_enrolment_last_error_code":{"type":"string","description":"UEM Enrolment last error code.\nSupported Filters : 'Equals'\nThis property can be used for sorting.","example":"FAILED_TO_ENROL"},"uem_enrolment_status":{"type":"string","description":"UEM Enrolment Status.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"Completed"},"user_ids":{"type":"array","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"items":{"type":"string","description":"The unique SIDs of the users assigned to the machine.<br>Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\",\"S-1-2-3-3123456786-1012345398-3123456784-124\"]"}},"user_names":{"type":"array","description":"The name of the desktop that the machine belongs to.","example":["user1"],"items":{"type":"string","description":"The name of the desktop that the machine belongs to.","example":"[\"user1\"]"}}},"description":"Information related to a Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"MachinePersistentDiskAttachSpec":{"required":["persistent_disk_id"],"type":"object","properties":{"persistent_disk_id":{"type":"string","description":"ID of the persistent disk to be attached to the machine.","example":"73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d"}},"description":"Attach specification."},"MachinePersistentDiskDetachSpec":{"required":["persistent_disk_id"],"type":"object","properties":{"archive_datastore_id":{"type":"string","description":"Datastore to which the persistent disk is to be archived. <br>If this is set, archive_datastore_path_id must also be set. <br>If unset, the persistent disk will be archived in place.","example":"datastore-44"},"archive_datastore_path_id":{"type":"string","description":"Datastore path to which the persistent disk is to be archived. <br>If this is set, archive_datastore_id must also be set. <br>If unset, the persistent disk will be archived in place.","example":"bd3ff8fc-b09a-47f7-917c-cc15c7301db6"},"persistent_disk_id":{"type":"string","description":"ID of persistent disk to be detached from the machine.","example":"73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d"}},"description":"Detach specification."},"MachinePersistentDiskRecreateSpec":{"required":["desktop_pool_id","persistent_disk_id"],"type":"object","properties":{"desktop_pool_id":{"type":"string","description":"ID of the desktop pool where the machine is to be recreated.","example":"4d480465-39e9-415e-8f0c-d7f6dc2bad52"},"machine_name":{"type":"string","description":"Name of the newly created machine, valid for specified naming desktop pools.","example":"machine-name"},"persistent_disk_id":{"type":"string","description":"ID of the persistent disk from which the machine is to be recreated.","example":"73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d"}},"description":"Information required to recreate a machine from a persistent disk."},"MachineSpecifiedName":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the machine.","example":"machine1"},"user_id":{"type":"string","description":"The unique SID of the user assigned to the machine.","example":"S-1-1-1-3965912346-1012345398-3123456564-123"}},"description":"Information required to add a machine to a desktop pool."},"MachineStateCountMetrics":{"type":"object","properties":{"un_managed_machine_counts":{"$ref":"#/components/schemas/StateCountMetrics"},"virtual_center_vm_counts":{"$ref":"#/components/schemas/StateCountMetrics"}},"description":"Counters for various Machine States"},"MachineStateCountMetricsV2":{"type":"object","properties":{"capacity_provider_vm_counts":{"$ref":"#/components/schemas/StateCountMetrics"},"un_managed_machine_counts":{"$ref":"#/components/schemas/StateCountMetrics"},"virtual_center_vm_counts":{"$ref":"#/components/schemas/StateCountMetrics"}},"description":"Counters for various Machine States"},"ManagedMachineData":{"type":"object","properties":{"clone_error_message":{"type":"string","description":"Cloning error message for this machine. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.","example":"Timeout expired trying to clone a virtual machine."},"clone_error_time":{"type":"integer","description":"Cloning error time for this machine in milliseconds. Measured as epoch time. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.","format":"int64","example":1575285661395},"create_time":{"type":"integer","description":"Time at which the machine was created in milliseconds. Measured as epoch time.\nThis property can be used for sorting.","format":"int64","example":1575285661395},"host_name":{"type":"string","description":"The name of the host on which this virtual machine is registered.\nSupported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.","example":"WD332H5"},"in_hold_customization":{"type":"boolean","description":"This condition determines if this virtual machine should be on hold before customization is started.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"in_maintenance_mode":{"type":"boolean","description":"Indicates whether the Machine is in maintenance mode.","example":false},"memory_mb":{"type":"integer","description":"The virtual machine physical memory in MB.","format":"int32","example":1024},"missing_in_vcenter":{"type":"boolean","description":"This condition determines if the virtual machine is missing in vCenter Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"network_labels":{"type":"array","description":"The network label(s) associated with this Machine.<br>This information will only be populated if a network label is explicitly assigned to this machine.<br>Otherwise, the machine inherits these properties from the parent virtual machine.","items":{"$ref":"#/components/schemas/NetworkLabelData"}},"path":{"type":"string","description":"The virtual machine path.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.Field name to be used in filter : managedMachineData.path.\nThis property can be used for sorting.","example":"/path/host"},"storage_accelerator_state":{"type":"string","description":"The Horizon Storage Accelerator state. Storage acceleration will be available for managed machines if configured.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CURRENT: The machine cached data is updated.\n* ERROR: The Storage Accelerator has encountered an error.\n* OFF: The Storage Accelerator is off.\n* OUT_OF_DATE: The machine cached data is not updated and requires regeneration.","example":"CURRENT","enum":["CURRENT","ERROR","OFF","OUT_OF_DATE"]},"virtual_center_id":{"type":"string","description":"The ID of the Virtual Center managing this machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"virtual_disks":{"type":"array","description":"The virtual disks comprising the virtual machine.","items":{"$ref":"#/components/schemas/VirtualDiskData"}},"virtual_machine_power_state":{"type":"string","description":"The virtual machine power state.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* POWERED_OFF: The machine is powered off.\n* POWERED_ON: The machine is powered on.\n* SUSPENDED: The machine is suspended.","example":"POWERED_ON","enum":["POWERED_OFF","POWERED_ON","SUSPENDED"]}},"description":"Information related to Managed machines."},"ManagedMachineDataV2":{"type":"object","properties":{"base_vm_id":{"type":"string","description":"The base VM id.<br>Supported Filters : 'Equals'.","example":"vm-23"},"base_vm_snapshot_id":{"type":"string","description":"The base VM snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-2"},"clone_error_message":{"type":"string","description":"Cloning error message for this machine. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.","example":"Timeout expired trying to clone a virtual machine."},"clone_error_time":{"type":"integer","description":"Cloning error time for this machine in milliseconds. Measured as epoch time. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.","format":"int64","example":1575285661395},"create_time":{"type":"integer","description":"Time at which the machine was created in milliseconds. Measured as epoch time.\nThis property can be used for sorting.","format":"int64","example":1575285661395},"datastore_ids":{"type":"array","description":"The ids of the datastores.","example":["datastore1","datastore2"],"items":{"type":"string","description":"The ids of the datastores.","example":"[\"datastore1\",\"datastore2\"]"}},"host_name":{"type":"string","description":"The name of the host on which this virtual machine is registered.\nSupported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.","example":"WD332H5"},"image_management_stream_id":{"type":"string","description":"The id of the image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_tag_id":{"type":"string","description":"The id of the image management tag. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"in_hold_customization":{"type":"boolean","description":"This condition determines if this virtual machine should be on hold before customization is started.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"in_maintenance_mode":{"type":"boolean","description":"Indicates whether the Machine is in maintenance mode.","example":false},"last_maintenance_time":{"type":"integer","description":"The time of the last maintenance operation.\nThis property can be used for sorting.","format":"int64","example":1587081283000},"logoff_policy":{"type":"string","description":"The user log off behavior at the time of maintenance.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"memory_mb":{"type":"integer","description":"The virtual machine physical memory in MB.","format":"int32","example":1024},"missing_in_vcenter":{"type":"boolean","description":"This condition determines if the virtual machine is missing in vCenter Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"network_labels":{"type":"array","description":"The network label(s) associated with this Machine.<br>This information will only be populated if a network label is explicitly assigned to this machine.<br>Otherwise, the machine inherits these properties from the parent virtual machine.","items":{"$ref":"#/components/schemas/NetworkLabelData"}},"operation":{"type":"string","description":"The current maintenance operation on the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"REFRESH","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"operation_state":{"type":"string","description":"The state of the current maintenance operation on the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* CANCELLING: The operation has been cancelled.\n* COMPLETED: The operation has completed.\n* CREATE: The operation is being initiated.\n* FAULT: The operation has encountered an error.\n* HOLDING: The operation has been paused.\n* PROGRESSING: The operation is in progress.\n* SCHEDULED: The operation is scheduled for future execution.\n* STANDBY: The operation is on standby for a selective resync.\n* UNDEFINED: The operation state is unrecognized.","example":"AVAILABLE","enum":["CANCELLING","COMPLETED","CREATE","FAULT","HOLDING","PROGRESSING","SCHEDULED","STANDBY","UNDEFINED"]},"path":{"type":"string","description":"The virtual machine path.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.Field name to be used in filter : managedMachineData.path.\nThis property can be used for sorting.","example":"/path/host"},"pending_base_vm_id":{"type":"string","description":"The pending base VM id.<br>Supported Filters : 'Equals'.","example":"vm-8"},"pending_base_vm_snapshot_id":{"type":"string","description":"The pending base VM snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-7"},"pending_image_management_stream_id":{"type":"string","description":"The id of the pending image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25"},"pending_image_management_tag_id":{"type":"string","description":"The id of the pending image management tag. This will be populated only for machines belonging to Instant Clone farms created using image catalog.\nSupported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"storage_accelerator_state":{"type":"string","description":"The Horizon Storage Accelerator state. Storage acceleration will be available for managed machines if configured.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CURRENT: The machine cached data is updated.\n* ERROR: The Storage Accelerator has encountered an error.\n* OFF: The Storage Accelerator is off.\n* OUT_OF_DATE: The machine cached data is not updated and requires regeneration.","example":"CURRENT","enum":["CURRENT","ERROR","OFF","OUT_OF_DATE"]},"virtual_center_id":{"type":"string","description":"The ID of the Virtual Center managing this machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"virtual_disks":{"type":"array","description":"The virtual disks comprising the virtual machine.","items":{"$ref":"#/components/schemas/VirtualDiskData"}},"virtual_machine_power_state":{"type":"string","description":"The virtual machine power state.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* POWERED_OFF: The machine is powered off.\n* POWERED_ON: The machine is powered on.\n* SUSPENDED: The machine is suspended.","example":"POWERED_ON","enum":["POWERED_OFF","POWERED_ON","SUSPENDED"]}},"description":"Information related to Managed machines V2."},"ManagedMachineDataV3":{"type":"object","properties":{"base_vm_id":{"type":"string","description":"The base VM id.<br>Supported Filters : 'Equals'.","example":"vm-23"},"base_vm_snapshot_id":{"type":"string","description":"The base VM snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-2"},"clone_error_message":{"type":"string","description":"Cloning error message for this machine. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.","example":"Timeout expired trying to clone a virtual machine."},"clone_error_time":{"type":"integer","description":"Cloning error time for this machine in milliseconds. Measured as epoch time. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.","format":"int64","example":1575285661395},"create_time":{"type":"integer","description":"Time at which the machine was created in milliseconds. Measured as epoch time.\nThis property can be used for sorting.","format":"int64","example":1575285661395},"datastore_ids":{"type":"array","description":"The ids of the datastores.","example":["datastore1","datastore2"],"items":{"type":"string","description":"The ids of the datastores.","example":"[\"datastore1\",\"datastore2\"]"}},"host_name":{"type":"string","description":"The name of the host on which this virtual machine is registered.\nSupported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.","example":"WD332H5"},"image_management_stream_id":{"type":"string","description":"The id of the image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_tag_id":{"type":"string","description":"The id of the image management tag. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"in_hold_customization":{"type":"boolean","description":"This condition determines if this virtual machine should be on hold before customization is started.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"in_maintenance_mode":{"type":"boolean","description":"Indicates whether the Machine is in maintenance mode.","example":false},"last_maintenance_time":{"type":"integer","description":"The time of the last maintenance operation.\nThis property can be used for sorting.","format":"int64","example":1587081283000},"logoff_policy":{"type":"string","description":"The user log off behavior at the time of maintenance.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"memory_mb":{"type":"integer","description":"The virtual machine physical memory in MB.","format":"int32","example":1024},"missing_in_vcenter":{"type":"boolean","description":"This condition determines if the virtual machine is missing in vCenter Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"network_labels":{"type":"array","description":"The network label(s) associated with this Machine.<br>This information will only be populated if a network label is explicitly assigned to this machine.<br>Otherwise, the machine inherits these properties from the parent virtual machine.","items":{"$ref":"#/components/schemas/NetworkLabelData"}},"operation":{"type":"string","description":"The current maintenance operation on the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"REFRESH","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"operation_state":{"type":"string","description":"The state of the current maintenance operation on the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* CANCELLING: The operation has been cancelled.\n* COMPLETED: The operation has completed.\n* CREATE: The operation is being initiated.\n* FAULT: The operation has encountered an error.\n* HOLDING: The operation has been paused.\n* PROGRESSING: The operation is in progress.\n* SCHEDULED: The operation is scheduled for future execution.\n* STANDBY: The operation is on standby for a selective resync.\n* UNDEFINED: The operation state is unrecognized.","example":"AVAILABLE","enum":["CANCELLING","COMPLETED","CREATE","FAULT","HOLDING","PROGRESSING","SCHEDULED","STANDBY","UNDEFINED"]},"path":{"type":"string","description":"The virtual machine path.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.Field name to be used in filter : managedMachineData.path.\nThis property can be used for sorting.","example":"/path/host"},"pending_base_vm_id":{"type":"string","description":"The pending base VM id.<br>Supported Filters : 'Equals'.","example":"vm-8"},"pending_base_vm_snapshot_id":{"type":"string","description":"The pending base VM snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-7"},"pending_image_management_stream_id":{"type":"string","description":"The id of the pending image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25"},"pending_image_management_tag_id":{"type":"string","description":"The id of the pending image management tag. This will be populated only for machines belonging to Instant Clone farms created using image catalog.\nSupported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"persistent_disk_ids":{"uniqueItems":true,"type":"array","description":"The persistent disk(s) attached to this machine.","example":["c1d5aec7-2126-3c55-aefa-11949003c9c2"],"items":{"type":"string","description":"The persistent disk(s) attached to this machine.","example":"[\"c1d5aec7-2126-3c55-aefa-11949003c9c2\"]"}},"storage_accelerator_state":{"type":"string","description":"The Horizon Storage Accelerator state. Storage acceleration will be available for managed machines if configured.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CURRENT: The machine cached data is updated.\n* ERROR: The Storage Accelerator has encountered an error.\n* OFF: The Storage Accelerator is off.\n* OUT_OF_DATE: The machine cached data is not updated and requires regeneration.","example":"CURRENT","enum":["CURRENT","ERROR","OFF","OUT_OF_DATE"]},"virtual_center_id":{"type":"string","description":"The ID of the Virtual Center managing this machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"virtual_disks":{"type":"array","description":"The virtual disks comprising the virtual machine.","items":{"$ref":"#/components/schemas/VirtualDiskData"}},"virtual_machine_power_state":{"type":"string","description":"The virtual machine power state.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* POWERED_OFF: The machine is powered off.\n* POWERED_ON: The machine is powered on.\n* SUSPENDED: The machine is suspended.","example":"POWERED_ON","enum":["POWERED_OFF","POWERED_ON","SUSPENDED"]},"vm_moid":{"type":"string","description":"The moid of managed machine.<br>Supported Filters: 'Equals'.","example":"vm-123"}},"description":"Information related to Managed machines."},"ManagedMachineDataV4":{"type":"object","properties":{"base_snapshot_path":{"type":"string","description":"base snapshot nameSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"snapshot-1"},"base_vm_id":{"type":"string","description":"The base VM id.<br>Supported Filters : 'Equals'.","example":"vm-23"},"base_vm_path":{"type":"string","description":"base vm name\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"vm-1"},"base_vm_snapshot_id":{"type":"string","description":"The base VM snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-2"},"clone_error_message":{"type":"string","description":"Cloning error message for this machine. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.","example":"Timeout expired trying to clone a virtual machine."},"clone_error_time":{"type":"integer","description":"Cloning error time for this machine in milliseconds. Measured as epoch time. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.","format":"int64","example":1575285661395},"create_time":{"type":"integer","description":"Time at which the machine was created in milliseconds. Measured as epoch time.\nThis property can be used for sorting.","format":"int64","example":1575285661395},"datastore_ids":{"type":"array","description":"The ids of the datastores.","example":["datastore1","datastore2"],"items":{"type":"string","description":"The ids of the datastores.","example":"[\"datastore1\",\"datastore2\"]"}},"datastore_paths":{"type":"array","description":"The name of the datastores occupied by the machine\nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"The name of the datastores occupied by the machine\nSupported Filters : 'Contains'","example":"datastore-1"}},"host_name":{"type":"string","description":"The name of the host on which this virtual machine is registered.\nSupported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.","example":"WD332H5"},"im_stream_name":{"type":"string","description":"Image Management Stream name","example":"ims-1"},"im_tag_name":{"type":"string","description":"Image Management Tag name","example":"imt-1"},"image_management_stream_id":{"type":"string","description":"The id of the image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_tag_id":{"type":"string","description":"The id of the image management tag. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"in_hold_customization":{"type":"boolean","description":"This condition determines if this virtual machine should be on hold before customization is started.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"in_maintenance_mode":{"type":"boolean","description":"Indicates whether the Machine is in maintenance mode.","example":false},"last_maintenance_time":{"type":"integer","description":"The time of the last maintenance operation.\nThis property can be used for sorting.","format":"int64","example":1587081283000},"logoff_policy":{"type":"string","description":"The user log off behavior at the time of maintenance.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"memory_mb":{"type":"integer","description":"The virtual machine physical memory in MB.","format":"int32","example":1024},"missing_in_vcenter":{"type":"boolean","description":"This condition determines if the virtual machine is missing in vCenter Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"network_labels":{"type":"array","description":"The network label(s) associated with this Machine.<br>This information will only be populated if a network label is explicitly assigned to this machine.<br>Otherwise, the machine inherits these properties from the parent virtual machine.","items":{"$ref":"#/components/schemas/NetworkLabelData"}},"operation":{"type":"string","description":"The current maintenance operation on the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"REFRESH","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"operation_state":{"type":"string","description":"The state of the current maintenance operation on the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* CANCELLING: The operation has been cancelled.\n* COMPLETED: The operation has completed.\n* CREATE: The operation is being initiated.\n* FAULT: The operation has encountered an error.\n* HOLDING: The operation has been paused.\n* PROGRESSING: The operation is in progress.\n* SCHEDULED: The operation is scheduled for future execution.\n* STANDBY: The operation is on standby for a selective resync.\n* UNDEFINED: The operation state is unrecognized.","example":"AVAILABLE","enum":["CANCELLING","COMPLETED","CREATE","FAULT","HOLDING","PROGRESSING","SCHEDULED","STANDBY","UNDEFINED"]},"path":{"type":"string","description":"The virtual machine path.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.Field name to be used in filter : managedMachineData.path.\nThis property can be used for sorting.","example":"/path/host"},"pending_base_snapshot_path":{"type":"string","description":"pending base snapshot nameSupported Filters : 'Equals', 'StartsWith', 'Contains'","example":"snapshot-1"},"pending_base_vm_id":{"type":"string","description":"The pending base VM id.<br>Supported Filters : 'Equals'.","example":"vm-8"},"pending_base_vm_path":{"type":"string","description":"pending base vm path\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"vm-1"},"pending_base_vm_snapshot_id":{"type":"string","description":"The pending base VM snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-7"},"pending_im_stream_name":{"type":"string","description":"pending Image Management Stream name","example":"ims-1"},"pending_im_tag_name":{"type":"string","description":"pending Image Management Tag name","example":"imt-1"},"pending_image_management_stream_id":{"type":"string","description":"The id of the pending image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25"},"pending_image_management_tag_id":{"type":"string","description":"The id of the pending image management tag. This will be populated only for machines belonging to Instant Clone farms created using image catalog.\nSupported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"persistent_disk_ids":{"uniqueItems":true,"type":"array","description":"The persistent disk(s) attached to this machine.","example":["c1d5aec7-2126-3c55-aefa-11949003c9c2"],"items":{"type":"string","description":"The persistent disk(s) attached to this machine.","example":"[\"c1d5aec7-2126-3c55-aefa-11949003c9c2\"]"}},"storage_accelerator_state":{"type":"string","description":"The Horizon Storage Accelerator state. Storage acceleration will be available for managed machines if configured.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CURRENT: The machine cached data is updated.\n* ERROR: The Storage Accelerator has encountered an error.\n* OFF: The Storage Accelerator is off.\n* OUT_OF_DATE: The machine cached data is not updated and requires regeneration.","example":"CURRENT","enum":["CURRENT","ERROR","OFF","OUT_OF_DATE"]},"virtual_center_id":{"type":"string","description":"The ID of the Virtual Center managing this machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"virtual_disks":{"type":"array","description":"The virtual disks comprising the virtual machine.","items":{"$ref":"#/components/schemas/VirtualDiskData"}},"virtual_machine_power_state":{"type":"string","description":"The virtual machine power state.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* POWERED_OFF: The machine is powered off.\n* POWERED_ON: The machine is powered on.\n* SUSPENDED: The machine is suspended.","example":"POWERED_ON","enum":["POWERED_OFF","POWERED_ON","SUSPENDED"]},"vm_moid":{"type":"string","description":"The moid of managed machine.<br>Supported Filters: 'Equals'.","example":"vm-123"}},"description":"Information related to Managed machines."},"ManagedMachineDataV5":{"type":"object","properties":{"base_snapshot_path":{"type":"string","description":"base snapshot nameSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"snapshot-1"},"base_vm_id":{"type":"string","description":"The base VM id.<br>Supported Filters : 'Equals'.","example":"vm-23"},"base_vm_path":{"type":"string","description":"base vm name\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"vm-1"},"base_vm_snapshot_id":{"type":"string","description":"The base VM snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-2"},"clone_error_message":{"type":"string","description":"Cloning error message for this machine. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.","example":"Timeout expired trying to clone a virtual machine."},"clone_error_time":{"type":"integer","description":"Cloning error time for this machine in milliseconds. Measured as epoch time. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.","format":"int64","example":1575285661395},"create_time":{"type":"integer","description":"Time at which the machine was created in milliseconds. Measured as epoch time.\nThis property can be used for sorting.","format":"int64","example":1575285661395},"datastore_ids":{"type":"array","description":"The ids of the datastores.","example":["datastore1","datastore2"],"items":{"type":"string","description":"The ids of the datastores.","example":"[\"datastore1\",\"datastore2\"]"}},"datastore_paths":{"type":"array","description":"The name of the datastores occupied by the machine\nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"The name of the datastores occupied by the machine\nSupported Filters : 'Contains'","example":"datastore-1"}},"host_name":{"type":"string","description":"The name of the host on which this virtual machine is registered.\nSupported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.","example":"WD332H5"},"im_stream_name":{"type":"string","description":"Image Management Stream name","example":"ims-1"},"im_tag_name":{"type":"string","description":"Image Management Tag name","example":"imt-1"},"image_management_stream_id":{"type":"string","description":"The id of the image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_tag_id":{"type":"string","description":"The id of the image management tag. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"in_hold_customization":{"type":"boolean","description":"This condition determines if this virtual machine should be on hold before customization is started.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"in_maintenance_mode":{"type":"boolean","description":"Indicates whether the Machine is in maintenance mode.","example":false},"last_maintenance_time":{"type":"integer","description":"The time of the last maintenance operation.\nThis property can be used for sorting.","format":"int64","example":1587081283000},"logoff_policy":{"type":"string","description":"The user log off behavior at the time of maintenance.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"memory_mb":{"type":"integer","description":"The virtual machine physical memory in MB.","format":"int32","example":1024},"missing_in_vcenter":{"type":"boolean","description":"This condition determines if the virtual machine is missing in vCenter Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"network_label_names":{"type":"array","description":"The name of network labels associated to the machine\nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"The name of network labels associated to the machine\nSupported Filters : 'Contains'","example":"datastore-1"}},"network_labels":{"type":"array","description":"The network label(s) associated with this Machine.<br>This information will only be populated if a network label is explicitly assigned to this machine.<br>Otherwise, the machine inherits these properties from the parent virtual machine.","items":{"$ref":"#/components/schemas/NetworkLabelData"}},"operation":{"type":"string","description":"The current maintenance operation on the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"REFRESH","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"operation_state":{"type":"string","description":"The state of the current maintenance operation on the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* CANCELLING: The operation has been cancelled.\n* COMPLETED: The operation has completed.\n* CREATE: The operation is being initiated.\n* FAULT: The operation has encountered an error.\n* HOLDING: The operation has been paused.\n* PROGRESSING: The operation is in progress.\n* SCHEDULED: The operation is scheduled for future execution.\n* STANDBY: The operation is on standby for a selective resync.\n* UNDEFINED: The operation state is unrecognized.","example":"AVAILABLE","enum":["CANCELLING","COMPLETED","CREATE","FAULT","HOLDING","PROGRESSING","SCHEDULED","STANDBY","UNDEFINED"]},"path":{"type":"string","description":"The virtual machine path.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.Field name to be used in filter : managedMachineData.path.\nThis property can be used for sorting.","example":"/path/host"},"pending_base_snapshot_path":{"type":"string","description":"pending base snapshot nameSupported Filters : 'Equals', 'StartsWith', 'Contains'","example":"snapshot-1"},"pending_base_vm_id":{"type":"string","description":"The pending base VM id.<br>Supported Filters : 'Equals'.","example":"vm-8"},"pending_base_vm_path":{"type":"string","description":"pending base vm path\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"vm-1"},"pending_base_vm_snapshot_id":{"type":"string","description":"The pending base VM snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-7"},"pending_im_stream_name":{"type":"string","description":"pending Image Management Stream name","example":"ims-1"},"pending_im_tag_name":{"type":"string","description":"pending Image Management Tag name","example":"imt-1"},"pending_image_management_stream_id":{"type":"string","description":"The id of the pending image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25"},"pending_image_management_tag_id":{"type":"string","description":"The id of the pending image management tag. This will be populated only for machines belonging to Instant Clone farms created using image catalog.\nSupported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"persistent_disk_ids":{"uniqueItems":true,"type":"array","description":"The persistent disk(s) attached to this machine.","example":["c1d5aec7-2126-3c55-aefa-11949003c9c2"],"items":{"type":"string","description":"The persistent disk(s) attached to this machine.","example":"[\"c1d5aec7-2126-3c55-aefa-11949003c9c2\"]"}},"storage_accelerator_state":{"type":"string","description":"The Horizon Storage Accelerator state. Storage acceleration will be available for managed machines if configured.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CURRENT: The machine cached data is updated.\n* ERROR: The Storage Accelerator has encountered an error.\n* OFF: The Storage Accelerator is off.\n* OUT_OF_DATE: The machine cached data is not updated and requires regeneration.","example":"CURRENT","enum":["CURRENT","ERROR","OFF","OUT_OF_DATE"]},"virtual_center_id":{"type":"string","description":"The ID of the Virtual Center managing this machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"virtual_disks":{"type":"array","description":"The virtual disks comprising the virtual machine.","items":{"$ref":"#/components/schemas/VirtualDiskData"}},"virtual_machine_power_state":{"type":"string","description":"The virtual machine power state.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* POWERED_OFF: The machine is powered off.\n* POWERED_ON: The machine is powered on.\n* SUSPENDED: The machine is suspended.","example":"POWERED_ON","enum":["POWERED_OFF","POWERED_ON","SUSPENDED"]},"vm_moid":{"type":"string","description":"The moid of managed machine.<br>Supported Filters: 'Equals'.","example":"vm-123"}},"description":"Information related to Managed machines."},"ManagedMachineDataV6":{"type":"object","properties":{"base_snapshot_path":{"type":"string","description":"base snapshot nameSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"snapshot-1"},"base_vm_id":{"type":"string","description":"The base VM id.<br>Supported Filters : 'Equals'.","example":"vm-23"},"base_vm_path":{"type":"string","description":"base vm name\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"vm-1"},"base_vm_snapshot_id":{"type":"string","description":"The base VM snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-2"},"clone_error_message":{"type":"string","description":"Cloning error message for this machine. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.","example":"Timeout expired trying to clone a virtual machine."},"clone_error_time":{"type":"integer","description":"Cloning error time for this machine in milliseconds. Measured as epoch time. This will be set for machine belonging to automated desktop pools when the machine's state is in PROVISIONING_ERROR or ERROR state.","format":"int64","example":1575285661395},"create_time":{"type":"integer","description":"Time at which the machine was created in milliseconds. Measured as epoch time.\nThis property can be used for sorting.","format":"int64","example":1575285661395},"datastore_ids":{"type":"array","description":"The ids of the datastores.","example":["datastore1","datastore2"],"items":{"type":"string","description":"The ids of the datastores.","example":"[\"datastore1\",\"datastore2\"]"}},"datastore_paths":{"type":"array","description":"The name of the datastores occupied by the machine\nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"The name of the datastores occupied by the machine\nSupported Filters : 'Contains'","example":"datastore-1"}},"host_name":{"type":"string","description":"The name of the host on which this virtual machine is registered.\nSupported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.","example":"WD332H5"},"im_stream_name":{"type":"string","description":"Image Management Stream name","example":"ims-1"},"im_tag_name":{"type":"string","description":"Image Management Tag name","example":"imt-1"},"image_management_stream_id":{"type":"string","description":"The id of the image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_tag_id":{"type":"string","description":"The id of the image management tag. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"in_hold_customization":{"type":"boolean","description":"This condition determines if this virtual machine should be on hold before customization is started.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"in_maintenance_mode":{"type":"boolean","description":"Indicates whether the Machine is in maintenance mode.","example":false},"last_maintenance_time":{"type":"integer","description":"The time of the last maintenance operation.\nThis property can be used for sorting.","format":"int64","example":1587081283000},"logoff_policy":{"type":"string","description":"The user log off behavior at the time of maintenance.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"memory_mb":{"type":"integer","description":"The virtual machine physical memory in MB.","format":"int32","example":1024},"missing_in_vcenter":{"type":"boolean","description":"This condition determines if the virtual machine is missing in vCenter Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"network_label_names":{"type":"array","description":"The name of network labels associated to the machine\nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"The name of network labels associated to the machine\nSupported Filters : 'Contains'","example":"datastore-1"}},"network_labels":{"type":"array","description":"The network label(s) associated with this Machine.<br>This information will only be populated if a network label is explicitly assigned to this machine.<br>Otherwise, the machine inherits these properties from the parent virtual machine.","items":{"$ref":"#/components/schemas/NetworkLabelData"}},"operation":{"type":"string","description":"The current maintenance operation on the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"REFRESH","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"operation_state":{"type":"string","description":"The state of the current maintenance operation on the machine.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* CANCELLING: The operation has been cancelled.\n* COMPLETED: The operation has completed.\n* CREATE: The operation is being initiated.\n* FAULT: The operation has encountered an error.\n* HOLDING: The operation has been paused.\n* PROGRESSING: The operation is in progress.\n* SCHEDULED: The operation is scheduled for future execution.\n* STANDBY: The operation is on standby for a selective resync.\n* UNDEFINED: The operation state is unrecognized.","example":"AVAILABLE","enum":["CANCELLING","COMPLETED","CREATE","FAULT","HOLDING","PROGRESSING","SCHEDULED","STANDBY","UNDEFINED"]},"path":{"type":"string","description":"The virtual machine path.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.Field name to be used in filter : managedMachineData.path.\nThis property can be used for sorting.","example":"/path/host"},"pending_base_snapshot_path":{"type":"string","description":"pending base snapshot nameSupported Filters : 'Equals', 'StartsWith', 'Contains'","example":"snapshot-1"},"pending_base_vm_id":{"type":"string","description":"The pending base VM id.<br>Supported Filters : 'Equals'.","example":"vm-8"},"pending_base_vm_path":{"type":"string","description":"pending base vm path\nSupported Filters : 'Equals', 'StartsWith', 'Contains'\nThis property can be used for sorting.","example":"vm-1"},"pending_base_vm_snapshot_id":{"type":"string","description":"The pending base VM snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-7"},"pending_im_stream_name":{"type":"string","description":"pending Image Management Stream name","example":"ims-1"},"pending_im_tag_name":{"type":"string","description":"pending Image Management Tag name","example":"imt-1"},"pending_image_management_stream_id":{"type":"string","description":"The id of the pending image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.\nSupported Filters : 'Equals'.","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25"},"pending_image_management_tag_id":{"type":"string","description":"The id of the pending image management tag. This will be populated only for machines belonging to Instant Clone farms created using image catalog.\nSupported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"persistent_disk_ids":{"uniqueItems":true,"type":"array","description":"The persistent disk(s) attached to this machine.","example":["c1d5aec7-2126-3c55-aefa-11949003c9c2"],"items":{"type":"string","description":"The persistent disk(s) attached to this machine.","example":"[\"c1d5aec7-2126-3c55-aefa-11949003c9c2\"]"}},"storage_accelerator_state":{"type":"string","description":"The Horizon Storage Accelerator state. Storage acceleration will be available for managed machines if configured.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CURRENT: The machine cached data is updated.\n* ERROR: The Storage Accelerator has encountered an error.\n* OFF: The Storage Accelerator is off.\n* OUT_OF_DATE: The machine cached data is not updated and requires regeneration.","example":"CURRENT","enum":["CURRENT","ERROR","OFF","OUT_OF_DATE"]},"template_name":{"type":"string","description":"The name of the VM template used to create this machine\nSupported Filters : 'Equals', 'StartsWith', 'EndsWith', 'Contains'\nThis property can be used for sorting.","example":"Windows-10-Template"},"virtual_center_id":{"type":"string","description":"The ID of the Virtual Center managing this machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"virtual_disks":{"type":"array","description":"The virtual disks comprising the virtual machine.","items":{"$ref":"#/components/schemas/VirtualDiskData"}},"virtual_machine_power_state":{"type":"string","description":"The virtual machine power state.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* POWERED_OFF: The machine is powered off.\n* POWERED_ON: The machine is powered on.\n* SUSPENDED: The machine is suspended.","example":"POWERED_ON","enum":["POWERED_OFF","POWERED_ON","SUSPENDED"]},"vm_moid":{"type":"string","description":"The moid of managed machine.<br>Supported Filters: 'Equals'.","example":"vm-123"}},"description":"Information related to Managed machines."},"MessageClientCreateSpec":{"required":["client_type","client_uuid","pem_certificate"],"type":"object","properties":{"client_type":{"type":"string","description":"The message client type, which should be a member of MessageClientType.\n* EDGE: EDGE Gateway user.\n* CSMS: CSMS user.","example":"EDGE","enum":["EDGE","CSMS"]},"client_uuid":{"type":"string","description":"The message client uuid, which is generated by client itself.","example":"6414a63f-694a-4982-b670-f564af076986"},"pem_certificate":{"type":"string","description":"The message client certificate in PEM format. PemCertificate should be valid and its subject should be CN=clientType/clientUuid, ","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"}},"description":"Message Client specification"},"MessageClientInfo":{"type":"object","properties":{"client_type":{"type":"string","description":"The message client type, which should be a member of MessageClientType.\n* EDGE: EDGE Gateway user.\n* CSMS: CSMS user.","example":"EDGE","enum":["EDGE","CSMS"]},"id":{"type":"string","description":"Unique ID representing the message client.","example":"EDGE-665b09dd-92cc-4da5-8521-1c9a4361493b"},"marked_for_delete":{"type":"boolean","description":"Indicates whether the message client is triggered for deletion.","example":true}},"description":"Information about message client."},"MessageClientMonitorInfo":{"type":"object","properties":{"client_type":{"type":"string","description":"The message client type.\n* EDGE: EDGE Gateway user.\n* CSMS: CSMS user.","example":"EDGE","enum":["EDGE","CSMS"]},"id":{"type":"string","description":"Unique ID representing the message client.","example":"EDGE-665b09dd-92cc-4da5-8521-1c9a4361493b"},"last_disconnect_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the message client was last seen. Measured as epoch time.","format":"int64","example":1582029025748},"message_client_status":{"type":"string","description":"The message client status.\n* CONNECTED: Connected.\n* DISCONNECTED: Disconnected.\n* REGISTERED: Registered.","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","REGISTERED"]}},"description":"Health information about message client."},"MessageClientUpdateSpec":{"required":["pem_certificate"],"type":"object","properties":{"pem_certificate":{"type":"string","description":"The message client certificate in PEM format. PemCertificate should be valid and its subject should be CN=clientType/clientUuid, ","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"}},"description":"Message client object to be updated."},"NameAvailabilityInfo":{"type":"object","properties":{"available":{"type":"boolean","description":"Indicates whether name is available for resource creation."}},"description":"Information about name availability of an inventory resource."},"NameAvailabilitySpec":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the inventory resource to be checked for availability."}},"description":"Name Availability Spec."},"NamesSpec":{"required":["machine_name"],"type":"object","properties":{"machine_name":{"type":"string","description":"The virtual machine name.","example":"Machine-002-jdoe"},"user_name":{"type":"string","description":"The name of the user entitled to the VM, used only in case of persistent desktop pools.","example":"abcorp.com\\jdoe"}},"description":"Manually defined virtual machines and users."},"NetworkInfo":{"type":"object","properties":{"additional_details":{"type":"object","description":"Additional details of the Capacity provider's network ","example":"{\n   \"Used_For\": \"Client_Machines\",\n   \"CREATED_DATE\": \"04-11-2024\",\n}"},"description":{"type":"string","description":"Capacity provider's network description.","example":"Network settings for windows-10"},"id":{"type":"string","description":"Unique identifier for the network.","example":"00061d88-9491-eff9-43cf-246e967105e0"},"name":{"type":"string","description":"Capacity provider's network name.","example":"Network-1"},"type":{"type":"string","description":"Type of networks supported by the capacity provider.\n* VLAN: VLAN subnet\n* OVERLAY: Overlay subnet of a VPC\n* UNKNOWN: UNKNOWN network","example":"VLAN","enum":["VLAN","OVERLAY","UNKNOWN"]}},"description":"Information related to capacity provider network."},"NetworkInterfaceCardInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID representing the network interface card.","example":"74390016-2dea-4b8c-8181-385783effaeb"},"mac_address":{"type":"string","description":"Network interface card MAC address.","example":"00:50:56:a6:62:ac"},"name":{"type":"string","description":"Network interface card name.","example":"Network adapter 1"}},"description":"Information related to network interface card."},"NetworkInterfaceCardInfoV2":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID representing the network interface card.","example":"74390016-2dea-4b8c-8181-385783effaeb"},"mac_address":{"type":"string","description":"Network interface card MAC address.","example":"00:50:56:a6:62:ac"},"name":{"type":"string","description":"Network interface card name.","example":"Network adapter 1"},"network_type":{"type":"string","description":"Type of network interface card.\n* NETWORK: Standard network.\n* OPAQUE_NETWORK: Opaque network.\n* DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS Port group.","example":"OPAQUE_NETWORK","enum":["NETWORK","OPAQUE_NETWORK","DISTRUBUTED_VIRTUAL_PORT_GROUP"]}},"description":"Information related to network interface card."},"NetworkLabelAssignmentSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not this specification is enabled. While this specification is disabled, automatic network label assigment for this desktop pool will skip over the network label in this spec.","example":true},"max_label":{"type":"integer","description":"The maximum number of times this label can be assigned to a machine. Note this count only encompasses this spec. That is, this label may be used for other NICs and in other Desktop pools, but those assignments will not be counted towards this total. This count also does not include assignments of this label to machines not under the control of View.","format":"int32","example":1},"max_label_type":{"type":"string","description":"This type specifies whether or not there is a maximum limit to the number of times this label may be assigned to machines within this spec. While this specification is enabled and unlimited, specs after this one in the NIC's network label specification list will never be used.\n* UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.\n* LIMITED: The network label assignment specification has a limited number of labels to assign.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","description":"The network label id for this spec. This network label must not have any incompatibility reasons that would preclude it from automatic machine assignment.","example":"vm-network"}},"description":"Specification for an individual network label assignment, stipulating the label and how many times it may be assigned to machines with this spec."},"NetworkLabelAssignmentSettingsInfo":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether or not this specification is enabled. While this specification is disabled, automatic network label assignment for this automated farm will skip over the network label in this spec.","example":true},"max_label":{"type":"integer","description":"The maximum number of times this label can be assigned to a RDS server. Note this count only encompasses this spec. That is, this label may be used for other NICs and in other farms, but those assignments will not be counted towards this total. This count also does not include assignments of this label to RDS server not under the control of View. This is set when max_label_type is LIMITED.","format":"int32","example":1},"max_label_type":{"type":"string","description":"This type specifies whether or not there is a maximum limit to the number of times this label may be assigned to machines within this spec. While this specification is enabled and unlimited, specs after this one in the NIC's network label specification list will never be used.\n* UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.\n* LIMITED: The network label assignment specification has a limited number of labels to assign.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","description":"The network label id for this spec. This network label must not have any incompatibility reasons that would preclude it from automatic machine assignment.","example":"vm-network"}},"description":"Network label assignment settings for the farm."},"NetworkLabelData":{"type":"object","properties":{"network_label_name":{"type":"string","description":"The network label name.","example":"example-network"},"nic_name":{"type":"string","description":"The network interface name","example":"network1"}},"description":"Information related to a network label."},"NetworkLabelInfo":{"type":"object","properties":{"available_ports":{"type":"integer","description":"Available ports in network label.","format":"int32","example":0},"id":{"type":"string","description":"Unique ID representing the network label.","example":"network-1"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this Network Label from being used in desktoppool/farm configuration.","items":{"type":"string","description":"* NOT_CONFIGURED_ON_ALL_HOSTS: When the network label is not configured on all hosts in a cluster, it cannot be used in desktop pool/farm configuration.\n* DVS_UPLINK_PORT: When the network label has the standard name of the distributed virtual switch uplink port, which cannot be assigned to virtual machines.\n* VMC_NETWORKS: When network label belongs to VMC Networks.","enum":["NOT_CONFIGURED_ON_ALL_HOSTS","DVS_UPLINK_PORT","VMC_NETWORKS"]}},"label_type":{"type":"string","description":"Network label type.\n* EARLY_BINDING: A free Distributed Virtual Port will be selected and assigned to a Virtual Machine when the Virtual Machine is reconfigured to connect to the portgroup. Instant clones desktop pools/farms only support port group type of early binding.\n* EPHEMERAL: A Distributed Virtual Port will be created and assigned to a Virtual Machine when the Virtual Machine is powered on, and will be deleted when the Virtual Machine is powered off. An ephemeral portgroup has no limit on the number of ports that can be a part of this portgroup. In cases where the vCenter Server is unavailable the host can create conflict ports in this portgroup to be used by a Virtual Machine at power on.\n* LATE_BINDING: Deprecated as of vSphere API 5.0 A free DistributedVirtualPort will be selected and assigned to a Virtual Machine when the Virtual Machine is powered on.","example":"EARLY_BINDING","enum":["EARLY_BINDING","EPHEMERAL","LATE_BINDING"]},"max_ports":{"type":"integer","description":"The total number of ports present.","format":"int32","example":0},"name":{"type":"string","description":"Network label name.","example":"VM Network"},"switch_type":{"type":"string","description":"Network label switch type.\n* STANDARD_SWITCH: Standard Switch.\n* DISTRIBUTED_VIRTUAL_SWITCH: Distributed Virtual Switch.\n* NSX_NETWORK_SWITCH: NSX network Switch.","example":"STANDARD_SWITCH","enum":["STANDARD_SWITCH","DISTRIBUTED_VIRTUAL_SWITCH","NSX_NETWORK_SWITCH"]}},"description":"Information related to network label."},"NetworkLabelSpec":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether or not this specification is enabled. While this specification is disabled, automatic network label assignment for this automated farm will skip over the network label in this spec.","example":true},"max_label":{"type":"integer","description":"The maximum number of times this label can be assigned to a RDS server. Note this count only encompasses this spec. That is, this label may be used for other NICs and in other farms, but those assignments will not be counted towards this total. This count also does not include assignments of this label to RDS server not under the control of View. This is set when max_label_type is LIMITED.","format":"int32","example":1},"max_label_type":{"type":"string","description":"This type specifies whether or not there is a maximum limit to the number of times this label may be assigned to machines within this spec. While this specification is enabled and unlimited, specs after this one in the NIC's network label specification list will never be used.\n* UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.\n* LIMITED: The network label assignment specification has a limited number of labels to assign.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","description":"The network label id for this spec. This network label must not have any incompatibility reasons that would preclude it from automatic machine assignment.","example":"vm-network"}},"description":"Network label specification for the farm"},"NetworkSettings":{"type":"object","properties":{"network_id":{"type":"string","description":"ID of the network","example":"c9896e51-48a2-4d82-ae9e-a0246981b473"},"network_label_spec":{"type":"array","description":"Automatic network label assignment feature settings for this network.","items":{"$ref":"#/components/schemas/NetworkLabelSpec"}},"network_name":{"type":"string","description":"Name of the network","example":"network adapter 1"}},"description":"Network settings for the automated farm"},"NotContainsFilter":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseFilter"},{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"object"}}}],"required":["name","type","value"]},"NotEqualsFilter":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseFilter"},{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"object"}}}],"required":["name","type"]},"NotFilter":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseFilter"},{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/BaseFilter"}}}],"required":["filter","type"]},"OrFilter":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseFilter"},{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/BaseFilter"}}}}],"required":["filters","type"]},"PcoipPerformanceData":{"type":"object","properties":{"audio_bytes_received":{"type":"integer","description":"Total number of bytes of audio data that have been received since the PCoIP session started.","format":"int64","example":1652079610000},"audio_bytes_sent":{"type":"integer","description":"Total number of bytes of audio data that have been sent since the PCoIP session started.","format":"int64","example":1652079610000},"audio_rx_bandwidth":{"type":"integer","description":"Bandwidth for incoming audio packets averaged over the sampling period, in kilobits per second.","format":"int64","example":1652079610000},"audio_tx_bandwidth":{"type":"integer","description":"Bandwidth for outgoing audio packets averaged over the sampling period, in kilobits per second.","format":"int64","example":1652079610000},"audio_tx_bandwidth_limit":{"type":"integer","description":"Transmission bandwidth limit in kilobits per second for outgoing audio packets. The limit is defined by a GPO setting.","format":"int64","example":1652079610000},"general_bytes_received":{"type":"integer","description":"Total number of bytes of PCoIP data that have been received since the PCoIP session started.","format":"int64","example":3872079619320},"general_bytes_sent":{"type":"integer","description":"Total number of bytes of PCoIP data that have been transmitted since the PCoIP session started.","format":"int64","example":1652079610000},"general_duration_seconds":{"type":"integer","description":"Total number of seconds that the PCoIP session has been open.","format":"int64","example":1652079610000},"general_packets_received":{"type":"integer","description":"Total number of packets that have been received successfully since the PCoIP session started. Not all packets are the same size.\t","format":"int64","example":1652079610000},"general_packets_sent":{"type":"integer","description":"Total number of packets that have been sent since the PCoIP session started. Not all packets are the same size.","format":"int64","example":1652079610000},"general_rx_packets_lost":{"type":"integer","description":"Total number of received packets that have been lost since the PCoIP session started.","format":"int64","example":1652079610000},"general_tx_packets_lost":{"type":"integer","description":"Total number of transmitted packets that have been lost since the PCoIP session started.","format":"int64","example":1652079610000},"imaging_active_minimum_quality":{"type":"integer","description":"Lowest encoded quality value on a scale from 0 to 100. This statistic is updated once per second. This counter does not correspond to the GPO setting for minimum quality.","format":"int64","example":1652079610000},"imaging_apex2800_offload":{"type":"integer","description":"The number of times Apex2800 offloading is utilized over a one-second sampling period.","format":"int64","example":1652079610000},"imaging_bytes_received":{"type":"integer","description":"Total number of bytes of audio data that have been received since the PCoIP session started.\t","format":"int64","example":1652079610000},"imaging_bytes_sent":{"type":"integer","description":"Total number of bytes of audio data that have been sent since the PCoIP session started.","format":"int64","example":3872079619320},"imaging_decoder_capability":{"type":"integer","description":"Estimated processing capability of the imaging decoder in kilobits per second. This statistic is updated once per second.","format":"int64","example":1652079610000},"imaging_encoded_frames":{"type":"integer","description":"Number of imaging frames that were encoded over a one-second sampling period..","format":"int64","example":1652079610000},"imaging_megapixel":{"type":"integer","description":"Number of megapixel that were rendered over a one-second sampling period.","format":"int64","example":1652079610000},"imaging_negative_acknowledgements":{"type":"integer","description":"Number of negative acknowledgements for incoming packets.","format":"int64","example":1652079610000},"imaging_rx_bandwidth":{"type":"integer","description":"Bandwidth for incoming audio packets averaged over the sampling period, in kilobits per second.","format":"int64","example":1652079610000},"imaging_svga_dev_tap_frames":{"type":"integer","description":"Number of frames that were processed in SVGA devtap over one-second sampling.","format":"int64","example":1652079610000},"imaging_tx_bandwidth":{"type":"integer","description":"Bandwidth for outgoing audio packets averaged over the sampling period, in kilobits per second.","format":"int64","example":1652079610000},"network_round_trip_latency":{"type":"integer","description":"Round trip latency in milliseconds between the PCoIP server and the PCoIP client.","format":"int64","example":1652079610000},"network_rx_bandwidth":{"type":"integer","description":"Overall bandwidth for incoming PCoIP packets averaged over the sampling period, in kilobits per second.","format":"int64","example":1652079610000},"network_rx_bandwidth_peak":{"type":"integer","description":"Peak bandwidth in kilobits per second for incoming PCoIP packets over a one-second sampling period.","format":"int64","example":1652079610000},"network_rx_packet_loss":{"type":"integer","description":"Percentage of incoming packets lost during a sampling period.","format":"int64","example":1652079610000},"network_tx_bandwidth":{"type":"integer","description":"Overall bandwidth for outgoing PCoIP packets averaged over the sampling period, in kilobits per second.","format":"int64","example":1652079610000},"network_tx_bandwidth_active_limit":{"type":"integer","description":"Estimated available network bandwidth in kilobits per second. This statistic is updated once per second.","format":"int64","example":1652079610000},"network_tx_bandwidth_limit":{"type":"integer","description":"Transmission bandwidth limit in kilobits per second for outgoing packets. The limit is the minimum of the following values.\n* GPO bandwidth limit for the PCoIP client.\n* GPO bandwidth limit for the PCoIP server.\n* Bandwidth limit for the local network connection.\n* Negotiated bandwidth limit for the Zero Client firmware based on encryption limits.","format":"int64","example":3872079619320},"network_tx_packet_loss":{"type":"integer","description":"Percentage of transmitted packets lost during a sampling period.","format":"int64","example":1652079610000},"usb_bytes_received":{"type":"integer","description":"Total number of bytes of USB data that have been received since the PCoIP session started.","format":"int64","example":1652079610000},"usb_bytes_sent":{"type":"integer","description":"Total number of bytes of USB data that have been sent since the PCoIP session started.","format":"int64","example":1652079610000},"usb_rx_bandwidth":{"type":"integer","description":"Bandwidth for incoming USB packets averaged over the sampling period, in kilobits per second.","format":"int64","example":1652079610000},"usb_tx_bandwidth":{"type":"integer","description":"Bandwidth for outgoing USB packets averaged over the sampling period, in kilobits per second.","format":"int64","example":1652079610000}},"description":"Information related to PCoIP Performance Data."},"PermissionCreateSpec":{"required":["ad_user_or_group_id","role_id"],"type":"object","properties":{"ad_user_or_group_id":{"type":"string","description":"The AD User or Group SID for this permission.","example":"S-1-5-21-1042673909-920613684-1833544874-512"},"federation_access_group_id":{"type":"string","description":"The federation access group ID for this permission.","example":"f4c5d06e-791c-4ef8-af6f-1b95955e24df"},"local_access_group_id":{"type":"string","description":"The local access group ID for this permission.","example":"b59b3791-88de-42ed-a61a-561b7fd267ab"},"role_id":{"type":"string","description":"Role ID for this permission.","example":"9b50589d-818f-40c2-9ced-161d0f1d67dd"}},"description":"Information about permission."},"PermissionInfo":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","description":"The AD User or Group SID for this permission.<br> Supported Filters : 'Equals'.","example":"S-1-5-21-1042673909-920613684-1833544874-512"},"federation_access_group_id":{"type":"string","description":"The federation access group ID for this permission.<br> Supported Filters : 'Equals'.","example":"f4c5d06e-791c-4ef8-af6f-1b95955e24df"},"id":{"type":"string","description":"Unique ID representing this permission.<br> Supported Filters : 'Equals'.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"local_access_group_id":{"type":"string","description":"The local access group ID for this permission.<br> Supported Filters : 'Equals'.","example":"b59b3791-88de-42ed-a61a-561b7fd267ab"},"role_id":{"type":"string","description":"Role ID for this permission.<br> Supported Filters : 'Equals'.","example":"9b50589d-818f-40c2-9ced-161d0f1d67dd"}},"description":"Information about permission.<br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.<br>See the field description to know the filter types it supports."},"PermissionInfoV2":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","description":"The AD User or Group SID for this permission.<br> Supported Filters : 'Equals'.","example":"S-1-5-21-1042673909-920613684-1833544874-512"},"display_name":{"type":"string","description":"Login name with domain of user or group having this permission.<br> Supported Filters : 'Equals' and 'Contains'.<br>\nThis property can be used for sorting.","example":"example.com\\\\testuser"},"federation_access_group_id":{"type":"string","description":"The federation access group ID for this permission.<br> Supported Filters : 'Equals'.","example":"f4c5d06e-791c-4ef8-af6f-1b95955e24df"},"group":{"type":"boolean","description":"Indicates if ad user or group having this permission represents a group.<br> Supported Filters : 'Equals'.<br>\nThis property can be used for sorting.","example":false},"id":{"type":"string","description":"Unique ID representing this permission.<br> Supported Filters : 'Equals'.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"local_access_group_id":{"type":"string","description":"The local access group ID for this permission.<br> Supported Filters : 'Equals'.","example":"b59b3791-88de-42ed-a61a-561b7fd267ab"},"role_id":{"type":"string","description":"Role ID for this permission.<br> Supported Filters : 'Equals'.","example":"9b50589d-818f-40c2-9ced-161d0f1d67dd"}},"description":"Information about permission.<br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.<br>See the field description to know the filter types it supports."},"PermissionInfoV3":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","description":"The AD User or Group SID for this permission.<br> Supported Filters : 'Equals'.","example":"S-1-5-21-1042673909-920613684-1833544874-512"},"display_name":{"type":"string","description":"Login name with domain of user or group having this permission.<br> Supported Filters : 'Equals' and 'Contains'.<br>\nThis property can be used for sorting.","example":"example.com\\\\testuser"},"federation_access_group_id":{"type":"string","description":"The federation access group ID for this permission.<br> Supported Filters : 'Equals'.","example":"f4c5d06e-791c-4ef8-af6f-1b95955e24df"},"federation_access_group_name":{"type":"string","description":"The federation access group name for this permission.<br> Supported Filters : 'Equals' and 'Contains'.<br>\nThis property can be used for sorting.","example":"FederationGroup_GlobalAdmins"},"group":{"type":"boolean","description":"Indicates if ad user or group having this permission represents a group.<br> Supported Filters : 'Equals'.<br>\nThis property can be used for sorting.","example":false},"id":{"type":"string","description":"Unique ID representing this permission.<br> Supported Filters : 'Equals'.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"local_access_group_id":{"type":"string","description":"The local access group ID for this permission.<br> Supported Filters : 'Equals'.","example":"b59b3791-88de-42ed-a61a-561b7fd267ab"},"local_access_group_name":{"type":"string","description":"The local access group name for this permission.<br> Supported Filters : 'Equals' and 'Contains'.<br>\nThis property can be used for sorting.","example":"AccessGroup_LocalAdmins"},"role_id":{"type":"string","description":"Role ID for this permission.<br> Supported Filters : 'Equals'.","example":"9b50589d-818f-40c2-9ced-161d0f1d67dd"},"role_name":{"type":"string","description":"Role name for this permission.<br> Supported Filters : 'Equals' and 'Contains'.<br>\nThis property can be used for sorting.","example":"Role_Admin"},"unauthenticated_access_user":{"type":"boolean","description":"Indicates if ad user having this permission is a unauthenticated access user.<br> Supported Filters : 'Equals'.<br>\nThis property can be used for sorting.","example":false}},"description":"Information about permission.<br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.<br>See the field description to know the filter types it supports."},"PersistentDiskCreateSpec":{"required":["access_group_id","datastore_id","vcenter_id","virtual_disk_id"],"type":"object","properties":{"access_group_id":{"type":"string","description":"ID of the access group to be associated with the persistent disk.","example":"73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d"},"datastore_id":{"type":"string","description":"ID of the datastore containing the virtual disk.","example":"datastore-33"},"user_id":{"type":"string","description":"SID of the user to own the persistent disk.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"vcenter_id":{"type":"string","description":"ID of the vCenter server containing the virtual disk.","example":"b32e941f-f272-4a4b-9d78-21b4602ed33f"},"virtual_disk_id":{"type":"string","description":"ID of the virtual disk from which the persistent disk is to be created.","example":"7c31387f-9d3b-45e7-9035-00b05769626f"}},"description":"Persistent disk object to be created."},"PersistentDiskInfo":{"type":"object","properties":{"access_group_id":{"type":"string","description":"ID of the access group of the persistent disk.<br>Supported Filters: 'Equals'.","example":"73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d"},"capacity_mb":{"type":"integer","description":"Capacity of the persistent disk in MB.\nThis property can be used for sorting.","format":"int64","example":2048},"datastore_id":{"type":"string","description":"ID of the datastore containing the persistent disk.<br>Supported Filters: 'Equals'.","example":"datastore-33"},"datastore_name":{"type":"string","description":"Name of the datastore containing the persistent disk.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"Datastore1"},"desktop_pool_id":{"type":"string","description":"ID of the desktop pool associated with the persistent disk.<br>Supported Filters: 'Equals'.","example":"ce910882-e6ef-447a-a88b-333abe0c9c8a"},"desktop_pool_name":{"type":"string","description":"Name of the desktop pool associated with the persistent disk.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"id":{"type":"string","description":"Unique identifier for this persistent disk.<br>Supported Filters: 'Equals'.","example":"c1d5aec7-2126-3c55-aefa-11949003c9c2"},"last_attached_time":{"type":"integer","description":"If the persistent disk is detached, indicates when it was last attached to a machine or created from a virtual disk.\nThis property can be used for sorting.","format":"int64","example":1621512686000},"machine_id":{"type":"string","description":"ID of the machine the persistent disk is attached to.<br>Supported Filters: 'Equals'.","example":"0f9f20be-4fa5-47dc-bcf2-f4fb555c51d2"},"machine_name":{"type":"string","description":"Name of the machine the persistent disk is attached to.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1"},"name":{"type":"string","description":"Name of the persistent disk.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"virtual-disk.vmdk"},"status":{"type":"string","description":"Status of the persistent disk.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* ARCHIVING: The persistent disk is being archived.\n* ATTACHING: The persistent disk is attaching to a virtual machine.\n* DELETING: The persistent disk is being deleted.\n* DETACHING: The persistent disk is being detached from a virtual machine.\n* IN_USE: This persistent disk is in use.\n* REPLACING: The persistent disk is being replaced.\n* UNATTACHED: The persistent disk is not in use and available to attach to a virtual machine.","example":"IN_USE","enum":["ARCHIVING","ATTACHING","DELETING","DETACHING","IN_USE","REPLACING","UNATTACHED"]},"usage":{"type":"string","description":"Usage of the persistent disk.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.\n* DELETING: This data disk is in the process of being deleted or archived.\n* PRIMARY: This data disk is attached to a Virtual Machine and the user profile is redirected to it.\n* SECONDARY: This data disk is attached to a Virtual Machine.\n* UNATTACHED: This data disk is not attached to a Virtual Machine.","example":"PRIMARY","enum":["DELETING","PRIMARY","SECONDARY","UNATTACHED"]},"user_id":{"type":"string","description":"SID of the user owning the persistent disk.<br>Supported Filters: 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"user_name":{"type":"string","description":"Name of the user owning the persistent disk.<br>Supported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"testuser"},"vcenter_id":{"type":"string","description":"ID of the vCenter server containing the persistent disk.<br>Supported Filters: 'Equals'.","example":"b32e941f-f272-4a4b-9d78-21b4602ed33f"}},"description":"Persistent disk information.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"PersistentDiskMachineAttachmentInfo":{"type":"object","properties":{"desktop_pool_id":{"type":"string","description":"ID of the desktop pool of the machine.<br>Supported Filters : 'Equals'.","example":"ce910882-e6ef-447a-a88b-333abe0c9c8a"},"desktop_pool_name":{"type":"string","description":"Name of the desktop pool.<br>Supported Filters : 'Equals', 'StartsWith', 'Contains'. \nThis property can be used for sorting.","example":"pool-1"},"incompatible_reason":{"type":"string","description":"Incompatible reason for attaching machine to persistent disk.\n* PERSISTENT_DISK_MACHINE_VC_MISMATCH: Virtual centers of persistent disk and machine do not match.\n* PERSISTENT_DISK_MACHINE_VSAN_MISMATCH: vSAN policies of persistent disk and machine do not match.\n* PERSISTENT_DISK_DATASTORE_INACCESSIBLE_TO_MACHINE: Datastore of persistent disk is inaccessible to machine.","enum":["PERSISTENT_DISK_MACHINE_VC_MISMATCH","PERSISTENT_DISK_MACHINE_VSAN_MISMATCH","PERSISTENT_DISK_DATASTORE_INACCESSIBLE_TO_MACHINE"]},"machine_id":{"type":"string","description":"ID of the machine which may be attached to persistent disk.<br>Supported Filters : 'Equals'.","example":"0f9f20be-4fa5-47dc-bcf2-f4fb555c51d2"},"machine_name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'Contains'. \nThis property can be used for sorting.","example":"machine-1"},"user_id":{"type":"string","description":"SID of the user the machine is assigned to.<br>Supported Filters : 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"user_name":{"type":"string","description":"Name of the user.<br>Supported Filters : 'Equals', 'StartsWith', 'Contains'. \nThis property can be used for sorting.","example":"user-1"}},"description":"Information about machine which can be attached to persistent disk. <br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith' and 'Contains'.<br>See the field description to know the filter types it supports."},"PersistentDiskUpdateSpec":{"required":["access_group_id","user_id"],"type":"object","properties":{"access_group_id":{"type":"string","description":"ID of the access group to be associated with the persistent disk.","example":"73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d"},"user_id":{"type":"string","description":"SID of the user to own the persistent disk.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"}},"description":"Persistent disk object to be updated."},"PhysicalMachineBulkRegisterResponseInfo":{"type":"object","properties":{"errors":{"type":"array","description":"List of error objects containing error key and error message.","items":{"$ref":"#/components/schemas/APIError"}},"id":{"type":"string","description":"Unique ID representing the physical machine.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"key":{"type":"string","description":"The key on which the operation was performed.","example":"physical-machine-key"},"pairing_token":{"type":"string","description":"The pairing token for the physical machine.","example":"<agent.pairing.token>"},"status_code":{"type":"integer","description":"The status code of the operation.","format":"int32","example":200},"timestamp":{"type":"integer","description":"Timestamp in milliseconds when the operation failed. Measured as epoch time.","format":"int64","example":1561939200000}},"description":"Information about physical machine register response."},"PhysicalMachineInfo":{"type":"object","properties":{"description":{"type":"string","description":"Description of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"This is a physical machine."},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'. \nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The machine operating system.\nSupported Filters : 'Equals'.<br>\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* DISABLED: The machine is disabled.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_UNREACHABLE","AVAILABLE","CONNECTED","DISABLED","DISCONNECTED","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART"]}},"description":"Information related to a Physical Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"PhysicalMachineInfoV2":{"type":"object","properties":{"description":{"type":"string","description":"Description of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"This is a physical machine."},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'. \nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The machine operating system.\nSupported Filters : 'Equals'.<br>\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"rds_server":{"type":"boolean","description":"Indicates if the physical machine is RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* DISABLED: The machine is disabled.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_UNREACHABLE","AVAILABLE","CONNECTED","DISABLED","DISCONNECTED","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART"]}},"description":"Information related to a Physical Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"PhysicalMachineInfoV3":{"type":"object","properties":{"description":{"type":"string","description":"Description of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"This is a physical machine."},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"max_session_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.\nThis property can be used for sorting.","format":"int32","example":123},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'. \nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The machine operating system.\nSupported Filters : 'Equals'.<br>\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"rds_server":{"type":"boolean","description":"Indicates if the physical machine is RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* DISABLED: The machine is disabled.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_UNREACHABLE","AVAILABLE","CONNECTED","DISABLED","DISCONNECTED","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART"]}},"description":"Information related to a Physical Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"PhysicalMachineInfoV4":{"type":"object","properties":{"description":{"type":"string","description":"Description of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"This is a physical machine."},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"max_session_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.\nThis property can be used for sorting.","format":"int32","example":123},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'. \nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The machine operating system.\nSupported Filters : 'Equals'.<br>\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"paired":{"type":"boolean","description":"Indicates if the physical machine is paired with the pod.\nSupported Filters: 'Equals'.\nSupports sorting.\n","example":true},"rds_server":{"type":"boolean","description":"Indicates if the physical machine is RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* DISABLED: The machine is disabled.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_UNREACHABLE","AVAILABLE","CONNECTED","DISABLED","DISCONNECTED","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART"]}},"description":"Information related to a Physical Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"PhysicalMachineInfoV5":{"type":"object","properties":{"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015"},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.","example":"7.12"},"description":{"type":"string","description":"Description of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"This is a physical machine."},"desktop_pool_name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.Supported Filters: 'Equals', 'StartsWith', 'EndsWith', 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"farm_name":{"type":"string","description":"Name of the Farm. The maximum length is 64 characters.Supported Filters: 'Equals', 'StartsWith', 'EndsWith', 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm1"},"farm_type":{"type":"string","description":"Type of the Farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"max_session_count":{"type":"integer","description":"Maximum number of sessions for RDS server. Supported Filters : 'Equals', Between.\nThis property can be used for sorting.","format":"int32","example":123},"max_session_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.\nThis property can be used for sorting.","format":"int32","example":123},"max_sessions_type":{"type":"string","description":"RDS Server max sessions type. \n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'. \nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The machine operating system.\nSupported Filters : 'Equals'.<br>\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"paired":{"type":"boolean","description":"Indicates if the physical machine is paired with the pod.\nSupported Filters: 'Equals'.\nSupports sorting.\n","example":true},"rds_server":{"type":"boolean","description":"Indicates if the physical machine is RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"session_count":{"type":"integer","description":"Active session count for the RDS server. \nThis property can be used for sorting.","format":"int32","example":123},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* DISABLED: The machine is disabled.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_UNREACHABLE","AVAILABLE","CONNECTED","DISABLED","DISCONNECTED","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART"]}},"description":"Information related to a Physical Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"PhysicalMachineInfoV6":{"type":"object","properties":{"access_group_id":{"type":"string","description":"The id of the Access Group that the Physical Machine belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015"},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.","example":"7.12"},"description":{"type":"string","description":"Description of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"This is a physical machine."},"desktop_pool_name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.Supported Filters: 'Equals', 'StartsWith', 'EndsWith', 'Contains'.\nThis property can be used for sorting.","example":"sales-pool1"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"farm_name":{"type":"string","description":"Name of the Farm. The maximum length is 64 characters.Supported Filters: 'Equals', 'StartsWith', 'EndsWith', 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm1"},"farm_type":{"type":"string","description":"Type of the Farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"max_session_count":{"type":"integer","description":"Maximum number of sessions for RDS server. Supported Filters : 'Equals', Between.\nThis property can be used for sorting.","format":"int32","example":123},"max_session_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.\nThis property can be used for sorting.","format":"int32","example":123},"max_sessions_type":{"type":"string","description":"RDS Server max sessions type. \n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'. \nThis property can be used for sorting.","example":"machine1"},"operating_system":{"type":"string","description":"The machine operating system.\nSupported Filters : 'Equals'.<br>\nThis property can be used for sorting.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_SERVER_2016","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"paired":{"type":"boolean","description":"Indicates if the physical machine is paired with the pod.\nSupported Filters: 'Equals'.\nSupports sorting.\n","example":true},"rds_server":{"type":"boolean","description":"Indicates if the physical machine is RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"session_count":{"type":"integer","description":"Active session count for the RDS server. \nThis property can be used for sorting.","format":"int32","example":123},"state":{"type":"string","description":"The state of the machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AGENT_ERROR_DISABLED: Horizon Agent is disabled.\n* AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.\n* AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.\n* AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.\n* AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\n* DISABLED: The machine is disabled.\n* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.\n* UNKNOWN: Could not determine the state of the machine.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.\n* AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_UNREACHABLE","AVAILABLE","CONNECTED","DISABLED","DISCONNECTED","UNASSIGNED_USER_CONNECTED","UNASSIGNED_USER_DISCONNECTED","UNKNOWN","VALIDATING","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART"]}},"description":"Information related to a Physical Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"PhysicalMachineRegisterInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID representing the physical machine.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"pairing_token":{"type":"string","description":"The pairing token for the physical machine.","example":"<agent.pairing.token>"}},"description":"Physical machine register response."},"PhysicalMachineRegisterSpec":{"required":["dns_name","operating_system"],"type":"object","properties":{"description":{"type":"string","description":"An optional string to describe how and why this physical machine was registered.","example":"Newly added physical machine"},"dns_name":{"maxLength":256,"minLength":1,"type":"string","description":"The DNS name for the physical machine.","example":"machine1.example.com"},"operating_system":{"type":"string","description":"The Operating System of the physical machine.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_10","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]}},"description":"The specification for registering the physical machine."},"PhysicalMachineRegisterSpecV2":{"required":["dns_name","operating_system"],"type":"object","properties":{"computer_sid":{"type":"string","description":"The AD computer SID of the machine.\nThis is required when method is set to COMPUTER_SID.","example":"domain\\computer-name"},"description":{"type":"string","description":"An optional string to describe how and why this physical machine was registered.","example":"Newly added physical machine"},"dns_name":{"maxLength":256,"minLength":1,"type":"string","description":"The DNS name for the physical machine.","example":"machine1.example.com"},"method":{"type":"string","description":"The method used to register the physical machine.\nDefault value is MANUAL.\n* COMPUTER_SID: The physical machine is registered using the AD computer SID.\n* MANUAL: The physical machine is registered using the DNS name.","example":"MANUAL","enum":["COMPUTER_SID","MANUAL"]},"operating_system":{"type":"string","description":"The Operating System of the physical machine.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_10","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]}},"description":"Information required to register a physical machine."},"PhysicalMachineUpdateSpec":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled","example":true},"max_session_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]}},"description":"The specification for updating the physical machine"},"PodAssignmentInfo":{"type":"object","properties":{"global_application_entitlement_id":{"type":"string","description":"ID of the Global Application Entitlement associated with this pod assignment.<br>Supported Filters: 'Equals'.","example":"e285ebe1-194b-4563-80e0-0ad21134c503"},"global_desktop_entitlement_id":{"type":"string","description":"ID of the Global Desktop Entitlement associated with this pod assignment.<br>Supported Filters: 'Equals'.","example":"7493bfc7-834a-4d9b-ac7d-b5f60893a3a6"},"id":{"type":"string","description":"Unique ID representing this pod assignment.<br>Supported Filters: 'Equals'.","example":"28deeb70-97d5-409e-abb4-497196f1ee18"},"pod_id":{"type":"string","description":"ID representing the pod associated with this pod assignment.<br>Supported Filters: 'Equals'.","example":"32a5ea06-cd09-4609-b3e5-df8379e99c13"},"user_id":{"type":"string","description":"SID of the user associated with this pod assignment.<br>Supported Filters: 'Equals'.","example":"S-1-1-1-3965912346-1012345398-3123456564-123"}},"description":"Information related to pod assignments in a pod federation.<br>Only one of global Desktop Entitlement ID and global Application Entitlement ID will be set.<br>Supported Filters : 'And', 'Or' and 'Equals'.<br>See the field description to know the filter types it supports."},"PodEndPointData":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether an endpoint is enabled. A disabled endpoint will be excluded from participating inter-pod communication.","example":true},"id":{"type":"string","description":"Unique ID for a pod endpoint.","example":"c5337d77-2bf1-4fa4-b027-c301114f2d1e"},"name":{"type":"string","description":"Name for the pod endpoint.","example":"connection-server1.example.com"},"roundtrip_time":{"type":"integer","description":"Round trip time (in milliseconds) for ping request between the local pod endpoint and the remote pod.","format":"int64","example":1234},"status":{"type":"string","description":"Status of the pod endpoint.\n* ONLINE: Pod endpoint is online and functional.\n* UNCHECKED: Pod endpoint was offline and it just came back online but the system has not verified that it is functional.\n* OFFLINE: Pod endpoint is offline or unreachable.","example":"ONLINE","enum":["ONLINE","UNCHECKED","OFFLINE"]},"url":{"type":"string","description":"The URL for the pod endpoint. This address and special port will be used for inter-pod communication.","example":"https://connection-server1.example.com:8742"}},"description":"The list of pod endpoints within this pod. An endpoint is basically a connection server in that pod."},"PodEndPointDataV2":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether an endpoint is enabled. A disabled endpoint will be excluded from participating inter-pod communication.","example":true},"id":{"type":"string","description":"Unique ID for a pod endpoint.","example":"c5337d77-2bf1-4fa4-b027-c301114f2d1e"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Name for the pod endpoint.","example":"connection-server1.example.com"},"roundtrip_time":{"type":"integer","description":"Round trip time (in milliseconds) for ping request between the local pod endpoint and the remote pod.","format":"int64","example":1234},"status":{"type":"string","description":"Status of the pod endpoint.\n* ONLINE: Pod endpoint is online and functional.\n* UNCHECKED: Pod endpoint was offline and it just came back online but the system has not verified that it is functional.\n* OFFLINE: Pod endpoint is offline or unreachable.","example":"ONLINE","enum":["ONLINE","UNCHECKED","OFFLINE"]},"url":{"type":"string","description":"The URL for the pod endpoint. This address and special port will be used for inter-pod communication.","example":"https://connection-server1.example.com:8742"}},"description":"The list of pod endpoints within this pod. An endpoint is basically a connection server in that pod."},"PodEndpointInfo":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether an endpoint is enabled. A disabled endpoint is excluded from participating in inter-pod communication.","example":true},"id":{"type":"string","description":"Unique ID representing this pod endpoint.","example":"48dreb70-97g6-405e-abb5-497136g2ee35"},"name":{"type":"string","description":"Name of the pod endpoint.","example":"Horizon Connection Server"},"server_address":{"type":"string","description":"The URL for the pod endpoint. This address and port is used for inter-pod communication.","example":"https://horizon-CS.xyz.local:8472"}},"description":"Information related to pod endpoint."},"PodFederationInfo":{"type":"object","properties":{"connection_server_statuses":{"type":"array","description":"Individual connection server CPA status for this pod.","items":{"$ref":"#/components/schemas/ConnectionServerStatus"}},"guid":{"type":"string","description":"GUID representing the pod federation.","example":"97b8c51e-2e30-47f8-8c3c-3b2d3ec1a2a7"},"local_connection_server_status":{"type":"string","description":"CPA status of the current connection server in the pod.\n* ENABLED: CPA is enabled.\n* DISABLED: CPA is disabled.\n* PENDING: CPA is undergoing an operation related to initialization, uninitialization, joining, or unjoining.\n* ENABLE_ERROR: The connection server has failed to reach the ENABLED status in a timely manner. This may also indicate the current connection server was recently installed.\n* DISABLE_ERROR: The connection server has failed to reach the DISABLED status in a timely manner.","example":"ENABLED","enum":["ENABLED","DISABLED","PENDING","ENABLE_ERROR","DISABLE_ERROR"]},"name":{"type":"string","description":"Name of the pod federation.","example":"Horizon Cloud Pod Federation"},"sites":{"type":"array","description":"Member sites in the pod federation.","example":["c617fd51-e118-4cae-970c-54a7144aaadc","bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"],"items":{"type":"string","description":"Member sites in the pod federation.","example":"[\"c617fd51-e118-4cae-970c-54a7144aaadc\",\"bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c\"]"}}},"description":"Information related to Pod Federation."},"PodFederationInfoV2":{"type":"object","properties":{"connection_server_statuses":{"type":"array","description":"Individual connection server CPA status for this pod.","items":{"$ref":"#/components/schemas/ConnectionServerStatus"}},"guid":{"type":"string","description":"GUID representing the pod federation.","example":"97b8c51e-2e30-47f8-8c3c-3b2d3ec1a2a7"},"local_connection_server_status":{"type":"string","description":"CPA status of the current connection server in the pod.\n* ENABLED: CPA is enabled.\n* DISABLED: CPA is disabled.\n* PENDING: CPA is undergoing an operation related to initialization, uninitialization, joining, or unjoining.\n* ENABLE_ERROR: The connection server has failed to reach the ENABLED status in a timely manner. This may also indicate the current connection server was recently installed.\n* DISABLE_ERROR: The connection server has failed to reach the DISABLED status in a timely manner.","example":"ENABLED","enum":["ENABLED","DISABLED","PENDING","ENABLE_ERROR","DISABLE_ERROR"]},"name":{"type":"string","description":"Name of the pod federation.","example":"Horizon Cloud Pod Federation"},"site_redirection_settings":{"$ref":"#/components/schemas/SiteRedirectionSettings"},"sites":{"type":"array","description":"Member sites in the pod federation.","example":["c617fd51-e118-4cae-970c-54a7144aaadc","bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"],"items":{"type":"string","description":"Member sites in the pod federation.","example":"[\"c617fd51-e118-4cae-970c-54a7144aaadc\",\"bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c\"]"}}},"description":"Information related to Pod Federation."},"PodInfo":{"type":"object","properties":{"active_global_application_entitlements":{"type":"array","description":"List of Global Application Entitlements with mappings to application pools within this pod.","example":["01c42e80-d31e-4633-93c6-44ff8a5b1afe","86ba95e0-9d59-4b1f-934e-2deba13fcecb"],"items":{"type":"string","description":"List of Global Application Entitlements with mappings to application pools within this pod.","example":"[\"01c42e80-d31e-4633-93c6-44ff8a5b1afe\",\"86ba95e0-9d59-4b1f-934e-2deba13fcecb\"]"}},"active_global_desktop_entitlements":{"type":"array","description":"List of Global Desktop Entitlements with mappings to desktop pools within this pod.","example":["648d8fc5-94e5-438f-8524-8edb533c7de2","50075a5b-6a68-4be5-b079-cff355945856"],"items":{"type":"string","description":"List of Global Desktop Entitlements with mappings to desktop pools within this pod.","example":"[\"648d8fc5-94e5-438f-8524-8edb533c7de2\",\"50075a5b-6a68-4be5-b079-cff355945856\"]"}},"cloud_managed":{"type":"boolean","description":"Indicates whether this pod is managed from cloud.","example":true},"description":{"type":"string","description":"Description of this pod.","example":"Pod Description."},"endpoints":{"type":"array","description":"List of endpoints within this pod.","example":["716269b7-e43d-4874-877a-c5af36a11322","d56671b5-42a6-490e-ab40-8373f839f2d3"],"items":{"type":"string","description":"List of endpoints within this pod.","example":"[\"716269b7-e43d-4874-877a-c5af36a11322\",\"d56671b5-42a6-490e-ab40-8373f839f2d3\"]"}},"id":{"type":"string","description":"Unique ID representing this pod.","example":"28deeb70-97d5-409e-abb4-497196f1ee18"},"local_pod":{"type":"boolean","description":"Indicates whether this is the local pod the request was made from.<br>Only one pod in the pod federation will return true.","example":true},"name":{"type":"string","description":"Name of this pod.","example":"Cluster-CS-1"},"site_id":{"type":"string","description":"ID of the site this pod belongs to.","example":"9a892821-8c3d-4e61-9d65-69dfec7b70dc"}},"description":"Information related to pods in a pod federation."},"PodMonitorInfo":{"type":"object","properties":{"endpoints":{"type":"array","description":"The list of pod endpoints within this pod. An endpoint is basically a connection server in that pod.","items":{"$ref":"#/components/schemas/PodEndPointData"}},"id":{"type":"string","description":"Unique ID of the pod.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"name":{"type":"string","description":"Display name for the pod.","example":"Cluster-SITE1-POD1"},"site_id":{"type":"string","description":"The Id of the site this pod belongs to.","example":"a5882e23-3bf4-1ba6-c128-e780004f2d1e"}},"description":"Monitoring information related to a pod."},"PodMonitorInfoV2":{"type":"object","properties":{"endpoints":{"type":"array","description":"The list of pod endpoints within this pod. An endpoint is basically a connection server in that pod.","items":{"$ref":"#/components/schemas/PodEndPointDataV2"}},"id":{"type":"string","description":"Unique ID of the pod.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"name":{"type":"string","description":"Display name for the pod.","example":"Cluster-SITE1-POD1"},"site_id":{"type":"string","description":"The Id of the site this pod belongs to.","example":"a5882e23-3bf4-1ba6-c128-e780004f2d1e"}},"description":"Monitoring information related to a pod."},"PodSessionMetricsInfo":{"type":"object","properties":{"local_pod":{"type":"boolean","description":"Indicates if the counter details belong to the local POD.\nThis is going to be true for only one POD in the Federation.","example":true},"num_brokered_sessions":{"type":"integer","description":"Total number of brokered global sessions.\n* This value will not be set for pods running on an older version(before 7.12.0).","format":"int32","example":6},"num_hosted_sessions":{"type":"integer","description":"Total number of hosted global sessions.\n* This value will not be set if there is atleast one pod in federation which is running on an older version(before 7.12.0).","format":"int32","example":4},"pod_id":{"type":"string","description":"Pod id.","example":"fd69e42f-9812-4bf2-b000-84e92882616d"},"pod_name":{"type":"string","description":"Name of the pod.","example":"test_pod"}},"description":"Metrics related to Pod Session.\n This considers the sessions launched using Desktop or Application that are part of Global Entitlement and Global Application Entitlement."},"PodUpdateSpec":{"required":["name","site_id"],"type":"object","properties":{"cloud_managed":{"type":"boolean","description":"Indicates whether this pod is managed from cloud. Default value is false.","example":true},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of this pod.","example":"Pod Description."},"name":{"maxLength":64,"minLength":1,"type":"string","description":"Name of this pod.","example":"Cluster-CS-1"},"site_id":{"type":"string","description":"ID of the site this pod belongs to.","example":"9a892821-8c3d-4e61-9d65-69dfec7b70dc"}},"description":"Pod object to be updated."},"PoliciesSettings":{"type":"object","properties":{"allow_multimedia_redirection":{"type":"string","description":"Determines whether MMR (Multimedia Redirection, a Microsoft DirectShow filter) is enabled for client systems. Default value is DENY.\n* ALLOW: This policy option is set to allow.\n* DENY: This policy option is set to deny.\n* INHERIT: This policy option will be inherited from the parent.","example":"ALLOW","enum":["ALLOW","DENY","INHERIT"]},"allow_pcoip_hardware_acceleration":{"type":"string","description":"Determines whether to enable hardware acceleration of the PCoIP display protocol. Default value is ALLOW. If the property is set, pcoip_hardware_acceleration_priority must be set. This setting has an effect only if a PCoIP hardware acceleration device is present on the physical computer that hosts the machine.\n* ALLOW: This policy option is set to allow.\n* DENY: This policy option is set to deny.\n* INHERIT: This policy option will be inherited from the parent.","example":"ALLOW","enum":["ALLOW","DENY","INHERIT"]},"allow_remote_mode":{"type":"string","description":"Determines whether users can connect to and use machines running on vCenter Server instances. If set to deny, machines must be used in local mode.\n* ALLOW: This policy option is set to allow.\n* DENY: This policy option is set to deny.\n* INHERIT: This policy option will be inherited from the parent.","example":"ALLOW","enum":["ALLOW","DENY","INHERIT"]},"allow_usb_access":{"type":"string","description":"Determines whether machines can use USB devices connected to the client system. Default value is ALLOW.\n* ALLOW: This policy option is set to allow.\n* DENY: This policy option is set to deny.\n* INHERIT: This policy option will be inherited from the parent.","example":"ALLOW","enum":["ALLOW","DENY","INHERIT"]},"pcoip_hardware_acceleration_priority":{"type":"string","description":"Determines priority for hardware acceleration. This property is ignored, if allow_pcoip_hardware_acceleration is not set to ALLOW. Default value is MEDIUM priority.\n* LOWEST: PCOIP Hardware acceleration priority is lowest possible.\n* LOWER: PCOIP Hardware acceleration priority is lower.\n* MEDIUM: PCOIP Hardware acceleration priority is medium. Default.\n* HIGHER: PCOIP Hardware acceleration priority is higher.\n* HIGHEST: PCOIP Hardware acceleration priority is highest.","example":"MEDIUM","enum":["LOWEST","LOWER","MEDIUM","HIGHER","HIGHEST"]}},"description":"Information related to Policies settings."},"PoliciesSettingsUpdateSpec":{"required":["allow_multimedia_redirection","allow_pcoip_hardware_acceleration","allow_remote_mode","allow_usb_access"],"type":"object","properties":{"allow_multimedia_redirection":{"type":"string","description":"Determines whether MMR (Multimedia Redirection, a Microsoft DirectShow filter) is enabled for client systems.\n* ALLOW: This policy option is set to allow.\n* DENY: This policy option is set to deny.\n* INHERIT: This policy option will be inherited from the parent.","example":"ALLOW","enum":["ALLOW","DENY","INHERIT"]},"allow_pcoip_hardware_acceleration":{"type":"string","description":"Determines whether to enable hardware acceleration of the PCoIP display protocol. Default value is ALLOW. If the property is set, pcoip_hardware_acceleration_priority must be set. This setting has an effect only if a PCoIP hardware acceleration device is present on the physical computer that hosts the machine.\n* ALLOW: This policy option is set to allow.\n* DENY: This policy option is set to deny.\n* INHERIT: This policy option will be inherited from the parent.","example":"ALLOW","enum":["ALLOW","DENY","INHERIT"]},"allow_remote_mode":{"type":"string","description":"Determines whether users can connect to and use machines running on vCenter Server instances. If set to deny, machines must be used in local mode.\n* ALLOW: This policy option is set to allow.\n* DENY: This policy option is set to deny.\n* INHERIT: This policy option will be inherited from the parent.","example":"ALLOW","enum":["ALLOW","DENY","INHERIT"]},"allow_usb_access":{"type":"string","description":"Determines whether machines can use USB devices connected to the client system.\n* ALLOW: This policy option is set to allow.\n* DENY: This policy option is set to deny.\n* INHERIT: This policy option will be inherited from the parent.","example":"ALLOW","enum":["ALLOW","DENY","INHERIT"]},"pcoip_hardware_acceleration_priority":{"type":"string","description":"Determines priority for hardware acceleration. This property is ignored, if allow_pcoip_hardware_acceleration is not set to ALLOW. Default value is MEDIUM priority.\n* LOWEST: PCOIP Hardware acceleration priority is lowest possible.\n* LOWER: PCOIP Hardware acceleration priority is lower.\n* MEDIUM: PCOIP Hardware acceleration priority is medium. Default.\n* HIGHER: PCOIP Hardware acceleration priority is higher.\n* HIGHEST: PCOIP Hardware acceleration priority is highest.","example":"MEDIUM","enum":["LOWEST","LOWER","MEDIUM","HIGHER","HIGHEST"]}},"description":"Policies Settings to be updated."},"PowerSchedule":{"type":"object","properties":{"days_of_the_week":{"type":"array","description":"Days of the week","example":["MONDAY","TUESDAY"],"items":{"type":"string","description":"Days of the week","example":"[\"MONDAY\",\"TUESDAY\"]"}},"name":{"type":"string","description":"Name of the schedule","example":"weekday"},"resume_time":{"type":"string","description":"Machine resume time, This property must contain the time in 24 hours format.","example":"09:30"},"suspend_time":{"type":"string","description":"Machine suspend time, This property must contain the time in 24 hours format.","example":"17:30"},"timezone":{"type":"string","description":"Timezone of the schedule","example":"Asia/Kolkata"}},"description":"Indicates the power schedules for the machines"},"PreLogonSettingsInfo":{"type":"object","properties":{"api_session_timeout_minutes":{"type":"integer","description":"Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.\n","format":"int32","example":30},"console_session_timeout_minutes":{"type":"integer","description":"Determines how long an idle admin console session continues before the session times out.","format":"int32","example":30},"display_pre_login_admin_banner":{"type":"boolean","description":"Enable/disable pre login message pop up before logging into Horizon admin console","example":false},"enable_user_name_caching":{"type":"boolean","description":"UI Client provide 'remember me' option when this is set to true","example":true},"pre_login_admin_banner_header":{"type":"string","description":"The warning pop up header to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"Attention"},"pre_login_admin_banner_message":{"type":"string","description":"The warning pop up message to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.","example":"Attention"}},"description":"Information related to Pre Logon Settings."},"PreparedCountMetrics":{"type":"object","properties":{"available":{"type":"integer","description":"Number of RDS server machines which are in AVAILABLE status ","format":"int32","example":1},"connected":{"type":"integer","description":"Number of RDS server machines which are in CONNECTED status ","format":"int32","example":1},"disconnected":{"type":"integer","description":"Number of RDS server machines which are in DISCONNECTED status ","format":"int32","example":1},"provisioned":{"type":"integer","description":"Number of RDS server machines which are in PROVISIONED status ","format":"int32","example":1}},"description":"Counts of the RDS server machines which are in prepared state. "},"PrivilegeInfo":{"type":"object","properties":{"name":{"type":"string","description":"Name of the privilege.\n* ADMINISTRATOR: Full administrator privilege, including Multi-Datacenter View configuration. This is a non-selectable privilege.\n* ADMINISTRATOR_VIEW: Full read only administrator privilege, including Multi-Datacenter View configuration. This is a non-selectable privilege.\n* VC_CONFIG_VIEW: Manage vCenter Configuration (Read Only).\n* LOG_COLLECTION: Collect Operation Logs.\n* FORENSICS: Manage Forensics Operations.\n* MANAGE_CERTIFICATES: Manage Certificates.\n* LCM_MANAGEMENT: Manage Server Life Cycle Management Operations.\n* LCM_VIEW: Manage Server Life Cycle Management Operations (Read Only).\n* LOCAL_ADMINISTRATOR: Full administrator privilege, except to Multi-Datacenter View configuration and to manage roles and privileges. This is a non-selectable privilege.\n* LOCAL_ADMINISTRATOR_VIEW: Full read only administrator privilege, except to Multi-Datacenter View configuration. This is a non-selectable privilege.\n* INVENTORY_ADMINISTRATOR: Access to all inventory objects. This is a non-selectable privilege.\n* INVENTORY_ADMINISTRATOR_VIEW: Read only access to all inventory objects. This is a non-selectable privilege.\n* HELPDESK_ADMINISTRATOR: Manage Help Desk. This is a non-selectable privilege.\n* HELPDESK_ADMINISTRATOR_VIEW: Manage Help Desk (Read only).\n* FEDERATED_LDAP_MANAGE: Manage Pod Federation. \n* FEDERATED_LDAP_VIEW: Manage Global LDAP (Read only). This is a non-selectable privilege.\n* FEDERATED_SESSIONS_MANAGE: Manage Federated Sessions.\n* FEDERATED_SESSIONS_VIEW: Manage Federated Sessions (Read only). This is a non-selectable privilege.\n* GLOBAL_ADMINISTRATOR: Manage Global Configuration. This is a non-selectable privilege.\n* GLOBAL_ADMINISTRATOR_VIEW: Manage Global Configuration (Read only). This is a non-selectable privilege.\n* GLOBAL_ADMIN_UI_INTERACTIVE: Can log into View Administrator. This is a non-selectable privilege.\n* GLOBAL_ADMIN_SDK_INTERACTIVE: Can run all command line utilities and PowerShell commands. This is a non-selectable privilege.\n* GLOBAL_MACHINE_REGISTER: Register non-vCenter machine sources such as Windows Terminal Servers and physical PCs.\n* GLOBAL_ROLE_PERMISSION_MANAGEMENT: Add, modify, and delete administrator roles and permissions.\n* GLOBAL_ROLE_MANAGEMENT: Add, modify, and delete administrator roles. This is a non-selectable privilege.\n* GLOBAL_ROLE_VIEW: Read only access to administrator roles. This is a non-selectable privilege.\n* GLOBAL_PERMISSION_VIEW: Read only access to administrator permissions. This is a non-selectable privilege.\n* GLOBAL_PERMISSION_MANAGEMENT: Add, modify, and delete administrator permissions. This is a non-selectable privilege.\n* GLOBAL_CONFIG_VIEW: Read only access to global (non-inventory) policy, configuration, and RDS server settings, except administrator roles and permissions and global (Multi-Datacenter View) LDAP. This is a non-selectable privilege.\n* GLOBAL_CONFIG_MANAGEMENT: View and change global (non-inventory) policy, configuration, and RDS server settings, except for administrator roles and permissions.\n* FOLDER_MANAGEMENT: Add, modify, and delete access groups.\n* FOLDER_VIEW: Read only access to access groups. This is a non-selectable privilege.\n* POOL_VIEW: Read only access to desktop pools, farms, applications, their local sessions, and their machines. This is a non-selectable privilege.\n* POOL_MANAGEMENT: Add, modify, and delete desktop pools, applications and farms. Add and remove machines from desktop pools.\n* POOL_ENABLE: Enable and disable desktop pools, farms, and applications.\n* POOL_ENTITLE: Add and remove desktop pool and application entitlements.\n* POOL_SVI_IMAGE_MANAGEMENT: Schedule push image, schedule maintenance and change default image for desktop pool and farm.\n* MACHINE_VIEW: Read only access to machines and their local sessions. This is a non-selectable privilege.\n* MACHINE_MANAGEMENT: Perform all machine and session-related commands.\n* MACHINE_REBOOT: Reset local machines.\n* MACHINE_SHUTDOWN: Shutdown local machines.\n* MACHINE_MANAGE_VDI_SESSION: Disconnect, logoff, and send messages to local sessions.\n* MACHINE_MANAGE_OFFLINE_SESSION: Roll back offline sessions and initiate replications.\n* MACHINE_USER_MANAGEMENT: Assign and un-assign users for machines, Update machine aliases for machines.\n* MACHINE_MAINTENANCE: Put machine in and out of maintenance mode.\n* MANAGE_REMOTE_PROCESS: Manage Remote Processes and Applications.\n* REMOTE_ASSISTANCE: Remote Assistance to Remote desktop pool.\n* GLOBAL_CVP_REGISTER: Global CVP Register. This is a non-selectable privilege.\n* GLOBAL_CVP_PUBLICATION: Global CVP Publication. This is a non-selectable privilege.\n* CVP_INTERACTIVE: CVP Interactive. This is a non-selectable privilege.\n* CVP_VIEW: CVP View. This is a non-selectable privilege.\n* CVP_MANAGEMENT: CVP Management.This is a non-selectable privilege.\n* CVP_OWNERSHIP: CVP Ownership.This is a non-selectable privilege.\n* API_SMART_CARD_BYPASS: Allows API's credential based login when smart card authentication mode is REQUIRED.\n* UDD_VIEW: Read only access to persistent disks. This is a non-selectable privilege.\n* UDD_MANAGEMENT: Manage persistent disks.\n* HORIZON_CLOUD_SERVICE: Allows subscription license activation and cloud monitoring through horizon cloud service.\n* SUBSCRIPTION_LICENSE_ADD: Allows subscription license activation.\n* CLOUD_ADMIN: Allows Cloud Admin Authentication.\n* CLOUD_ON_BOARDING_MANAGEMENT: Allows Cloud on-boarding.\n* CLOUD_OPS_MANAGEMENT: Allows Cloud operations post on-boarding.\n* CAPACITY_PROVIDER_CONFIG_VIEW: Manage Capacity Provider Configuration (Read Only).\n* CAPACITY_PROVIDER_CONFIG_MANAGEMENT: Manage Capacity Provider Configuration.\n* MANAGE_EXTERNAL_KEYS: Manage External Keys.\n* UNKNOWN_PRIVILEGE: Unknown Privilege type. This is a non-selectable privilege.","example":"FEDERATED_LDAP_MANAGE","enum":["ADMINISTRATOR","ADMINISTRATOR_VIEW","VC_CONFIG_VIEW","LOG_COLLECTION","FORENSICS","MANAGE_CERTIFICATES","LCM_MANAGEMENT","LCM_VIEW","LOCAL_ADMINISTRATOR","LOCAL_ADMINISTRATOR_VIEW","INVENTORY_ADMINISTRATOR","INVENTORY_ADMINISTRATOR_VIEW","HELPDESK_ADMINISTRATOR","HELPDESK_ADMINISTRATOR_VIEW","FEDERATED_LDAP_MANAGE","FEDERATED_LDAP_VIEW","FEDERATED_SESSIONS_MANAGE","FEDERATED_SESSIONS_VIEW","GLOBAL_ADMINISTRATOR","GLOBAL_ADMINISTRATOR_VIEW","GLOBAL_ADMIN_UI_INTERACTIVE","GLOBAL_ADMIN_SDK_INTERACTIVE","GLOBAL_MACHINE_REGISTER","GLOBAL_ROLE_PERMISSION_MANAGEMENT","GLOBAL_ROLE_MANAGEMENT","GLOBAL_ROLE_VIEW","GLOBAL_PERMISSION_VIEW","GLOBAL_PERMISSION_MANAGEMENT","GLOBAL_CONFIG_VIEW","GLOBAL_CONFIG_MANAGEMENT","FOLDER_MANAGEMENT","FOLDER_VIEW","POOL_VIEW","POOL_MANAGEMENT","POOL_ENABLE","POOL_ENTITLE","POOL_SVI_IMAGE_MANAGEMENT","MACHINE_VIEW","MACHINE_MANAGEMENT","MACHINE_REBOOT","MACHINE_SHUTDOWN","MACHINE_MANAGE_VDI_SESSION","MACHINE_MANAGE_OFFLINE_SESSION","MACHINE_USER_MANAGEMENT","MACHINE_MAINTENANCE","MANAGE_REMOTE_PROCESS","REMOTE_ASSISTANCE","GLOBAL_CVP_REGISTER","GLOBAL_CVP_PUBLICATION","CVP_INTERACTIVE","CVP_VIEW","CVP_MANAGEMENT","CVP_OWNERSHIP","API_SMART_CARD_BYPASS","UDD_VIEW","UDD_MANAGEMENT","HORIZON_CLOUD_SERVICE","SUBSCRIPTION_LICENSE_ADD","CLOUD_ADMIN","CLOUD_ON_BOARDING_MANAGEMENT","CLOUD_OPS_MANAGEMENT","CAPACITY_PROVIDER_CONFIG_VIEW","CAPACITY_PROVIDER_CONFIG_MANAGEMENT","MANAGE_EXTERNAL_KEYS","UNKNOWN_PRIVILEGE"]},"sub_privileges":{"type":"array","description":"List of sub-privileges.","example":["FEDERATED_LDAP_VIEW","POOL_VIEW","MACHINE_VIEW"],"items":{"type":"string","description":"* ADMINISTRATOR_VIEW: Full read only administrator privilege, including Multi-Datacenter View configuration. This is a non-selectable privilege.\n* VC_CONFIG_VIEW: Manage vCenter Configuration (Read Only).\n* LOG_COLLECTION: Collect Operation Logs.\n* FORENSICS: Manage Forensics Operations.\n* MANAGE_CERTIFICATES: Manage Certificates.\n* LCM_MANAGEMENT: Manage Server Life Cycle Management Operations.\n* LCM_VIEW: Manage Server Life Cycle Management Operations (Read Only).\n* LOCAL_ADMINISTRATOR: Full administrator privilege, except to Multi-Datacenter View configuration and to manage roles and privileges. This is a non-selectable privilege.\n* LOCAL_ADMINISTRATOR_VIEW: Full read only administrator privilege, except to Multi-Datacenter View configuration. This is a non-selectable privilege.\n* INVENTORY_ADMINISTRATOR: Access to all inventory objects. This is a non-selectable privilege.\n* INVENTORY_ADMINISTRATOR_VIEW: Read only access to all inventory objects. This is a non-selectable privilege.\n* HELPDESK_ADMINISTRATOR: Manage Help Desk. This is a non-selectable privilege.\n* HELPDESK_ADMINISTRATOR_VIEW: Manage Help Desk (Read only).\n* FEDERATED_LDAP_MANAGE: Manage Pod Federation. \n* FEDERATED_LDAP_VIEW: Manage Global LDAP (Read only). This is a non-selectable privilege.\n* FEDERATED_SESSIONS_MANAGE: Manage Federated Sessions.\n* FEDERATED_SESSIONS_VIEW: Manage Federated Sessions (Read only). This is a non-selectable privilege.\n* GLOBAL_ADMINISTRATOR: Manage Global Configuration. This is a non-selectable privilege.\n* GLOBAL_ADMINISTRATOR_VIEW: Manage Global Configuration (Read only). This is a non-selectable privilege.\n* GLOBAL_ADMIN_UI_INTERACTIVE: Can log into View Administrator. This is a non-selectable privilege.\n* GLOBAL_ADMIN_SDK_INTERACTIVE: Can run all command line utilities and PowerShell commands. This is a non-selectable privilege.\n* GLOBAL_MACHINE_REGISTER: Register non-vCenter machine sources such as Windows Terminal Servers and physical PCs.\n* GLOBAL_ROLE_PERMISSION_MANAGEMENT: Add, modify, and delete administrator roles and permissions.\n* GLOBAL_ROLE_MANAGEMENT: Add, modify, and delete administrator roles. This is a non-selectable privilege.\n* GLOBAL_ROLE_VIEW: Read only access to administrator roles. This is a non-selectable privilege.\n* GLOBAL_PERMISSION_VIEW: Read only access to administrator permissions. This is a non-selectable privilege.\n* GLOBAL_PERMISSION_MANAGEMENT: Add, modify, and delete administrator permissions. This is a non-selectable privilege.\n* GLOBAL_CONFIG_VIEW: Read only access to global (non-inventory) policy, configuration, and RDS server settings, except administrator roles and permissions and global (Multi-Datacenter View) LDAP. This is a non-selectable privilege.\n* GLOBAL_CONFIG_MANAGEMENT: View and change global (non-inventory) policy, configuration, and RDS server settings, except for administrator roles and permissions.\n* FOLDER_MANAGEMENT: Add, modify, and delete access groups.\n* FOLDER_VIEW: Read only access to access groups. This is a non-selectable privilege.\n* POOL_VIEW: Read only access to desktop pools, farms, applications, their local sessions, and their machines. This is a non-selectable privilege.\n* POOL_MANAGEMENT: Add, modify, and delete desktop pools, applications and farms. Add and remove machines from desktop pools.\n* POOL_ENABLE: Enable and disable desktop pools, farms, and applications.\n* POOL_ENTITLE: Add and remove desktop pool and application entitlements.\n* POOL_SVI_IMAGE_MANAGEMENT: Schedule push image, schedule maintenance and change default image for desktop pool and farm.\n* MACHINE_VIEW: Read only access to machines and their local sessions. This is a non-selectable privilege.\n* MACHINE_MANAGEMENT: Perform all machine and session-related commands.\n* MACHINE_REBOOT: Reset local machines.\n* MACHINE_SHUTDOWN: Shutdown local machines.\n* MACHINE_MANAGE_VDI_SESSION: Disconnect, logoff, and send messages to local sessions.\n* MACHINE_MANAGE_OFFLINE_SESSION: Roll back offline sessions and initiate replications.\n* MACHINE_USER_MANAGEMENT: Assign and un-assign users for machines, Update machine aliases for machines.\n* MACHINE_MAINTENANCE: Put machine in and out of maintenance mode.\n* MANAGE_REMOTE_PROCESS: Manage Remote Processes and Applications.\n* REMOTE_ASSISTANCE: Remote Assistance to Remote desktop pool.\n* GLOBAL_CVP_REGISTER: Global CVP Register. This is a non-selectable privilege.\n* GLOBAL_CVP_PUBLICATION: Global CVP Publication. This is a non-selectable privilege.\n* CVP_INTERACTIVE: CVP Interactive. This is a non-selectable privilege.\n* CVP_VIEW: CVP View. This is a non-selectable privilege.\n* CVP_MANAGEMENT: CVP Management.This is a non-selectable privilege.\n* CVP_OWNERSHIP: CVP Ownership.This is a non-selectable privilege.\n* API_SMART_CARD_BYPASS: Allows API's credential based login when smart card authentication mode is REQUIRED.\n* UDD_VIEW: Read only access to persistent disks. This is a non-selectable privilege.\n* UDD_MANAGEMENT: Manage persistent disks.\n* HORIZON_CLOUD_SERVICE: Allows subscription license activation and cloud monitoring through horizon cloud service.\n* SUBSCRIPTION_LICENSE_ADD: Allows subscription license activation.\n* CLOUD_ADMIN: Allows Cloud Admin Authentication.\n* CLOUD_ON_BOARDING_MANAGEMENT: Allows Cloud on-boarding.\n* CLOUD_OPS_MANAGEMENT: Allows Cloud operations post on-boarding.\n* CAPACITY_PROVIDER_CONFIG_VIEW: Manage Capacity Provider Configuration (Read Only).\n* CAPACITY_PROVIDER_CONFIG_MANAGEMENT: Manage Capacity Provider Configuration.\n* MANAGE_EXTERNAL_KEYS: Manage External Keys.\n* UNKNOWN_PRIVILEGE: Unknown Privilege type. This is a non-selectable privilege.","example":"[\"FEDERATED_LDAP_VIEW\",\"POOL_VIEW\",\"MACHINE_VIEW\"]","enum":["ADMINISTRATOR","ADMINISTRATOR_VIEW","VC_CONFIG_VIEW","LOG_COLLECTION","FORENSICS","MANAGE_CERTIFICATES","LCM_MANAGEMENT","LCM_VIEW","LOCAL_ADMINISTRATOR","LOCAL_ADMINISTRATOR_VIEW","INVENTORY_ADMINISTRATOR","INVENTORY_ADMINISTRATOR_VIEW","HELPDESK_ADMINISTRATOR","HELPDESK_ADMINISTRATOR_VIEW","FEDERATED_LDAP_MANAGE","FEDERATED_LDAP_VIEW","FEDERATED_SESSIONS_MANAGE","FEDERATED_SESSIONS_VIEW","GLOBAL_ADMINISTRATOR","GLOBAL_ADMINISTRATOR_VIEW","GLOBAL_ADMIN_UI_INTERACTIVE","GLOBAL_ADMIN_SDK_INTERACTIVE","GLOBAL_MACHINE_REGISTER","GLOBAL_ROLE_PERMISSION_MANAGEMENT","GLOBAL_ROLE_MANAGEMENT","GLOBAL_ROLE_VIEW","GLOBAL_PERMISSION_VIEW","GLOBAL_PERMISSION_MANAGEMENT","GLOBAL_CONFIG_VIEW","GLOBAL_CONFIG_MANAGEMENT","FOLDER_MANAGEMENT","FOLDER_VIEW","POOL_VIEW","POOL_MANAGEMENT","POOL_ENABLE","POOL_ENTITLE","POOL_SVI_IMAGE_MANAGEMENT","MACHINE_VIEW","MACHINE_MANAGEMENT","MACHINE_REBOOT","MACHINE_SHUTDOWN","MACHINE_MANAGE_VDI_SESSION","MACHINE_MANAGE_OFFLINE_SESSION","MACHINE_USER_MANAGEMENT","MACHINE_MAINTENANCE","MANAGE_REMOTE_PROCESS","REMOTE_ASSISTANCE","GLOBAL_CVP_REGISTER","GLOBAL_CVP_PUBLICATION","CVP_INTERACTIVE","CVP_VIEW","CVP_MANAGEMENT","CVP_OWNERSHIP","API_SMART_CARD_BYPASS","UDD_VIEW","UDD_MANAGEMENT","HORIZON_CLOUD_SERVICE","SUBSCRIPTION_LICENSE_ADD","CLOUD_ADMIN","CLOUD_ON_BOARDING_MANAGEMENT","CLOUD_OPS_MANAGEMENT","CAPACITY_PROVIDER_CONFIG_VIEW","CAPACITY_PROVIDER_CONFIG_MANAGEMENT","MANAGE_EXTERNAL_KEYS","UNKNOWN_PRIVILEGE"]}}},"description":"Information about privileges."},"ProblemCountMetrics":{"type":"object","properties":{"agent_disabled":{"type":"integer","description":"Number of machines which are in AGENT_ERR_DISABLED State","format":"int32","example":1},"agent_unreachable":{"type":"integer","description":"Number of machines which are in AGENT_UNREACHABLE State ","format":"int32","example":1},"already_used":{"type":"integer","description":"Number of machines which are in ALREADY_USED State. ","format":"int32","example":1},"blocked_agent_version":{"type":"integer","description":"Number of machines which are in BLOCKED_AGENT_VERSION State.","format":"int32","example":1},"config_error":{"type":"integer","description":"Number of machines which are in AGENT_CONFIG_ERROR State .","format":"int32","example":1},"domain_failure":{"type":"integer","description":"Number of machines which are in AGENT_ERR_DOMAIN_FAILURE State","format":"int32","example":1},"error":{"type":"integer","description":"Number of machines which are in ERROR State.","format":"int32","example":1},"invalid_ip":{"type":"integer","description":"Number of machines which are in AGENT_ERR_INVALID_IP State ","format":"int32","example":1},"need_reboot":{"type":"integer","description":"Number of machines which are in AGENT_ERR_NEED_REBOOT State ","format":"int32","example":1},"protocol_failure":{"type":"integer","description":"Number of machines which are in AGENT_ERR_PROTOCOL_FAILURE State","format":"int32","example":1},"provisioning_error":{"type":"integer","description":"Number of machines which are in PROVISIONING_ERROR State. ","format":"int32","example":1},"unassigned_user_connected":{"type":"integer","description":"Number of machines which are in UNASSIGNED_USER_CONNECTED State. ","format":"int32","example":1},"unassigned_user_disconnected":{"type":"integer","description":"Number of machines which are in UNASSIGNED_USER_DISCONNECTED State. ","format":"int32","example":1},"unknown":{"type":"integer","description":"Number of machines which are in UNKNOWN State. ","format":"int32","example":1}},"description":"Counts of the RDS server machines which are in problem state. "},"ProcessPerformanceInfo":{"type":"object","properties":{"cpu":{"type":"number","description":"The cpu utilization.","format":"double","example":0.0},"create_time":{"type":"integer","description":"The process creation time.","format":"int64","example":1687202598},"disk":{"type":"number","description":"the disk utilization.","format":"double","example":0.0},"memory":{"type":"number","description":"The memory utilization.","format":"double","example":1323008.0},"name":{"type":"string","description":"The name of the process","example":"svchost.exe"},"process_id":{"type":"integer","description":"The process id.","format":"int64","example":1636},"user_name":{"type":"string","description":"The owner of the process.","example":"SYSTEM"}},"description":"Information about process performance."},"ProvisioningSettings":{"type":"object","properties":{"desktop_name_pattern_settings":{"$ref":"#/components/schemas/DesktopNamePatternSettings"},"enable_provisioning":{"type":"boolean","description":"Applicable To: Automated desktop pools with default value as true.<br>Indicates whether provisioning is enabled.<br>Supported Filters: 'Equals'.\nThis property can be used for sorting.","example":true},"naming_method":{"type":"string","description":"Applicable To: Automated desktop pool.<br>Naming method for the desktop pool. This is required for Automated desktop pools.\nThis property can be used for sorting.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","example":"PATTERN","enum":["SPECIFIED","PATTERN"]},"specific_naming_settings":{"$ref":"#/components/schemas/DesktopSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","description":"Applicable for Automated pools only with default value as true.\nThis property can be used for sorting.","example":true}},"description":"Applicable To: Automated desktop pool. <br>Capacity provider provisioning settings for Automated desktop pool."},"ProvisioningStatusData":{"type":"object","properties":{"desktop_pool_operation":{"type":"string","description":"Applicable To: Automated desktop pools.<br>The operation that this desktop pool is undergoing.\nThis property can be used for sorting.\n* CANCEL_SCHEDULED_PUSH_IMAGE: The scheduled push operation on the desktop pool is being cancelled.\n* FINAL_UNPUBLISH: A desktop pool has been deleted and is undergoing final unpublishing.\n* INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the desktop pool.\n* INITIAL_PUBLISH: The desktop pool has just been created and is undergoing initial publishing.\n* NONE: There is no current operation on the desktop pool.\n* SCHEDULE_PUSH_IMAGE: The push operation is scheduled on the desktop pool.","example":"NONE","enum":["CANCEL_SCHEDULED_PUSH_IMAGE","FINAL_UNPUBLISH","INFRASTRUCTURE_CHANGE","INITIAL_PUBLISH","NONE","SCHEDULE_PUSH_IMAGE"]},"desktop_pool_push_image_settings":{"$ref":"#/components/schemas/DesktopPoolPushImageSettings"},"last_provisioning_error":{"type":"string","description":"String message detailing the last provisioning error on this desktop pool while stop_provisioning_on_error is enabled. This will be cleared when enable_provisioning is updated to true.\nThis property can be used for sorting.","example":"Initial publish failed: Could not authenticate with domain administrator credentials"},"last_provisioning_error_time":{"type":"integer","description":"Time the last provisioning error occurred on this desktop while stop_provisioning_on_error is enabled. This will be cleared when enable_provisioning is updated to true. Measured as epoch time.\nThis property can be used for sorting.","format":"int64","example":1587081283000},"pending_image_error":{"type":"string","description":"Applicable To: automated desktop pools.<br>This represents the error message if the push image operation fails.\nThis property can be used for sorting.","example":"Could not authenticate with domain administrator credentials"},"pending_image_parent_vm_id":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Pending parent image VM for automated desktop pools. This is used to return the information about the parent VM of the pending Image.","example":"vm-1"},"pending_image_progress":{"type":"integer","description":"Applicable To: automated desktop pools.<br>This represents the pending image publish progress in percentage for an automated desktop pool.\nThis property can be used for sorting.","format":"int32","example":10},"pending_image_snapshot_id":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Pending parent image snapshot for automated desktop pools. This is used to return the information about the snapshot of the pending image.","example":"snapshot-1"},"pending_image_state":{"type":"string","description":"Applicable To: Automated desktop pools.<br>This represents the state of the pending image of this clone desktop pool. This will be null when there is no pending image for the desktop pool.\nThis property can be used for sorting.\n* FAILED: This is the state of the pending image if creation of clone operation has failed or timed out.\n* PENDING_PUBLISH: This is the initial transient state of the pending image before clone creation operation has started.\n* PUBLISHING: This is the transient state of the pending image when creation of clone operation is going on.\n* READY: This is the state of the pending image after successful publish of the pending image and before that image has been upgraded to the current image. This is normally seen after successful publish for a push image which has been scheduled to trigger at a later time.\n* READY_HELD: This is the state of the pending image after performing a selective resync operation, in which the image may be applied to some VMs in the desktop pool/farm.\n* UNPUBLISHING: This is the transient state of the pending image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"FAILED","enum":["FAILED","PENDING_PUBLISH","PUBLISHING","READY","READY_HELD","UNPUBLISHING"]}},"description":"Provisioning status data about this automated desktop pool."},"ProvisioningStatusDataV2":{"type":"object","properties":{"desktop_pool_operation":{"type":"string","description":"Applicable To: Automated desktop pools.<br>The operation that this desktop pool is undergoing.\nThis property can be used for sorting.\n* CANCEL_SCHEDULED_PUSH_IMAGE: The scheduled push operation on the desktop pool is being cancelled.\n* FINAL_UNPUBLISH: A desktop pool has been deleted and is undergoing final unpublishing.\n* INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the desktop pool.\n* INITIAL_PUBLISH: The desktop pool has just been created and is undergoing initial publishing.\n* NONE: There is no current operation on the desktop pool.\n* SCHEDULE_PUSH_IMAGE: The push operation is scheduled on the desktop pool.","example":"NONE","enum":["CANCEL_SCHEDULED_PUSH_IMAGE","FINAL_UNPUBLISH","INFRASTRUCTURE_CHANGE","INITIAL_PUBLISH","NONE","SCHEDULE_PUSH_IMAGE"]},"desktop_pool_push_image_settings":{"$ref":"#/components/schemas/DesktopPoolPushImageSettings"},"last_provisioning_error":{"type":"string","description":"String message detailing the last provisioning error on this desktop pool while stop_provisioning_on_error is enabled. This will be cleared when enable_provisioning is updated to true.\nThis property can be used for sorting.","example":"Initial publish failed: Could not authenticate with domain administrator credentials"},"last_provisioning_error_time":{"type":"integer","description":"Time the last provisioning error occurred on this desktop while stop_provisioning_on_error is enabled. This will be cleared when enable_provisioning is updated to true. Measured as epoch time.\nThis property can be used for sorting.","format":"int64","example":1587081283000},"pending_image_error":{"type":"string","description":"Applicable To: automated desktop pools.<br>This represents the error message if the push image operation fails.\nThis property can be used for sorting.","example":"Could not authenticate with domain administrator credentials"},"pending_image_identifier":{"type":"string","description":"Golden image identifier","example":"vm-name"},"pending_image_parent_vm_id":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Pending parent image VM for automated desktop pools. This is used to return the information about the parent VM of the pending Image.","example":"vm-1"},"pending_image_progress":{"type":"integer","description":"Applicable To: automated desktop pools.<br>This represents the pending image publish progress in percentage for an automated desktop pool.\nThis property can be used for sorting.","format":"int32","example":10},"pending_image_snapshot_id":{"type":"string","description":"Applicable To: Automated desktop pools.<br>Pending parent image snapshot for automated desktop pools. This is used to return the information about the snapshot of the pending image.","example":"snapshot-1"},"pending_image_snapshot_identifier":{"type":"string","description":"Golden image snapshot identifier","example":"snapshot-1"},"pending_image_state":{"type":"string","description":"Applicable To: Automated desktop pools.<br>This represents the state of the pending image of this clone desktop pool. This will be null when there is no pending image for the desktop pool.\nThis property can be used for sorting.\n* FAILED: This is the state of the pending image if creation of clone operation has failed or timed out.\n* PENDING_PUBLISH: This is the initial transient state of the pending image before clone creation operation has started.\n* PUBLISHING: This is the transient state of the pending image when creation of clone operation is going on.\n* READY: This is the state of the pending image after successful publish of the pending image and before that image has been upgraded to the current image. This is normally seen after successful publish for a push image which has been scheduled to trigger at a later time.\n* READY_HELD: This is the state of the pending image after performing a selective resync operation, in which the image may be applied to some VMs in the desktop pool/farm.\n* UNPUBLISHING: This is the transient state of the pending image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.","example":"FAILED","enum":["FAILED","PENDING_PUBLISH","PUBLISHING","READY","READY_HELD","UNPUBLISHING"]}},"description":"Provisioning status data about this automated desktop pool."},"PublicKeyInfo":{"type":"object","properties":{"key_id":{"type":"string","description":"The unique identifier for the public key.","example":"e5ab8524-433c-4a6f-8fe8-4ab352ddaf56"},"metadata":{"type":"string","description":"Metadata associated with the public key.","example":"some-metadata"},"public_key":{"type":"string","description":"The public key in PEM format.","example":"<publicKey>"}},"description":"Information about JWT authenticator."},"PushImageSettings":{"type":"object","properties":{"immediate_maintenance_scheduled":{"type":"boolean","description":"Indicates whether immediate maintenance is scheduled.","example":true},"logoff_policy":{"type":"string","description":"Determines when to perform the operation on machines which have an active session.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"pending_bundle_id":{"type":"string","description":"Indicates pending AWS core bundle ID for push image","example":"wdy-hv3jhyzb2"},"pending_bundle_name":{"type":"string","description":"Indicates pending AWS core bundle Name for push image","example":"bundle_name"},"pending_image_id":{"type":"string","description":"Indicates pending AWS core Image ID for push image","example":"wsi-7b1ymfqqk"},"pending_image_name":{"type":"string","description":"Indicates pending AWS core Image Name for push image","example":"image_name"},"start_time":{"type":"integer","description":"When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time.","format":"int64","example":1587081283000},"stop_on_first_error":{"type":"boolean","description":"Indicates that the operation should stop on first error.","example":true}},"description":"Settings for the push image operation."},"RADIUSAuthenticatorCreateSpec":{"required":["label","radius_servers"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description for this RADIUS authenticator.","example":"test radius auth "},"label":{"maxLength":50,"minLength":0,"type":"string","description":"The label for this RADIUS authenticator. It must be unique among all other RADIUS authenticators.","example":"radius-auth-lablel"},"passcode_label":{"maxLength":20,"minLength":0,"type":"string","description":"The label for the RADIUS authenticator passcode.","example":"test radius auth user passcode"},"radius_servers":{"type":"array","description":"List of RADIUS servers. The list must have exactly one primary RADIUS server i.e. with primary_radius_server set to true.","items":{"$ref":"#/components/schemas/RADIUSServerCreateSpec"}},"user_name_label":{"maxLength":20,"minLength":0,"type":"string","description":"The label for the RADIUS authenticator user name.","example":"test radius auth user"}},"description":"RADIUS authenticator object to be created."},"RADIUSAuthenticatorInfo":{"type":"object","properties":{"description":{"type":"string","description":"The description for this RADIUS authenticator.","example":"test radius auth "},"id":{"type":"string","description":"Unique ID representing this RADIUS Authenticator.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"label":{"type":"string","description":"The label for this RADIUS authenticator.","example":"radius-auth-lablel"},"passcode_label":{"type":"string","description":"The label for the RADIUS authenticator passcode.","example":"test radius auth user passcode"},"radius_servers":{"type":"array","description":"List of RADIUS servers.","items":{"$ref":"#/components/schemas/RADIUSServerInfo"}},"user_name_label":{"type":"string","description":"The label for the RADIUS authenticator user name.","example":"test radius auth user"}},"description":"Information about to RADIUS Authenticator."},"RADIUSAuthenticatorUpdateSpec":{"required":["label","radius_servers"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description for this RADIUS authenticator.","example":"test radius auth "},"label":{"maxLength":50,"minLength":0,"type":"string","description":"The label for this RADIUS authenticator. It must be unique among all other RADIUS authenticators.","example":"radius-auth-lablel"},"passcode_label":{"maxLength":20,"minLength":0,"type":"string","description":"The label for the RADIUS authenticator passcode.","example":"test radius auth user passcode"},"radius_servers":{"type":"array","description":"List of RADIUS servers. The list must have exactly one primary RADIUS server i.e. with primary_radius_server set to true.","items":{"$ref":"#/components/schemas/RADIUSServerUpdateSpec"}},"user_name_label":{"maxLength":20,"minLength":0,"type":"string","description":"The label for the RADIUS authenticator user name.","example":"test radius auth user"}},"description":"RADIUS authenticator object to be updated."},"RADIUSServerCreateSpec":{"required":["accounting_port","authentication_port","authentication_type","hostname","max_attempts","server_timeout_seconds","shared_secret"],"type":"object","properties":{"accounting_port":{"type":"integer","description":"The accounting port of the RADIUS authentication server.","format":"int32","example":1813},"authentication_port":{"type":"integer","description":"The authentication port of the RADIUS authentication server. Radius servers should not have both hostname and authentication port same.","format":"int32","example":1812},"authentication_type":{"type":"string","description":"The authentication type of the RADIUS authentication server.\n* PAP: Password authentication protocol.\n* CHAP: Challenge-handshake authentication protocol.\n* MSCHAP1: Microsoft challenge-handshake authentication protocol, version 1.\n* MSCHAP2: Microsoft challenge-handshake authentication protocol, version 2.\n* UNKNOWN: Indicates Auth type is unkonwn.","example":"PAP","enum":["PAP","CHAP","MSCHAP1","MSCHAP2","UNKNOWN"]},"hostname":{"type":"string","description":"The hostname of the RADIUS authentication server. Radius servers should not have both hostname and authentication port same.","example":"10.109.69.213"},"max_attempts":{"minimum":1,"type":"integer","description":"The maximum number of authentication attempts for the RADIUS authentication server.","format":"int32","example":5},"primary_radius_server":{"type":"boolean","description":"Indicates whether it is a primary RADIUS authentication server. There must be exactly one primary RADIUS server i.e. with primary_radius_server set to true. Default value is false.","example":true},"realm_prefix":{"type":"string","description":"The realm prefix of the RADIUS authentication server.","example":"test_realm_prefix"},"realm_suffix":{"type":"string","description":"The realm suffix of the RADIUS authentication server.","example":"test_realm_suffix"},"server_timeout_seconds":{"minimum":1,"type":"integer","description":"The server timeout (in seconds) of the RADIUS authentication server.","format":"int32","example":4},"shared_secret":{"type":"array","description":"The shared secret of the RADIUS authentication server.","example":"<password>","items":{"type":"string","description":"The shared secret of the RADIUS authentication server.","example":"<password>"}}},"description":"Information required to create a RADIUS authentication server."},"RADIUSServerInfo":{"type":"object","properties":{"accounting_port":{"type":"integer","description":"The accounting port of the RADIUS authentication server.","format":"int32","example":1813},"authentication_port":{"type":"integer","description":"The authentication port of the RADIUS authentication server.","format":"int32","example":1812},"authentication_type":{"type":"string","description":"The authentication type of the RADIUS authentication server.\n* PAP: Password authentication protocol.\n* CHAP: Challenge-handshake authentication protocol.\n* MSCHAP1: Microsoft challenge-handshake authentication protocol, version 1.\n* MSCHAP2: Microsoft challenge-handshake authentication protocol, version 2.\n* UNKNOWN: Indicates Auth type is unkonwn.","example":"PAP","enum":["PAP","CHAP","MSCHAP1","MSCHAP2","UNKNOWN"]},"hostname":{"type":"string","description":"The hostname of the RADIUS authentication server.","example":"10.109.69.213"},"max_attempts":{"type":"integer","description":"The maximum number of authentication attempts for the RADIUS authentication server.","format":"int32","example":5},"primary_radius_server":{"type":"boolean","description":"Indicates whether it is a primary RADIUS authentication server.","example":true},"realm_prefix":{"type":"string","description":"The realm prefix of the RADIUS authentication server.","example":"test_realm_prefix"},"realm_suffix":{"type":"string","description":"The realm suffix of the RADIUS authentication server.","example":"test_realm_suffix"},"server_timeout_seconds":{"type":"integer","description":"The server timeout (in seconds) of the RADIUS authentication server.","format":"int32","example":4}},"description":"Information related to a RADIUS authentication server."},"RADIUSServerUpdateSpec":{"required":["accounting_port","authentication_port","authentication_type","hostname","max_attempts","primary_radius_server","server_timeout_seconds"],"type":"object","properties":{"accounting_port":{"type":"integer","description":"The accounting port of the RADIUS authentication server.","format":"int32","example":1813},"authentication_port":{"type":"integer","description":"The authentication port of the RADIUS authentication server. Primary and secondary servers should not have both hostname and authentication port same.","format":"int32","example":1812},"authentication_type":{"type":"string","description":"The authentication type of the RADIUS authentication server.\n* PAP: Password authentication protocol.\n* CHAP: Challenge-handshake authentication protocol.\n* MSCHAP1: Microsoft challenge-handshake authentication protocol, version 1.\n* MSCHAP2: Microsoft challenge-handshake authentication protocol, version 2.\n* UNKNOWN: Indicates Auth type is unkonwn.","example":"PAP","enum":["PAP","CHAP","MSCHAP1","MSCHAP2","UNKNOWN"]},"hostname":{"type":"string","description":"The hostname of the RADIUS authentication server. Primary and secondary servers should not have both hostname and authentication port same.","example":"10.109.69.213"},"max_attempts":{"minimum":1,"type":"integer","description":"The maximum number of authentication attempts for the RADIUS authentication server.","format":"int32","example":5},"primary_radius_server":{"type":"boolean","description":"Indicates whether it is a primary RADIUS authentication server. There must be exactly one primary RADIUS server i.e. with primary_radius_server set to true.","example":true},"realm_prefix":{"type":"string","description":"The realm prefix of the RADIUS authentication server.","example":"test_realm_prefix"},"realm_suffix":{"type":"string","description":"The realm suffix of the RADIUS authentication server.","example":"test_realm_suffix"},"server_timeout_seconds":{"minimum":1,"type":"integer","description":"The server timeout (in seconds) of the RADIUS authentication server.","format":"int32","example":4},"shared_secret":{"type":"array","description":"The shared secret of the RADIUS authentication server.","example":"<password>","items":{"type":"string","description":"The shared secret of the RADIUS authentication server.","example":"<password>"}}},"description":"Information required to create a RADIUS authentication server."},"RCXClientRegisterSpec":{"required":["name","thumbprints"],"type":"object","properties":{"ip_address":{"type":"string","description":"IP address of the RCX client.","example":"127.0.0.1"},"name":{"type":"string","description":"The RCX client certificate name.","example":"example.com"},"thumbprints":{"type":"array","description":"Thumbprints of the RCX client certificate.","items":{"$ref":"#/components/schemas/CertificateThumbprint"}}},"description":"RCX client object to be registered."},"RCXClientUpdateSpec":{"required":["thumbprints"],"type":"object","properties":{"ip_address":{"type":"string","description":"IP address of the RCX client.","example":"127.0.0.1"},"thumbprints":{"type":"array","description":"Thumbprints of the RCX client certificate.","items":{"$ref":"#/components/schemas/CertificateThumbprint"}}},"description":"RCX client object to be updated."},"RCXServerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID representing RCX server.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"name":{"type":"string","description":"FQDN/IP address of the RCX server.","example":"rcxserver.example.com"},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"RCX server's port.","format":"int32","example":81},"status":{"type":"string","description":"This indicates the current status of RCX server.\n* UP: RCX server is running.\n* DOWN: RCX server is down.\n* UNKNOWN: RCX server status is unknown.","example":"UP","enum":["UP","DOWN","UNKNOWN"]},"thumbprints":{"type":"array","description":"Thumbprints of the RCX server certificates.","items":{"$ref":"#/components/schemas/CertificateThumbprint"}},"version":{"type":"string","description":"Version information of RCX server.","example":"7.12"}},"description":"Information related to RCX servers of the cluster."},"RDSHLoadBalancerSettingsCreateSpec":{"type":"object","properties":{"cpu_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":10},"disk_queue_length_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average number of both read and write requests that were queued for the selected disk during the sample interval. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":15},"disk_read_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":10},"disk_write_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":15},"include_session_count":{"type":"boolean","description":"Indicates whether to include session count for load balancing. Default value is true when use_custom_script_for_load_balancing is false.","example":true},"memory_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":10}},"description":"RDSH load balancer settings for the farm."},"RDSHLoadBalancerSettingsCreateSpecV2":{"type":"object","properties":{"connecting_session_threshold":{"maximum":150,"minimum":0,"type":"integer","description":"Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions. By default, this threshold is disabled and does not deny session logins. Default value is 0.","format":"int32","example":10},"cpu_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":10},"disk_queue_length_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average number of both read and write requests that were queued for the selected disk during the sample interval. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":15},"disk_read_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":10},"disk_write_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":15},"include_session_count":{"type":"boolean","description":"Indicates whether to include session count for load balancing. Default value is true when use_custom_script_for_load_balancing is false.","example":true},"load_index_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions. By default, this threshold is disabled and does not deny session logins. Default value is 0.","format":"int32","example":20},"memory_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":10}},"description":"RDSH load balancer settings for the farm."},"RDSHLoadBalancerSettingsCreateSpecV3":{"type":"object","properties":{"connecting_session_threshold":{"maximum":150,"minimum":0,"type":"integer","description":"Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions. By default, this threshold is disabled and does not deny session logins. Default value is 0.","format":"int32","example":10},"cpu_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":10},"disk_queue_length_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average number of both read and write requests that were queued for the selected disk during the sample interval. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":15},"disk_read_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":10},"disk_write_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":15},"include_session_count":{"type":"boolean","description":"Indicates whether to include session count for load balancing. Default value is true when use_custom_script_for_load_balancing is false.","example":true},"load_index_lb_enabled":{"type":"boolean","description":"Indicates if load index based load balancing is enabled. Default value is true."},"load_index_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions. By default, this threshold is disabled and does not deny session logins. Default value is 0.","format":"int32","example":20},"memory_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. Default value is 0.","format":"int32","example":10}},"description":"RDSH load balancer settings for the farm."},"RDSHLoadBalancerSettingsInfo":{"type":"object","properties":{"cpu_threshold":{"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":10},"disk_queue_length_threshold":{"type":"integer","description":"Represents the threshold of average number of both read and write requests that were queued for the selected disk during the sample interval. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":15},"disk_read_latency_threshold":{"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10},"disk_write_latency_threshold":{"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":15},"include_session_count":{"type":"boolean","description":"Indicates whether to include session count for load balancing.","example":true},"memory_threshold":{"type":"integer","description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10}},"description":"RDSH load balancer settings for the farm."},"RDSHLoadBalancerSettingsInfoV2":{"type":"object","properties":{"connecting_session_threshold":{"type":"integer","description":"Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions.","format":"int32","example":10},"cpu_threshold":{"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":10},"disk_queue_length_threshold":{"type":"integer","description":"Represents the threshold of average number of both read and write requests that were queued for the selected disk during the sample interval. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":15},"disk_read_latency_threshold":{"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10},"disk_write_latency_threshold":{"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":15},"include_session_count":{"type":"boolean","description":"Indicates whether to include session count for load balancing.","example":true},"load_index_threshold":{"type":"integer","description":"Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions.","format":"int32","example":20},"memory_threshold":{"type":"integer","description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10}},"description":"RDSH load balancer settings for the farm."},"RDSHLoadBalancerSettingsInfoV3":{"type":"object","properties":{"connecting_session_threshold":{"type":"integer","description":"Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions.","format":"int32","example":10},"cpu_threshold":{"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":10},"disk_queue_length_threshold":{"type":"integer","description":"Represents the threshold of average number of both read and write requests that were queued for the selected disk during the sample interval. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":15},"disk_read_latency_threshold":{"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10},"disk_write_latency_threshold":{"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":15},"include_session_count":{"type":"boolean","description":"Indicates whether to include session count for load balancing.","example":true},"load_index_lb_enabled":{"type":"boolean","description":"Indicates if load index based load balancing is enabled."},"load_index_threshold":{"type":"integer","description":"Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions.","format":"int32","example":20},"memory_threshold":{"type":"integer","description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10}},"description":"RDSH load balancer settings for the farm."},"RDSHLoadBalancerSettingsUpdateSpec":{"required":["cpu_threshold","disk_queue_length_threshold","disk_read_latency_threshold","disk_write_latency_threshold","include_session_count","memory_threshold"],"type":"object","properties":{"cpu_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":10},"disk_queue_length_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average number of both read and write requests that were queued for the selected disk during the sample interval. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":15},"disk_read_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":10},"disk_write_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":15},"include_session_count":{"type":"boolean","description":"Indicates whether to include session count for load balancing.","example":true},"memory_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10}},"description":"RDSH load balancer settings for the farm. This is required if use_custom_script_for_load_balancing is false."},"RDSHLoadBalancerSettingsUpdateSpecV2":{"required":["connecting_session_threshold","cpu_threshold","disk_queue_length_threshold","disk_read_latency_threshold","disk_write_latency_threshold","include_session_count","load_index_threshold","memory_threshold"],"type":"object","properties":{"connecting_session_threshold":{"maximum":150,"minimum":0,"type":"integer","description":"Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions.","format":"int32","example":10},"cpu_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":10},"disk_queue_length_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average number of both read and write requests that were queued for the selected disk during the sample interval. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":15},"disk_read_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":10},"disk_write_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":15},"include_session_count":{"type":"boolean","description":"Indicates whether to include session count for load balancing.","example":true},"load_index_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions.","format":"int32","example":20},"memory_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10}},"description":"RDSH load balancer settings for the farm."},"RDSHLoadBalancerSettingsUpdateSpecV3":{"required":["connecting_session_threshold","cpu_threshold","disk_queue_length_threshold","disk_read_latency_threshold","disk_write_latency_threshold","include_session_count","load_index_threshold","memory_threshold"],"type":"object","properties":{"connecting_session_threshold":{"maximum":150,"minimum":0,"type":"integer","description":"Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions.","format":"int32","example":10},"cpu_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":10},"disk_queue_length_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average number of both read and write requests that were queued for the selected disk during the sample interval. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":15},"disk_read_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a read of data from the disk. If the value is 0, then this metric is not considered for load balancing.","format":"int32","example":10},"disk_write_latency_threshold":{"minimum":0,"type":"integer","description":"Represents the threshold of average time, in milliseconds, of a write of data to the disk. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":15},"include_session_count":{"type":"boolean","description":"Indicates whether to include session count for load balancing.","example":true},"load_index_lb_enabled":{"type":"boolean","description":"Indicates if load index based load balancing is enabled. Default value is true."},"load_index_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions.","format":"int32","example":20},"memory_threshold":{"maximum":100,"minimum":0,"type":"integer","description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. ","format":"int32","example":10}},"description":"RDSH load balancer settings for the farm."},"RDSServerInfo":{"type":"object","properties":{"access_group_id":{"type":"string","description":"The id of the Access Group that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"base_vm_id":{"type":"string","description":"The base vm id.<br>Supported Filters : 'Equals'.","example":"vm-23"},"base_vm_snapshot_id":{"type":"string","description":"The base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-2"},"description":{"type":"string","description":"Description of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"New RDS Server."},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"The id of the Farm that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing the RDS Server.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_management_stream_id":{"type":"string","description":"The id of the image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_tag_id":{"type":"string","description":"The id of the image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"load_index":{"type":"integer","description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.\nThis property can be used for sorting.","format":"int32","example":60},"load_preference":{"type":"string","description":"Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.\nThis property can be used for sorting.\n* BLOCK: RDS Server is blocked and new sessions will not be accepted.\n* HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.\n* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.","example":"NORMAL","enum":["BLOCK","HEAVY","LIGHT","NORMAL","UNKNOWN"]},"logoff_policy":{"type":"string","description":"The user log off behavior at the time of maintenance.\nThis property can be used for sorting.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"max_sessions_count":{"type":"integer","description":"Maximum number of sessions for RDS server as reported by the Horizon Agent. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_type":{"type":"string","description":"RDS Server max sessions type as reported by the Horizon Agent.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"server1"},"operating_system":{"type":"string","description":"The machine operating system.Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2012","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operation":{"type":"string","description":"The current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"REFRESH","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"operation_state":{"type":"string","description":"The state of the current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CANCELLING: The operation has been cancelled.\n* COMPLETED: The operation has completed.\n* CREATE: The operation is being initiated.\n* FAULT: The operation has encountered an error.\n* HOLDING: The operation has been paused.\n* PROGRESSING: The operation is in progress.\n* SCHEDULED: The operation is scheduled for future execution.\n* STANDBY: The operation is on standby for a selective resync.\n* UNDEFINED: The operation state is unrecognized.","example":"AVAILABLE","enum":["CANCELLING","COMPLETED","CREATE","FAULT","HOLDING","PROGRESSING","SCHEDULED","STANDBY","UNDEFINED"]},"pending_base_vm_id":{"type":"string","description":"The pending base vm id.<br>Supported Filters : 'Equals'.","example":"vm-8"},"pending_base_vm_snapshot_id":{"type":"string","description":"The pending base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-7"},"pending_image_management_stream_id":{"type":"string","description":"The id of the pending image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25"},"pending_image_management_tag_id":{"type":"string","description":"The id of the pending image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_count":{"type":"integer","description":"RDS server session count.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int32","example":35},"state":{"type":"string","description":"The state of the RDS server.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.\n* AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.\n* AGENT_ERR_DISABLED: The Horizon Agent is disabled.\n* AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.\n* AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.\n* AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.\n* AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.\n* AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* ALREADY_USED: The RDS Server cannot accept new sessions.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The RDS Server is in an active session.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* DISABLED: The RDS Server is disabled.\n* DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\n* ERROR: An unknown error occurred in the RDS Server.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* PROVISIONED: The RDS Server has been provisioned.\n* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNKNOWN: Could not determine the state of the RDS Server.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERR_DISABLED","AGENT_ERR_DOMAIN_FAILURE","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNKNOWN","VALIDATING","WAIT_FOR_AGENT"]}},"description":"Information related to an RDS Server.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"RDSServerInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","description":"The id of the Access Group that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the rds server.\nThis property can be used for sorting.","example":"true"},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the rds server.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the rds server.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"base_vm_id":{"type":"string","description":"The base vm id.<br>Supported Filters : 'Equals'.","example":"vm-23"},"base_vm_snapshot_id":{"type":"string","description":"The base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-2"},"description":{"type":"string","description":"Description of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"New RDS Server."},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"The id of the Farm that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"id":{"type":"string","description":"Unique ID representing the RDS Server.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_management_stream_id":{"type":"string","description":"The id of the image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_tag_id":{"type":"string","description":"The id of the image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"load_index":{"type":"integer","description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.\nThis property can be used for sorting.","format":"int32","example":60},"load_preference":{"type":"string","description":"Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.\nThis property can be used for sorting.\n* BLOCK: RDS Server is blocked and new sessions will not be accepted.\n* HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.\n* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.","example":"NORMAL","enum":["BLOCK","HEAVY","LIGHT","NORMAL","UNKNOWN"]},"logoff_policy":{"type":"string","description":"The user log off behavior at the time of maintenance.\nThis property can be used for sorting.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"max_sessions_count":{"type":"integer","description":"Maximum number of sessions for RDS server as reported by the Horizon Agent. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_type":{"type":"string","description":"RDS Server max sessions type as reported by the Horizon Agent.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"server1"},"network_labels_by_nic":{"type":"object","additionalProperties":{"type":"string","description":"Network label assignments on the rds server.","example":"Network adapter 1=Compute-121"},"description":"Network label assignments on the rds server.","example":"Network adapter 1=Compute-121"},"operating_system":{"type":"string","description":"The machine operating system.Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2012","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operation":{"type":"string","description":"The current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"REFRESH","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"operation_state":{"type":"string","description":"The state of the current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CANCELLING: The operation has been cancelled.\n* COMPLETED: The operation has completed.\n* CREATE: The operation is being initiated.\n* FAULT: The operation has encountered an error.\n* HOLDING: The operation has been paused.\n* PROGRESSING: The operation is in progress.\n* SCHEDULED: The operation is scheduled for future execution.\n* STANDBY: The operation is on standby for a selective resync.\n* UNDEFINED: The operation state is unrecognized.","example":"AVAILABLE","enum":["CANCELLING","COMPLETED","CREATE","FAULT","HOLDING","PROGRESSING","SCHEDULED","STANDBY","UNDEFINED"]},"pending_base_vm_id":{"type":"string","description":"The pending base vm id.<br>Supported Filters : 'Equals'.","example":"vm-8"},"pending_base_vm_snapshot_id":{"type":"string","description":"The pending base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-7"},"pending_image_management_stream_id":{"type":"string","description":"The id of the pending image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25"},"pending_image_management_tag_id":{"type":"string","description":"The id of the pending image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_count":{"type":"integer","description":"RDS server session count.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int32","example":35},"state":{"type":"string","description":"The state of the RDS server.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.\n* AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.\n* AGENT_ERR_DISABLED: The Horizon Agent is disabled.\n* AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.\n* AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.\n* AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.\n* AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.\n* AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* ALREADY_USED: The RDS Server cannot accept new sessions.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The RDS Server is in an active session.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* DISABLED: The RDS Server is disabled.\n* DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\n* ERROR: An unknown error occurred in the RDS Server.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* PROVISIONED: The RDS Server has been provisioned.\n* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNKNOWN: Could not determine the state of the RDS Server.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERR_DISABLED","AGENT_ERR_DOMAIN_FAILURE","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNKNOWN","VALIDATING","WAIT_FOR_AGENT"]}},"description":"Information related to an RDS Server.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"RDSServerInfoV3":{"type":"object","properties":{"access_group_id":{"type":"string","description":"The id of the Access Group that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the rds server.\nThis property can be used for sorting.","example":"true"},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the rds server.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the rds server.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"base_vm_id":{"type":"string","description":"The base vm id.<br>Supported Filters : 'Equals'.","example":"vm-23"},"base_vm_snapshot_id":{"type":"string","description":"The base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-2"},"description":{"type":"string","description":"Description of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"New RDS Server."},"desktop_pool_name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.","example":"sales-pool1"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"The id of the Farm that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"farm_name":{"type":"string","description":"Name of the Farm. The maximum length is 64 characters.Supported Filters: 'Equals', 'StartsWith', 'EndsWith', 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm1"},"id":{"type":"string","description":"Unique ID representing the RDS Server.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_management_stream_id":{"type":"string","description":"The id of the image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_tag_id":{"type":"string","description":"The id of the image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"load_index":{"type":"integer","description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.\nThis property can be used for sorting.","format":"int32","example":60},"load_preference":{"type":"string","description":"Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.\nThis property can be used for sorting.\n* BLOCK: RDS Server is blocked and new sessions will not be accepted.\n* HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.\n* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.","example":"NORMAL","enum":["BLOCK","HEAVY","LIGHT","NORMAL","UNKNOWN"]},"logoff_policy":{"type":"string","description":"The user log off behavior at the time of maintenance.\nThis property can be used for sorting.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"max_sessions_count":{"type":"integer","description":"Maximum number of sessions for RDS server as reported by the Horizon Agent. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_type":{"type":"string","description":"RDS Server max sessions type as reported by the Horizon Agent.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"server1"},"network_labels_by_nic":{"type":"object","additionalProperties":{"type":"string","description":"Network label assignments on the rds server.","example":"Network adapter 1=Compute-121"},"description":"Network label assignments on the rds server.","example":"Network adapter 1=Compute-121"},"operating_system":{"type":"string","description":"The machine operating system.Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2012","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operation":{"type":"string","description":"The current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"REFRESH","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"operation_state":{"type":"string","description":"The state of the current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CANCELLING: The operation has been cancelled.\n* COMPLETED: The operation has completed.\n* CREATE: The operation is being initiated.\n* FAULT: The operation has encountered an error.\n* HOLDING: The operation has been paused.\n* PROGRESSING: The operation is in progress.\n* SCHEDULED: The operation is scheduled for future execution.\n* STANDBY: The operation is on standby for a selective resync.\n* UNDEFINED: The operation state is unrecognized.","example":"AVAILABLE","enum":["CANCELLING","COMPLETED","CREATE","FAULT","HOLDING","PROGRESSING","SCHEDULED","STANDBY","UNDEFINED"]},"pending_base_vm_id":{"type":"string","description":"The pending base vm id.<br>Supported Filters : 'Equals'.","example":"vm-8"},"pending_base_vm_snapshot_id":{"type":"string","description":"The pending base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-7"},"pending_image_management_stream_id":{"type":"string","description":"The id of the pending image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25"},"pending_image_management_tag_id":{"type":"string","description":"The id of the pending image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_count":{"type":"integer","description":"RDS server session count.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int32","example":35},"state":{"type":"string","description":"The state of the RDS server.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.\n* AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.\n* AGENT_ERR_DISABLED: The Horizon Agent is disabled.\n* AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.\n* AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.\n* AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.\n* AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.\n* AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* ALREADY_USED: The RDS Server cannot accept new sessions.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The RDS Server is in an active session.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* DISABLED: The RDS Server is disabled.\n* DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\n* ERROR: An unknown error occurred in the RDS Server.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* PROVISIONED: The RDS Server has been provisioned.\n* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNKNOWN: Could not determine the state of the RDS Server.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERR_DISABLED","AGENT_ERR_DOMAIN_FAILURE","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNKNOWN","VALIDATING","WAIT_FOR_AGENT"]}},"description":"Information related to an RDS Server.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"RDSServerInfoV4":{"type":"object","properties":{"access_group_id":{"type":"string","description":"The id of the Access Group that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_data":{"type":"array","description":"List of agents data info\n","deprecated":true,"items":{"$ref":"#/components/schemas/AgentData_RDSServer"}},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the rds server.\nThis property can be used for sorting.","example":"true"},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the rds server.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the rds server.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"base_vm_id":{"type":"string","description":"The base vm id.<br>Supported Filters : 'Equals'.","example":"vm-23"},"base_vm_path":{"type":"string","description":"VM path.","example":"/Datacenter/vm/VMs/Win10"},"base_vm_snapshot_id":{"type":"string","description":"The base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-2"},"base_vm_snapshot_path":{"type":"string","description":"VM snapshot path.","example":"/Snapshot1"},"description":{"type":"string","description":"Description of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"New RDS Server."},"desktop_pool_name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.","example":"sales-pool1"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"The id of the Farm that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"farm_name":{"type":"string","description":"Name of the Farm. The maximum length is 64 characters.Supported Filters: 'Equals', 'StartsWith', 'EndsWith', 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm1"},"id":{"type":"string","description":"Unique ID representing the RDS Server.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_management_stream_id":{"type":"string","description":"The id of the image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_stream_name":{"type":"string","description":"Name of the image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"stream-name"},"image_management_tag_id":{"type":"string","description":"The id of the image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"image_management_tag_name":{"type":"string","description":"Name of the image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"tag-name"},"load_index":{"type":"integer","description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.\nThis property can be used for sorting.","format":"int32","example":60},"load_preference":{"type":"string","description":"Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.\nThis property can be used for sorting.\n* BLOCK: RDS Server is blocked and new sessions will not be accepted.\n* HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.\n* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.","example":"NORMAL","enum":["BLOCK","HEAVY","LIGHT","NORMAL","UNKNOWN"]},"logoff_policy":{"type":"string","description":"The user log off behavior at the time of maintenance.\nThis property can be used for sorting.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"max_sessions_count":{"type":"integer","description":"Maximum number of sessions for RDS server as reported by the Horizon Agent. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_type":{"type":"string","description":"RDS Server max sessions type as reported by the Horizon Agent.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"server1"},"network_label_names":{"type":"array","description":"The name of network labels associated to the machine\nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"The name of network labels associated to the machine\nSupported Filters : 'Contains'","example":"datastore-1"}},"network_labels_by_nic":{"type":"object","additionalProperties":{"type":"string","description":"Network label assignments on the rds server.","example":"Network adapter 1=Compute-121"},"description":"Network label assignments on the rds server.","example":"Network adapter 1=Compute-121"},"operating_system":{"type":"string","description":"The machine operating system.Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2012","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operation":{"type":"string","description":"The current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"REFRESH","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"operation_state":{"type":"string","description":"The state of the current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CANCELLING: The operation has been cancelled.\n* COMPLETED: The operation has completed.\n* CREATE: The operation is being initiated.\n* FAULT: The operation has encountered an error.\n* HOLDING: The operation has been paused.\n* PROGRESSING: The operation is in progress.\n* SCHEDULED: The operation is scheduled for future execution.\n* STANDBY: The operation is on standby for a selective resync.\n* UNDEFINED: The operation state is unrecognized.","example":"AVAILABLE","enum":["CANCELLING","COMPLETED","CREATE","FAULT","HOLDING","PROGRESSING","SCHEDULED","STANDBY","UNDEFINED"]},"pending_base_image_path":{"type":"string","description":"The pending base image.","example":"/Datacenter/vm/VMs/Win10"},"pending_base_image_snapshot_path":{"type":"string","description":"The pending base image snapshot.","example":"/Snapshot1"},"pending_base_vm_id":{"type":"string","description":"The pending base vm id.<br>Supported Filters : 'Equals'.","example":"vm-8"},"pending_base_vm_snapshot_id":{"type":"string","description":"The pending base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-7"},"pending_image_management_stream_id":{"type":"string","description":"The id of the pending image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25"},"pending_image_management_stream_name":{"type":"string","description":"Name of the pending image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"stream-name"},"pending_image_management_tag_id":{"type":"string","description":"The id of the pending image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"pending_image_management_tag_name":{"type":"string","description":"Name of the pending image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"tag-name"},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_count":{"type":"integer","description":"RDS server session count.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int32","example":35},"state":{"type":"string","description":"The state of the RDS server.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.\n* AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.\n* AGENT_ERR_DISABLED: The Horizon Agent is disabled.\n* AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.\n* AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.\n* AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.\n* AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.\n* AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* ALREADY_USED: The RDS Server cannot accept new sessions.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The RDS Server is in an active session.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* DISABLED: The RDS Server is disabled.\n* DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\n* ERROR: An unknown error occurred in the RDS Server.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* PROVISIONED: The RDS Server has been provisioned.\n* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNKNOWN: Could not determine the state of the RDS Server.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERR_DISABLED","AGENT_ERR_DOMAIN_FAILURE","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNKNOWN","VALIDATING","WAIT_FOR_AGENT"]}},"description":"Information related to an RDS Server.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"RDSServerInfoV5":{"type":"object","properties":{"access_group_id":{"type":"string","description":"The id of the Access Group that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_data":{"type":"array","description":"List of agents data info\n","deprecated":true,"items":{"$ref":"#/components/schemas/AgentData_RDSServer"}},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the rds server.\nThis property can be used for sorting.","example":"true"},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the rds server.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the rds server.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"base_vm_id":{"type":"string","description":"The base vm id.<br>Supported Filters : 'Equals'.","example":"vm-23"},"base_vm_path":{"type":"string","description":"VM path.","example":"/Datacenter/vm/VMs/Win10"},"base_vm_snapshot_id":{"type":"string","description":"The base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-2"},"base_vm_snapshot_path":{"type":"string","description":"VM snapshot path.","example":"/Snapshot1"},"description":{"type":"string","description":"Description of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"New RDS Server."},"desktop_pool_name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.","example":"sales-pool1"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"The id of the Farm that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"farm_name":{"type":"string","description":"Name of the Farm. The maximum length is 64 characters.Supported Filters: 'Equals', 'StartsWith', 'EndsWith', 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm1"},"farm_source":{"type":"string","description":"Source of the Farm.\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* AWS_CORE: The Farm uses AWS core as source for provisioning the machines.\n* PRISM: The Farm uses capacity provider as source for provisioning the RDS servers.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","AWS_CORE","PRISM"]},"farm_type":{"type":"string","description":"Type of the Farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"id":{"type":"string","description":"Unique ID representing the RDS Server.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_management_stream_id":{"type":"string","description":"The id of the image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_stream_name":{"type":"string","description":"Name of the image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"stream-name"},"image_management_tag_id":{"type":"string","description":"The id of the image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"image_management_tag_name":{"type":"string","description":"Name of the image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"tag-name"},"load_index":{"type":"integer","description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.\nThis property can be used for sorting.","format":"int32","example":60},"load_preference":{"type":"string","description":"Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.\nThis property can be used for sorting.\n* BLOCK: RDS Server is blocked and new sessions will not be accepted.\n* HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.\n* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.","example":"NORMAL","enum":["BLOCK","HEAVY","LIGHT","NORMAL","UNKNOWN"]},"logoff_policy":{"type":"string","description":"The user log off behavior at the time of maintenance.\nThis property can be used for sorting.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"max_sessions_count":{"type":"integer","description":"Maximum number of sessions for RDS server as reported by the Horizon Agent. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_type":{"type":"string","description":"RDS Server max sessions type as reported by the Horizon Agent.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"server1"},"network_label_names":{"type":"array","description":"The name of network labels associated to the machine\nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"The name of network labels associated to the machine\nSupported Filters : 'Contains'","example":"datastore-1"}},"network_labels_by_nic":{"type":"object","additionalProperties":{"type":"string","description":"Network label assignments on the rds server.","example":"Network adapter 1=Compute-121"},"description":"Network label assignments on the rds server.","example":"Network adapter 1=Compute-121"},"operating_system":{"type":"string","description":"The machine operating system.Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2012","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operation":{"type":"string","description":"The current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"REFRESH","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"operation_state":{"type":"string","description":"The state of the current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CANCELLING: The operation has been cancelled.\n* COMPLETED: The operation has completed.\n* CREATE: The operation is being initiated.\n* FAULT: The operation has encountered an error.\n* HOLDING: The operation has been paused.\n* PROGRESSING: The operation is in progress.\n* SCHEDULED: The operation is scheduled for future execution.\n* STANDBY: The operation is on standby for a selective resync.\n* UNDEFINED: The operation state is unrecognized.","example":"AVAILABLE","enum":["CANCELLING","COMPLETED","CREATE","FAULT","HOLDING","PROGRESSING","SCHEDULED","STANDBY","UNDEFINED"]},"pending_base_image_path":{"type":"string","description":"The pending base image.","example":"/Datacenter/vm/VMs/Win10"},"pending_base_image_snapshot_path":{"type":"string","description":"The pending base image snapshot.","example":"/Snapshot1"},"pending_base_vm_id":{"type":"string","description":"The pending base vm id.<br>Supported Filters : 'Equals'.","example":"vm-8"},"pending_base_vm_snapshot_id":{"type":"string","description":"The pending base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-7"},"pending_image_management_stream_id":{"type":"string","description":"The id of the pending image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25"},"pending_image_management_stream_name":{"type":"string","description":"Name of the pending image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"stream-name"},"pending_image_management_tag_id":{"type":"string","description":"The id of the pending image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"pending_image_management_tag_name":{"type":"string","description":"Name of the pending image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"tag-name"},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_count":{"type":"integer","description":"RDS server session count.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int32","example":35},"state":{"type":"string","description":"The state of the RDS server.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.\n* AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.\n* AGENT_ERR_DISABLED: The Horizon Agent is disabled.\n* AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.\n* AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.\n* AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.\n* AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.\n* AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* ALREADY_USED: The RDS Server cannot accept new sessions.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The RDS Server is in an active session.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* DISABLED: The RDS Server is disabled.\n* DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\n* ERROR: An unknown error occurred in the RDS Server.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* PROVISIONED: The RDS Server has been provisioned.\n* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNKNOWN: Could not determine the state of the RDS Server.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERR_DISABLED","AGENT_ERR_DOMAIN_FAILURE","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNKNOWN","VALIDATING","WAIT_FOR_AGENT"]}},"description":"Information related to an RDS Server.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"RDSServerInfoV6":{"type":"object","properties":{"access_group_id":{"type":"string","description":"The id of the Access Group that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_data":{"type":"array","description":"List of agents data info\n","deprecated":true,"items":{"$ref":"#/components/schemas/AgentData_RDSServer"}},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the rds server.\nThis property can be used for sorting.","example":"true"},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the rds server.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the rds server.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"appv_agent_upgrade_error_message":{"type":"string","description":"Error message of the AppVolumes Agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"appv_agent_version_build":{"type":"string","description":"AppVolumes Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"appv_has_new_agent_version":{"type":"boolean","description":"newer AppVolumes agent version is available","example":true},"appv_last_update_date_time":{"type":"string","description":"Date of the last AppVolumes Agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"appv_upgrade_result":{"type":"string","description":"Result of the AppVolumes Agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"appv_upgrade_state":{"type":"string","description":"State of the AppVolumes Agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"base_vm_id":{"type":"string","description":"The base vm id.<br>Supported Filters : 'Equals'.","example":"vm-23"},"base_vm_path":{"type":"string","description":"VM path.","example":"/Datacenter/vm/VMs/Win10"},"base_vm_snapshot_id":{"type":"string","description":"The base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-2"},"base_vm_snapshot_path":{"type":"string","description":"VM snapshot path.","example":"/Snapshot1"},"deem_agent_upgrade_error_message":{"type":"string","description":"Error message of the DEEM Agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"deem_agent_version_build":{"type":"string","description":"DEEM Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"deem_has_new_agent_version":{"type":"boolean","description":"newer DEEM agent version is available","example":true},"deem_last_update_date_time":{"type":"string","description":"Date of the last DEEM Agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"deem_upgrade_result":{"type":"string","description":"Result of the DEEM Agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"deem_upgrade_state":{"type":"string","description":"State of the DEEM Agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"dem_agent_upgrade_error_message":{"type":"string","description":"Error message of the DEM Agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"dem_agent_version_build":{"type":"string","description":"DEM Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"dem_has_new_agent_version":{"type":"boolean","description":"newer DEM agent version is available","example":true},"dem_last_update_date_time":{"type":"string","description":"Date of the last DEM Agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"dem_upgrade_result":{"type":"string","description":"Result of the DEM Agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"dem_upgrade_state":{"type":"string","description":"State of the DEM Agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"description":{"type":"string","description":"Description of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"New RDS Server."},"desktop_pool_name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.","example":"sales-pool1"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"The id of the Farm that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"farm_name":{"type":"string","description":"Name of the Farm. The maximum length is 64 characters.Supported Filters: 'Equals', 'StartsWith', 'EndsWith', 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm1"},"farm_source":{"type":"string","description":"Source of the Farm.\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* AWS_CORE: The Farm uses AWS core as source for provisioning the machines.\n* PRISM: The Farm uses capacity provider as source for provisioning the RDS servers.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","AWS_CORE","PRISM"]},"farm_type":{"type":"string","description":"Type of the Farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"hze_agent_upgrade_error_message":{"type":"string","description":"Error message of the Horizon Agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"hze_agent_version_build":{"type":"string","description":"Horizon Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"hze_has_new_agent_version":{"type":"boolean","description":"newer agent version is available","example":true},"hze_last_update_date_time":{"type":"string","description":"Date of the last Horizon Agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"hze_upgrade_result":{"type":"string","description":"Result of the Horizon Agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"hze_upgrade_state":{"type":"string","description":"State of the Horizon Agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"id":{"type":"string","description":"Unique ID representing the RDS Server.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_management_stream_id":{"type":"string","description":"The id of the image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_stream_name":{"type":"string","description":"Name of the image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"stream-name"},"image_management_tag_id":{"type":"string","description":"The id of the image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"image_management_tag_name":{"type":"string","description":"Name of the image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"tag-name"},"load_index":{"type":"integer","description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.\nThis property can be used for sorting.","format":"int32","example":60},"load_preference":{"type":"string","description":"Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.\nThis property can be used for sorting.\n* BLOCK: RDS Server is blocked and new sessions will not be accepted.\n* HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.\n* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.","example":"NORMAL","enum":["BLOCK","HEAVY","LIGHT","NORMAL","UNKNOWN"]},"logoff_policy":{"type":"string","description":"The user log off behavior at the time of maintenance.\nThis property can be used for sorting.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"max_sessions_count":{"type":"integer","description":"Maximum number of sessions for RDS server as reported by the Horizon Agent. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_type":{"type":"string","description":"RDS Server max sessions type as reported by the Horizon Agent.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"server1"},"network_label_names":{"type":"array","description":"The name of network labels associated to the machine\nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"The name of network labels associated to the machine\nSupported Filters : 'Contains'","example":"datastore-1"}},"network_labels_by_nic":{"type":"object","additionalProperties":{"type":"string","description":"Network label assignments on the rds server.","example":"Network adapter 1=Compute-121"},"description":"Network label assignments on the rds server.","example":"Network adapter 1=Compute-121"},"operating_system":{"type":"string","description":"The machine operating system.Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2012","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operation":{"type":"string","description":"The current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"REFRESH","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"operation_state":{"type":"string","description":"The state of the current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CANCELLING: The operation has been cancelled.\n* COMPLETED: The operation has completed.\n* CREATE: The operation is being initiated.\n* FAULT: The operation has encountered an error.\n* HOLDING: The operation has been paused.\n* PROGRESSING: The operation is in progress.\n* SCHEDULED: The operation is scheduled for future execution.\n* STANDBY: The operation is on standby for a selective resync.\n* UNDEFINED: The operation state is unrecognized.","example":"AVAILABLE","enum":["CANCELLING","COMPLETED","CREATE","FAULT","HOLDING","PROGRESSING","SCHEDULED","STANDBY","UNDEFINED"]},"pending_base_image_path":{"type":"string","description":"The pending base image.","example":"/Datacenter/vm/VMs/Win10"},"pending_base_image_snapshot_path":{"type":"string","description":"The pending base image snapshot.","example":"/Snapshot1"},"pending_base_vm_id":{"type":"string","description":"The pending base vm id.<br>Supported Filters : 'Equals'.","example":"vm-8"},"pending_base_vm_snapshot_id":{"type":"string","description":"The pending base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-7"},"pending_image_management_stream_id":{"type":"string","description":"The id of the pending image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25"},"pending_image_management_stream_name":{"type":"string","description":"Name of the pending image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"stream-name"},"pending_image_management_tag_id":{"type":"string","description":"The id of the pending image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"pending_image_management_tag_name":{"type":"string","description":"Name of the pending image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"tag-name"},"re_agent_version":{"type":"string","description":"Remote Experience Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_count":{"type":"integer","description":"RDS server session count.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int32","example":35},"state":{"type":"string","description":"The state of the RDS server.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.\n* AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.\n* AGENT_ERR_DISABLED: The Horizon Agent is disabled.\n* AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.\n* AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.\n* AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.\n* AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.\n* AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* ALREADY_USED: The RDS Server cannot accept new sessions.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The RDS Server is in an active session.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* DISABLED: The RDS Server is disabled.\n* DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\n* ERROR: An unknown error occurred in the RDS Server.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* PROVISIONED: The RDS Server has been provisioned.\n* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNKNOWN: Could not determine the state of the RDS Server.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERR_DISABLED","AGENT_ERR_DOMAIN_FAILURE","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNKNOWN","VALIDATING","WAIT_FOR_AGENT"]}},"description":"Information related to a Machine.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"RDSServerInfoV7":{"type":"object","properties":{"access_group_id":{"type":"string","description":"The id of the Access Group that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"agent_build_number":{"type":"string","description":"The Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"22673015","deprecated":true},"agent_data":{"type":"array","description":"List of agents data info\n","deprecated":true,"items":{"$ref":"#/components/schemas/AgentData_RDSServer"}},"agent_ipv4_address":{"type":"string","description":"The agent ipv4 address.","example":"192.168.1.1"},"agent_ipv6_address":{"type":"string","description":"The agent ipv6 address.","example":"2001:db8:3333:4444:5555:6666:7777:8888"},"agent_upgrade_error_message":{"type":"string","description":"Error message of the agent upgrade operation failure on the rds server.\nThis property can be used for sorting.","example":"true"},"agent_upgrade_result":{"type":"string","description":"Result of the agent upgrade operation on the rds server.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"agent_upgrade_state":{"type":"string","description":"State of the agent upgrade operation on the rds server.\nThis property can be used for sorting.\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"WAIT","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"agent_version":{"type":"string","description":"The Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"appv_agent_upgrade_error_message":{"type":"string","description":"Error message of the AppVolumes Agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"appv_agent_version_build":{"type":"string","description":"AppVolumes Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"appv_has_new_agent_version":{"type":"boolean","description":"newer AppVolumes agent version is available","example":true},"appv_last_update_date_time":{"type":"string","description":"Date of the last AppVolumes Agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"appv_upgrade_result":{"type":"string","description":"Result of the AppVolumes Agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"appv_upgrade_state":{"type":"string","description":"State of the AppVolumes Agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"base_vm_id":{"type":"string","description":"The base vm id.<br>Supported Filters : 'Equals'.","example":"vm-23"},"base_vm_path":{"type":"string","description":"VM path.","example":"/Datacenter/vm/VMs/Win10"},"base_vm_snapshot_id":{"type":"string","description":"The base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-2"},"base_vm_snapshot_path":{"type":"string","description":"VM snapshot path.","example":"/Snapshot1"},"deem_agent_upgrade_error_message":{"type":"string","description":"Error message of the DEEM Agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"deem_agent_version_build":{"type":"string","description":"DEEM Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"deem_has_new_agent_version":{"type":"boolean","description":"newer DEEM agent version is available","example":true},"deem_last_update_date_time":{"type":"string","description":"Date of the last DEEM Agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"deem_upgrade_result":{"type":"string","description":"Result of the DEEM Agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"deem_upgrade_state":{"type":"string","description":"State of the DEEM Agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"dem_agent_upgrade_error_message":{"type":"string","description":"Error message of the DEM Agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"dem_agent_version_build":{"type":"string","description":"DEM Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"dem_has_new_agent_version":{"type":"boolean","description":"newer DEM agent version is available","example":true},"dem_last_update_date_time":{"type":"string","description":"Date of the last DEM Agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"dem_upgrade_result":{"type":"string","description":"Result of the DEM Agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"dem_upgrade_state":{"type":"string","description":"State of the DEM Agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"description":{"type":"string","description":"Description of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"New RDS Server."},"desktop_pool_name":{"type":"string","description":"Name of the Desktop Pool. The maximum length is 64 characters.","example":"sales-pool1"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":true},"farm_id":{"type":"string","description":"The id of the Farm that the RDS Server belongs to.<br>Supported Filters : 'Equals'.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"farm_name":{"type":"string","description":"Name of the Farm. The maximum length is 64 characters.Supported Filters: 'Equals', 'StartsWith', 'EndsWith', 'Contains'.\nThis property can be used for sorting.","example":"ManualFarm1"},"farm_source":{"type":"string","description":"Source of the Farm.\n* INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.\n* AWS_CORE: The Farm uses AWS core as source for provisioning the machines.\n* PRISM: The Farm uses capacity provider as source for provisioning the RDS servers.","example":"INSTANT_CLONE","enum":["INSTANT_CLONE","LINKED_CLONE","AWS_CORE","PRISM"]},"farm_type":{"type":"string","description":"Type of the Farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","example":"MANUAL","enum":["AUTOMATED","MANUAL"]},"hze_agent_upgrade_error_message":{"type":"string","description":"Error message of the Horizon Agent upgrade operation failure on the machine.\nThis property can be used for sorting.","example":"true"},"hze_agent_version_build":{"type":"string","description":"Horizon Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"hze_has_new_agent_version":{"type":"boolean","description":"newer agent version is available","example":true},"hze_last_update_date_time":{"type":"string","description":"Date of the last Horizon Agent upgrade operation on the machine","example":"12 Dec 2024 13:02"},"hze_upgrade_result":{"type":"string","description":"Result of the Horizon Agent upgrade operation on the machine.\nThis property can be used for sorting.\n* DUPLICATE: Agent received duplicate upgrade request.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* NOT_FOUND: Agent could not find upgrade request.\n* OK: Agent upgrade is OK.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHT_ERR_INVALID_UNC_PATH: Invalid or unreachable installer UNC path. Check access from the agent machine.\n* PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE: Insufficient disk space on target device. Free space and retry.\n* PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS: Windows Update in progress. Try again later.\n* PREFLIGHT_ERR_REBOOT_PENDING: Pending reboot detected. Restart system and then retry.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PROGRESS: Agent upgrade is in progress.\n* UNKNOWN: Agent upgrade result is unknown.","example":"OK","enum":["DUPLICATE","ERROR","FAILURE","INVALID","NOT_FOUND","OK","PREFLIGHTCHECK_FAILURE","PREFLIGHTCHECK_INPROGRESS","PREFLIGHT_ERR_INVALID_UNC_PATH","PREFLIGHT_ERR_INSUFFICIENT_DISKSPACE","PREFLIGHT_ERR_WIN_UPDATE_INPROGRESS","PREFLIGHT_ERR_REBOOT_PENDING","PREFLIGHTCHECK_OK","PROGRESS","UNKNOWN"]},"hze_upgrade_state":{"type":"string","description":"State of the Horizon Agent upgrade operation on the machine\n* DONE: Agent upgrade task has ended.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* NOLOGON: Agent has no logged in user.\n* READY: Agent is ready to be upgraded.\n* UNKNOWN: Agent upgrade state is unknown.\n* UPDATING: Agent is upgrading.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.","example":"DOWNLOAD","enum":["DONE","DOWNLOAD","NOLOGON","READY","UNKNOWN","UPDATING","WAIT"]},"id":{"type":"string","description":"Unique ID representing the RDS Server.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"image_management_stream_id":{"type":"string","description":"The id of the image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"},"image_management_stream_name":{"type":"string","description":"Name of the image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"stream-name"},"image_management_tag_id":{"type":"string","description":"The id of the image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"image_management_tag_name":{"type":"string","description":"Name of the image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"tag-name"},"load_index":{"type":"integer","description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.\nThis property can be used for sorting.","format":"int32","example":60},"load_preference":{"type":"string","description":"Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.\nThis property can be used for sorting.\n* BLOCK: RDS Server is blocked and new sessions will not be accepted.\n* HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.\n* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.","example":"NORMAL","enum":["BLOCK","HEAVY","LIGHT","NORMAL","UNKNOWN"]},"logoff_policy":{"type":"string","description":"The user log off behavior at the time of maintenance.\nThis property can be used for sorting.\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"max_sessions_count":{"type":"integer","description":"Maximum number of sessions for RDS server as reported by the Horizon Agent. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_type":{"type":"string","description":"RDS Server max sessions type as reported by the Horizon Agent.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"message_security_enhanced_mode_supported":{"type":"boolean","description":"Indicates whether ENHANCED message security mode is currently supported by this machine.\nThis property can be used for sorting.","example":true},"message_security_mode":{"type":"string","description":"The current JMS message security mode used by this machine.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"MIXED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"name":{"type":"string","description":"Name of the RDS Server.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"server1"},"network_label_names":{"type":"array","description":"The name of network labels associated to the machine\nSupported Filters : 'Contains'","example":"datastore-1","items":{"type":"string","description":"The name of network labels associated to the machine\nSupported Filters : 'Contains'","example":"datastore-1"}},"network_labels_by_nic":{"type":"object","additionalProperties":{"type":"string","description":"Network label assignments on the rds server.","example":"Network adapter 1=Compute-121"},"description":"Network label assignments on the rds server.","example":"Network adapter 1=Compute-121"},"operating_system":{"type":"string","description":"The machine operating system.Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2012","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"operation":{"type":"string","description":"The current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* ARCHIVE: An archive operation.\n* ATTACH: A persistent disk attach operation.\n* DETACH: A persistent disk detach operation.\n* PUSH_IMAGE: A push image operation.\n* TAGGING: A tagging operation.","example":"REFRESH","enum":["ARCHIVE","ATTACH","DETACH","PUSH_IMAGE","TAGGING"]},"operation_state":{"type":"string","description":"The state of the current maintenance operation on the RDS Server.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* CANCELLING: The operation has been cancelled.\n* COMPLETED: The operation has completed.\n* CREATE: The operation is being initiated.\n* FAULT: The operation has encountered an error.\n* HOLDING: The operation has been paused.\n* PROGRESSING: The operation is in progress.\n* SCHEDULED: The operation is scheduled for future execution.\n* STANDBY: The operation is on standby for a selective resync.\n* UNDEFINED: The operation state is unrecognized.","example":"AVAILABLE","enum":["CANCELLING","COMPLETED","CREATE","FAULT","HOLDING","PROGRESSING","SCHEDULED","STANDBY","UNDEFINED"]},"pending_base_image_path":{"type":"string","description":"The pending base image.","example":"/Datacenter/vm/VMs/Win10"},"pending_base_image_snapshot_path":{"type":"string","description":"The pending base image snapshot.","example":"/Snapshot1"},"pending_base_vm_id":{"type":"string","description":"The pending base vm id.<br>Supported Filters : 'Equals'.","example":"vm-8"},"pending_base_vm_snapshot_id":{"type":"string","description":"The pending base vm snapshot id.<br>Supported Filters : 'Equals'.","example":"snapshot-7"},"pending_image_management_stream_id":{"type":"string","description":"The id of the pending image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25"},"pending_image_management_stream_name":{"type":"string","description":"Name of the pending image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"stream-name"},"pending_image_management_tag_id":{"type":"string","description":"The id of the pending image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.<br>Supported Filters : 'Equals'.","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d"},"pending_image_management_tag_name":{"type":"string","description":"Name of the pending image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.","example":"tag-name"},"re_agent_version":{"type":"string","description":"Remote Experience Agent version with build number\nThis property can be used for sorting.","example":"1.2.0-4550392"},"remote_experience_agent_build_number":{"type":"string","description":"The remote experience Horizon Agent build number.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"32573985","deprecated":true},"remote_experience_agent_version":{"type":"string","description":"The remote experience Horizon Agent version.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12","deprecated":true},"session_count":{"type":"integer","description":"RDS server session count.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int32","example":35},"state":{"type":"string","description":"The state of the RDS server.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.\n* AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.\n* AGENT_ERR_DISABLED: The Horizon Agent is disabled.\n* AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.\n* AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.\n* AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.\n* AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.\n* AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* ALREADY_USED: The RDS Server cannot accept new sessions.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The RDS Server is in an active session.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* DISABLED: The RDS Server is disabled.\n* DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\n* ERROR: An unknown error occurred in the RDS Server.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* PROVISIONED: The RDS Server has been provisioned.\n* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNKNOWN: Could not determine the state of the RDS Server.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERR_DISABLED","AGENT_ERR_DOMAIN_FAILURE","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNKNOWN","VALIDATING","WAIT_FOR_AGENT"]}},"description":"Information related to an RDS Server.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"RDSServerMonitorDetails":{"type":"object","properties":{"agent_build":{"type":"string","description":"Agent build number.","example":"4445678"},"agent_version":{"type":"string","description":"Agent version.","example":"7.9.0"},"max_sessions_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. Will be unset if the value is not configured.","format":"int32","example":123},"operating_system":{"type":"string","description":"Operating System version.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2016","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"state":{"type":"string","description":"State of RDS Server.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.\n* AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.\n* AGENT_ERR_DISABLED: The Horizon Agent is disabled.\n* AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.\n* AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.\n* AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.\n* AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.\n* AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* ALREADY_USED: The RDS Server cannot accept new sessions.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The RDS Server is in an active session.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* DISABLED: The RDS Server is disabled.\n* DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\n* ERROR: An unknown error occurred in the RDS Server.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* PROVISIONED: The RDS Server has been provisioned.\n* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNKNOWN: Could not determine the state of the RDS Server.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERR_DISABLED","AGENT_ERR_DOMAIN_FAILURE","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNKNOWN","VALIDATING","WAIT_FOR_AGENT"]}},"description":"Details of RDS Server."},"RDSServerMonitorDetailsV2":{"type":"object","properties":{"agent_build":{"type":"string","description":"Agent build number.","example":"4445678"},"agent_version":{"type":"string","description":"Agent version.","example":"7.9.0"},"max_sessions_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. Will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"operating_system":{"type":"string","description":"Operating System version.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2016","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"state":{"type":"string","description":"State of RDS Server.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.\n* AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.\n* AGENT_ERR_DISABLED: The Horizon Agent is disabled.\n* AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.\n* AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.\n* AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.\n* AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.\n* AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* ALREADY_USED: The RDS Server cannot accept new sessions.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The RDS Server is in an active session.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* DISABLED: The RDS Server is disabled.\n* DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\n* ERROR: An unknown error occurred in the RDS Server.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* PROVISIONED: The RDS Server has been provisioned.\n* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNKNOWN: Could not determine the state of the RDS Server.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERR_DISABLED","AGENT_ERR_DOMAIN_FAILURE","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNKNOWN","VALIDATING","WAIT_FOR_AGENT"]}},"description":"Details of RDS Server."},"RDSServerMonitorDetailsV3":{"type":"object","properties":{"agent_build":{"type":"string","description":"Agent build number.","example":"4445678"},"agent_version":{"type":"string","description":"Agent version.","example":"7.9.0"},"max_sessions_count":{"type":"integer","description":"Maximum number of sessions for RDS server as reported by the Horizon Agent. This will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_count_configured":{"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator. Will be unset if the value is not configured.","format":"int32","example":123},"max_sessions_type":{"type":"string","description":"RDS Server max sessions type as reported by the Horizon Agent.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.","example":"LIMITED","enum":["UNLIMITED","LIMITED"]},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"operating_system":{"type":"string","description":"Operating System version.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2016","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]},"state":{"type":"string","description":"State of RDS Server.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.\n* AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.\n* AGENT_ERR_DISABLED: The Horizon Agent is disabled.\n* AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.\n* AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.\n* AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.\n* AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.\n* AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.\n* AGENT_ERROR_WAIT_FOR_HYBRID_JOIN: Horizon Agent has started on the machine, but is waiting for hybrid domain join.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* ALREADY_USED: The RDS Server cannot accept new sessions.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\n* BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.\n* CONNECTED: The RDS Server is in an active session.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* DISABLED: The RDS Server is disabled.\n* DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\n* ERROR: An unknown error occurred in the RDS Server.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* PROVISIONED: The RDS Server has been provisioned.\n* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* UNKNOWN: Could not determine the state of the RDS Server.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.","example":"AVAILABLE","enum":["AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","AGENT_ERR_DISABLED","AGENT_ERR_DOMAIN_FAILURE","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERROR_WAIT_FOR_HYBRID_JOIN","AGENT_UNREACHABLE","ALREADY_USED","AVAILABLE","BLOCKED_AGENT_VERSION","CONNECTED","CUSTOMIZING","DELETING","DISABLED","DISABLE_IN_PROGRESS","DISCONNECTED","ERROR","IN_PROGRESS","MAINTENANCE","PROVISIONED","PROVISIONING","PROVISIONING_ERROR","UNKNOWN","VALIDATING","WAIT_FOR_AGENT"]}},"description":"Details of RDS Server."},"RDSServerMonitorInfo":{"type":"object","properties":{"details":{"$ref":"#/components/schemas/RDSServerMonitorDetails"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.","example":true},"farm_id":{"type":"string","description":"Indicates the Farm ID to which the RDS Server belongs to.Supported Filters : 'Equals'.<br>","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"id":{"type":"string","description":"Unique ID of the RDS server.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"load_index":{"maximum":100,"minimum":0,"type":"integer","description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.","format":"int32","example":60},"load_preference":{"type":"string","description":"Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.\n* BLOCK: RDS Server is blocked and new sessions will not be accepted.\n* HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.\n* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.","example":"NORMAL","enum":["BLOCK","HEAVY","LIGHT","NORMAL","UNKNOWN"]},"name":{"type":"string","description":"RDS Server name.Supported Filters : 'Equals', 'StartsWith'.<br>","example":"rds-server.example.com"},"session_count":{"minimum":0,"type":"integer","description":"RDS server session count.","format":"int32","example":35},"status":{"type":"string","description":"RDS server status.\n* OK: RDS Server is reachable. All applications (defined on its farm) are verified installed on the RDS Server.\n* WARNING: RDS Server is reachable. Some applications are detected as not installed on the RDS Server.\n* ERROR: RDS Server is unreachable, or, none of the applications are installed.\n* DISABLED: RDS Server is disabled.","example":"OK","enum":["OK","WARNING","ERROR","DISABLED"]}},"description":"RDS Server Monitor Information.<br>List API returning this summary information can use filter query to filter on specific fields supported by filters.<br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains', 'EndsWith'.<br>See the field description to know the filter types it supports."},"RDSServerMonitorInfoV2":{"type":"object","properties":{"details":{"$ref":"#/components/schemas/RDSServerMonitorDetails"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.","example":true},"farm_id":{"type":"string","description":"Indicates the Farm ID to which the RDS Server belongs to.Supported Filters : 'Equals'.<br>","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"id":{"type":"string","description":"Unique ID of the RDS server.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"load_index":{"maximum":100,"minimum":0,"type":"integer","description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.","format":"int32","example":60},"load_preference":{"type":"string","description":"Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.\n* BLOCK: RDS Server is blocked and new sessions will not be accepted.\n* HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.\n* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.","example":"NORMAL","enum":["BLOCK","HEAVY","LIGHT","NORMAL","UNKNOWN"]},"missing_application_infos":{"type":"array","description":"Information for those application which are missing on associated rds server","items":{"$ref":"#/components/schemas/FarmHealthMissingApplicationInfo"}},"name":{"type":"string","description":"RDS Server name.Supported Filters : 'Equals', 'StartsWith'.<br>","example":"rds-server.example.com"},"session_count":{"minimum":0,"type":"integer","description":"RDS server session count.","format":"int32","example":35},"status":{"type":"string","description":"RDS server status.\n* OK: RDS Server is reachable. All applications (defined on its farm) are verified installed on the RDS Server.\n* WARNING: RDS Server is reachable. Some applications are detected as not installed on the RDS Server.\n* ERROR: RDS Server is unreachable, or, none of the applications are installed.\n* DISABLED: RDS Server is disabled.","example":"OK","enum":["OK","WARNING","ERROR","DISABLED"]}},"description":"RDS Server Monitor Information.<br>List API returning this summary information can use filter query to filter on specific fields supported by filters.<br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains', 'EndsWith'.<br>See the field description to know the filter types it supports."},"RDSServerMonitorInfoV3":{"type":"object","properties":{"details_v2":{"$ref":"#/components/schemas/RDSServerMonitorDetailsV2"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.","example":true},"farm_id":{"type":"string","description":"Indicates the Farm ID to which the RDS Server belongs to.Supported Filters : 'Equals'.<br>","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"id":{"type":"string","description":"Unique ID of the RDS server.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"load_index":{"maximum":100,"minimum":0,"type":"integer","description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.","format":"int32","example":60},"load_preference":{"type":"string","description":"Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.\n* BLOCK: RDS Server is blocked and new sessions will not be accepted.\n* HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.\n* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.","example":"NORMAL","enum":["BLOCK","HEAVY","LIGHT","NORMAL","UNKNOWN"]},"missing_application_infos":{"type":"array","description":"Information for those application which are missing on associated rds server","items":{"$ref":"#/components/schemas/FarmHealthMissingApplicationInfo"}},"name":{"type":"string","description":"RDS Server name.Supported Filters : 'Equals', 'StartsWith'.<br>","example":"rds-server.example.com"},"session_count":{"minimum":0,"type":"integer","description":"RDS server session count.","format":"int32","example":35},"status":{"type":"string","description":"RDS server status.\n* OK: RDS Server is reachable. All applications (defined on its farm) are verified installed on the RDS Server.\n* WARNING: RDS Server is reachable. Some applications are detected as not installed on the RDS Server.\n* ERROR: RDS Server is unreachable, or, none of the applications are installed.\n* DISABLED: RDS Server is disabled.","example":"OK","enum":["OK","WARNING","ERROR","DISABLED"]}},"description":"RDS Server Monitor Information.<br>List API returning this summary information can use filter query to filter on specific fields supported by filters.<br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains', 'EndsWith'.<br>See the field description to know the filter types it supports."},"RDSServerMonitorInfoV4":{"type":"object","properties":{"details_v3":{"$ref":"#/components/schemas/RDSServerMonitorDetailsV3"},"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.","example":true},"farm_id":{"type":"string","description":"Indicates the Farm ID to which the RDS Server belongs to.Supported Filters : 'Equals'.<br>","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"id":{"type":"string","description":"Unique ID of the RDS server.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"load_index":{"maximum":100,"minimum":0,"type":"integer","description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.","format":"int32","example":60},"load_preference":{"type":"string","description":"Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.\n* BLOCK: RDS Server is blocked and new sessions will not be accepted.\n* HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.\n* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.","example":"NORMAL","enum":["BLOCK","HEAVY","LIGHT","NORMAL","UNKNOWN"]},"missing_application_infos":{"type":"array","description":"Information for those application which are missing on associated rds server","items":{"$ref":"#/components/schemas/FarmHealthMissingApplicationInfo"}},"name":{"type":"string","description":"RDS Server name.Supported Filters : 'Equals', 'StartsWith'.<br>","example":"rds-server.example.com"},"session_count":{"minimum":0,"type":"integer","description":"RDS server session count.","format":"int32","example":35},"status":{"type":"string","description":"RDS server status.\n* OK: RDS Server is reachable. All applications (defined on its farm) are verified installed on the RDS Server.\n* WARNING: RDS Server is reachable. Some applications are detected as not installed on the RDS Server.\n* ERROR: RDS Server is unreachable, or, none of the applications are installed.\n* DISABLED: RDS Server is disabled.","example":"OK","enum":["OK","WARNING","ERROR","DISABLED"]}},"description":"RDS Server Monitor Information.<br>List API returning this summary information can use filter query to filter on specific fields supported by filters.<br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains', 'EndsWith'.<br>See the field description to know the filter types it supports."},"RDSServerRegisterInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID representing the RDS Server.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"pairing_token":{"type":"string","description":"The pairing token for the RDS Server.","example":"<agent.pairing.token>"}},"description":"RDS Server register response."},"RDSServerRegisterSpec":{"required":["dns_name","operating_system"],"type":"object","properties":{"description":{"pattern":"[\\p{Graph}\\p{Blank}]+","type":"string","description":"An optional string to describe how and why this RDS Server was registered.","example":"New RDS Server"},"dns_name":{"maxLength":256,"minLength":1,"type":"string","description":"The DNS name for the RDS Server.","example":"rdsserver1.example.com"},"farm_id":{"type":"string","description":"The farm to which the RDS Server will be added.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"operating_system":{"type":"string","description":"The Operating System of the RDS Server.\n* LINUX_SERVER_OTHER: Linux Server (other)\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above","example":"WINDOWS_SERVER_2012","enum":["LINUX_SERVER_OTHER","UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE"]}},"description":"The specification for registering the RDS Server."},"RDSServerStateCountMetrics":{"type":"object","properties":{"prepared_count":{"$ref":"#/components/schemas/PreparedCountMetrics"},"problem_count":{"$ref":"#/components/schemas/ProblemCountMetrics"},"under_construction_count":{"$ref":"#/components/schemas/UnderConstructionCountMetrics"}},"description":"Counters for various RDS Server Machine states"},"RDSServerUpdateSpec":{"required":["enabled","max_sessions_type_configured"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates if RDS server is enabled.","example":true},"max_sessions_count_configured":{"minimum":1,"type":"integer","description":"Maximum number of sessions for RDS server as configured by administrator.","format":"int32","example":123},"max_sessions_type_configured":{"type":"string","description":"The configured RDS Server max sessions type.\n* UNLIMITED: The RDS Server has an unlimited number of sessions.\n* LIMITED: The RDS Server has a limited number of sessions.\n* UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.","example":"LIMITED","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]}},"description":"The specification for updating the RDS Server."},"RecurringMaintenanceSettings":{"type":"object","properties":{"maintenance_period":{"type":"string","description":"Settings for recurring maintenance operations\n* DAILY: Daily recurring maintenance\n* WEEKLY: Weekly recurring maintenance\n* MONTHLY: Monthly recurring maintenance","example":"DAILY","enum":["DAILY","WEEKLY","MONTHLY"]},"maintenance_period_frequency":{"type":"integer","description":"Indicates frequency of repeating maintenance and is expressed as a multiple of the maintenance_period","format":"int32","example":10},"start_index":{"type":"integer","description":"Start index for weekly or monthly maintenance. Weekly: 1-7 (Sun-Sat), Monthly: 1-31. This is set when maintenance_period is WEEKLY or MONTHLY","format":"int32","example":1},"start_time":{"type":"string","description":"Start time configured for the recurring maintenance. This is in the form hh:mm in 24 hours format","example":"10:00"}},"description":"Recurring maintenance settings"},"RefreshToken":{"required":["refresh_token"],"type":"object","properties":{"refresh_token":{"type":"string","description":"Refresh Token to be used to get a new Access token.","example":"<jwt.refresh.token>"}},"description":"Refresh token needed for Logout"},"RemoteApplicationPairingModeInfo":{"type":"object","properties":{"remote_application_s4b_pairing_mode":{"type":"string","description":"Pairing mode configuration for Remote Application with Skype for Business.","example":"S4B_PAIRING_ENABLED"}},"description":"Information about Remote Application pairing mode."},"RemoteApplicationPerformanceInfo":{"type":"object","properties":{"description":{"type":"string","description":"The description of a remote application.","example":"notepad.exe"},"name":{"type":"string","description":"The name of a remote application.","example":"notepad"},"process_id":{"type":"integer","description":"The process Id.","format":"int64","example":1652079},"remote_application_id":{"type":"string","description":"The identity of an application.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"status":{"type":"string","description":"The status of a remote application.\n* RUNNING: The remote application is working properly.\n* NOT_RESPONDING: The remote application is working properly.\n* UNKNOWN: The remote application is working properly.","example":"RUNNING","enum":["RUNNING","NOT_RESPONDING","UNKNOWN"]}},"description":"Information about Remote Application performance."},"RemoteAssistantTicketInfo":{"type":"object","properties":{"ticket":{"type":"string","description":"The Microsoft Remote Assistant ticket.","example":"SessionNTA4MmI3ODgtNmU4NC00Y2YwLWI4ZDItNjMDQ1NTIwZ"}},"description":"Information about The Microsoft Remote Assistant ticket."},"RemoteProcessSpec":{"required":["create_time_stamp","name","process_id"],"type":"object","properties":{"create_time_stamp":{"type":"integer","description":"The process creation time stamp.","format":"int64","example":1687202598},"name":{"type":"string","description":"The name of the process","example":"svchost.exe"},"process_id":{"type":"integer","description":"The process id.","format":"int64","example":1636}},"description":"The specification to end the remote process."},"ResourceContainerInfo":{"type":"object","properties":{"additional_details":{"type":"object","description":"Additional details of the resource container","example":"{\n   \"Used_For\": \"Networks\",\n   \"CREATED_DATE\": \"04-11-2024\",\n}"},"description":{"type":"string","description":"Resource container description.","example":"Resource container for networks"},"id":{"type":"string","description":"Unique identifier for the resource container.","example":"00061d88-9491-eff9-43cf-246e967105e0"},"name":{"type":"string","description":"resource container name","example":"cluster-1"}},"description":"Information related to capacity provider's resource container like cluster/host/vdc."},"ResourcePoliciesInfo":{"type":"object","properties":{"effective_policies":{"$ref":"#/components/schemas/PoliciesSettings"},"resource_policies":{"$ref":"#/components/schemas/PoliciesSettings"}},"description":"Information related to Desktop Pool Policies."},"ResourcePoolInfo":{"type":"object","properties":{"children":{"type":"array","description":"Child nodes of the resource pool.","items":{"$ref":"#/components/schemas/ResourcePoolInfo"}},"id":{"type":"string","description":"Unique ID representing the resource pool.","example":"resgroup-1"},"name":{"type":"string","description":"Resource pool name.","example":"RP1"},"path":{"type":"string","description":"Resource pool path.","example":"/Datacenter/host/Cluster/Resources/RP1"},"type":{"type":"string","description":"Resource pool type.\n* HOST: Host used as a resource pool suitable for use in desktop pool/farm.\n* CLUSTER: Cluster used as a resource pool suitable for use in desktop pool/farm.\n* RESOURCE_POOL: Regular resource pool suitable for use in desktop pool/farm.\n* OTHER: Other resource type which cannot be used in desktop pool/farm.","example":"RESOURCE_POOL","enum":["HOST","CLUSTER","RESOURCE_POOL","OTHER"]}},"description":"Information related to resource pool."},"RestrictedAgentInfo":{"type":"object","properties":{"block_specific_versions":{"uniqueItems":true,"type":"array","description":"Blocks specific versions of Horizon Agent connections.","example":["7.6,0","8.0.0"],"items":{"type":"string","description":"Blocks specific versions of Horizon Agent connections.","example":"[\"7.6,0\",\"8.0.0\"]"}},"type":{"type":"string","description":"The type of Horizon Agent.\n* WINDOWS: The Agent is the Horizon Agent for Windows.\n* OTHER: Agent type is other.","example":"WINDOWS","enum":["WINDOWS","OTHER"]},"version":{"type":"string","description":"Blocks versions of Horizon Agent connections which are older than the specified version.","example":"7.5.0"}},"description":"Information related to restricted Horizon Agents."},"RestrictedAgentUpdateSpec":{"required":["type"],"type":"object","properties":{"block_specific_versions":{"uniqueItems":true,"type":"array","description":"Blocks specific versions of Horizon Agent connections.","example":["7.6,0","8.0.0"],"items":{"type":"string","description":"Blocks specific versions of Horizon Agent connections.","example":"[\"7.6,0\",\"8.0.0\"]"}},"type":{"type":"string","description":"The type of Horizon Agent.\n* WINDOWS: The Agent is the Horizon Agent for Windows.\n* OTHER: Agent type is other.","example":"WINDOWS","enum":["WINDOWS","OTHER"]},"version":{"type":"string","description":"Blocks versions of Horizon Agent connections which are older than the specified version.","example":"7.5.0"}},"description":"Information related to update restricted Horizon Agents."},"RestrictedClientData":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of Horizon Client.\n* WINDOWS: The client is the Horizon Client for Windows.\n* MAC: The client is the Horizon Client for MacOS.\n* HTMLACCESS: The client is a Web client.\n* LINUX: The client is the Horizon Client for Linux.\n* IOS: The client is the Horizon Client for IOS devices.\n* ANDROID: The client is the Horizon Client for Android.\n* WINSTORE: The client is the Horizon Client for Windows 10 UWP.\n* CHROME: The client is the Horizon Client for Chrome Native OS.\n* OTHER: Client type is other.","example":"WINDOWS","enum":["WINDOWS","MAC","HTMLACCESS","LINUX","IOS","ANDROID","WINSTORE","CHROME","OTHER"]},"version":{"type":"string","description":"Blocks versions of Horizon Client connections which are older than the specified version.","example":"7.5"}},"description":"Information related to Restricted Horizon Clients.","example":[{"type":"WINDOWS","version":"7.5"},{"type":"LINUX","version":"6.5"}]},"RestrictedClientDataV2":{"required":["type"],"type":"object","properties":{"block_specific_versions":{"uniqueItems":true,"type":"array","description":"Blocks specific versions of Horizon Client connections.","example":["3.5,4","4.0.1"],"items":{"type":"string","description":"Blocks specific versions of Horizon Client connections.","example":"[\"3.5,4\",\"4.0.1\"]"}},"type":{"type":"string","description":"The type of Horizon Client.\n* WINDOWS: The client is the Horizon Client for Windows.\n* MAC: The client is the Horizon Client for MacOS.\n* HTMLACCESS: The client is a Web client.\n* LINUX: The client is the Horizon Client for Linux.\n* IOS: The client is the Horizon Client for IOS devices.\n* ANDROID: The client is the Horizon Client for Android.\n* WINSTORE: The client is the Horizon Client for Windows 10 UWP.\n* CHROME: The client is the Horizon Client for Chrome Native OS.\n* OTHER: Client type is other.","example":"WINDOWS","enum":["WINDOWS","MAC","HTMLACCESS","LINUX","IOS","ANDROID","WINSTORE","CHROME","OTHER"]},"version":{"type":"string","description":"Blocks versions of Horizon Client connections which are older than the specified version.","example":"7.5"},"warn_specific_versions":{"uniqueItems":true,"type":"array","description":"Warns specific versions of Horizon Client connections.","example":["7.5,4","5.0.2"],"items":{"type":"string","description":"Warns specific versions of Horizon Client connections.","example":"[\"7.5,4\",\"5.0.2\"]"}}},"description":"Information related to Restricted Horizon Clients."},"RestrictedClientDataV3":{"required":["type"],"type":"object","properties":{"block_specific_versions":{"uniqueItems":true,"type":"array","description":"Blocks specific versions of Horizon Client connections.","example":["3.5,4","4.0.1"],"items":{"type":"string","description":"Blocks specific versions of Horizon Client connections.","example":"[\"3.5,4\",\"4.0.1\"]"}},"checksum":{"type":"string","description":"Indicates the Horizon client jar checksum.","example":"dd232ec1279c8a7195a601cdff6932f1b079abe712e87fbfd1c8274a20951fff"},"checksum_type":{"type":"string","description":"Indicates the Horizon client jar checksum type.","example":"sha256"},"client_upgrade_url":{"type":"string","description":"URL of the file location concerning the client installer package which is to be registered.","example":"https://example.com/"},"type":{"type":"string","description":"The type of Horizon Client.\n* WINDOWS: The client is the Horizon Client for Windows.\n* MAC: The client is the Horizon Client for MacOS.\n* HTMLACCESS: The client is a Web client.\n* LINUX: The client is the Horizon Client for Linux.\n* IOS: The client is the Horizon Client for IOS devices.\n* ANDROID: The client is the Horizon Client for Android.\n* WINSTORE: The client is the Horizon Client for Windows 10 UWP.\n* CHROME: The client is the Horizon Client for Chrome Native OS.\n* OTHER: Client type is other.","example":"WINDOWS","enum":["WINDOWS","MAC","HTMLACCESS","LINUX","IOS","ANDROID","WINSTORE","CHROME","OTHER"]},"upgrade_type":{"type":"string","description":"Indicates the Upgrade type .","example":"None/Default/Custom"},"version":{"type":"string","description":"Blocks versions of Horizon Client connections which are older than the specified version.","example":"7.5"},"warn_specific_versions":{"uniqueItems":true,"type":"array","description":"Warns specific versions of Horizon Client connections.","example":["7.5,4","5.0.2"],"items":{"type":"string","description":"Warns specific versions of Horizon Client connections.","example":"[\"7.5,4\",\"5.0.2\"]"}}},"description":"Information related to Restricted Horizon Clients."},"ResumeTaskSpec":{"type":"object","properties":{"retry_failed_vms":{"type":"boolean","description":"Indicates whether to restart the task for virtual machines whose task status is in error state. Default value is false.","example":true},"stop_on_error":{"type":"boolean","description":"Indicates whether to stop the task at first error. Default value is true.","example":false}},"description":"Specification for resuming the task. If not provided, specification will be set to default values."},"RoleCreateSpec":{"required":["name","privileges"],"type":"object","properties":{"description":{"pattern":"[\\S\\s]{0,400}","type":"string","description":"Role description.","example":"Custom administrator role."},"name":{"pattern":"[a-zA-Z0-9 _-]{0,32}","type":"string","description":"Role name. This property must contain only alphanumerics, underscores, and dashes.","example":"Custom"},"privileges":{"uniqueItems":true,"type":"array","description":"Privileges for this role. When being created or updated, input non-selectable privileges are ignored. ","example":["VC_CONFIG_VIEW","FEDERATED_LDAP_MANAGE","GLOBAL_CONFIG_MANAGEMENT"],"items":{"type":"string","description":"* ADMINISTRATOR_VIEW: Full read only administrator privilege, including Multi-Datacenter View configuration. This is a non-selectable privilege.\n* VC_CONFIG_VIEW: Manage vCenter Configuration (Read Only).\n* LOG_COLLECTION: Collect Operation Logs.\n* FORENSICS: Manage Forensics Operations.\n* MANAGE_CERTIFICATES: Manage Certificates.\n* LCM_MANAGEMENT: Manage Server Life Cycle Management Operations.\n* LCM_VIEW: Manage Server Life Cycle Management Operations (Read Only).\n* LOCAL_ADMINISTRATOR: Full administrator privilege, except to Multi-Datacenter View configuration and to manage roles and privileges. This is a non-selectable privilege.\n* LOCAL_ADMINISTRATOR_VIEW: Full read only administrator privilege, except to Multi-Datacenter View configuration. This is a non-selectable privilege.\n* INVENTORY_ADMINISTRATOR: Access to all inventory objects. This is a non-selectable privilege.\n* INVENTORY_ADMINISTRATOR_VIEW: Read only access to all inventory objects. This is a non-selectable privilege.\n* HELPDESK_ADMINISTRATOR: Manage Help Desk. This is a non-selectable privilege.\n* HELPDESK_ADMINISTRATOR_VIEW: Manage Help Desk (Read only).\n* FEDERATED_LDAP_MANAGE: Manage Pod Federation. \n* FEDERATED_LDAP_VIEW: Manage Global LDAP (Read only). This is a non-selectable privilege.\n* FEDERATED_SESSIONS_MANAGE: Manage Federated Sessions.\n* FEDERATED_SESSIONS_VIEW: Manage Federated Sessions (Read only). This is a non-selectable privilege.\n* GLOBAL_ADMINISTRATOR: Manage Global Configuration. This is a non-selectable privilege.\n* GLOBAL_ADMINISTRATOR_VIEW: Manage Global Configuration (Read only). This is a non-selectable privilege.\n* GLOBAL_ADMIN_UI_INTERACTIVE: Can log into View Administrator. This is a non-selectable privilege.\n* GLOBAL_ADMIN_SDK_INTERACTIVE: Can run all command line utilities and PowerShell commands. This is a non-selectable privilege.\n* GLOBAL_MACHINE_REGISTER: Register non-vCenter machine sources such as Windows Terminal Servers and physical PCs.\n* GLOBAL_ROLE_PERMISSION_MANAGEMENT: Add, modify, and delete administrator roles and permissions.\n* GLOBAL_ROLE_MANAGEMENT: Add, modify, and delete administrator roles. This is a non-selectable privilege.\n* GLOBAL_ROLE_VIEW: Read only access to administrator roles. This is a non-selectable privilege.\n* GLOBAL_PERMISSION_VIEW: Read only access to administrator permissions. This is a non-selectable privilege.\n* GLOBAL_PERMISSION_MANAGEMENT: Add, modify, and delete administrator permissions. This is a non-selectable privilege.\n* GLOBAL_CONFIG_VIEW: Read only access to global (non-inventory) policy, configuration, and RDS server settings, except administrator roles and permissions and global (Multi-Datacenter View) LDAP. This is a non-selectable privilege.\n* GLOBAL_CONFIG_MANAGEMENT: View and change global (non-inventory) policy, configuration, and RDS server settings, except for administrator roles and permissions.\n* FOLDER_MANAGEMENT: Add, modify, and delete access groups.\n* FOLDER_VIEW: Read only access to access groups. This is a non-selectable privilege.\n* POOL_VIEW: Read only access to desktop pools, farms, applications, their local sessions, and their machines. This is a non-selectable privilege.\n* POOL_MANAGEMENT: Add, modify, and delete desktop pools, applications and farms. Add and remove machines from desktop pools.\n* POOL_ENABLE: Enable and disable desktop pools, farms, and applications.\n* POOL_ENTITLE: Add and remove desktop pool and application entitlements.\n* POOL_SVI_IMAGE_MANAGEMENT: Schedule push image, schedule maintenance and change default image for desktop pool and farm.\n* MACHINE_VIEW: Read only access to machines and their local sessions. This is a non-selectable privilege.\n* MACHINE_MANAGEMENT: Perform all machine and session-related commands.\n* MACHINE_REBOOT: Reset local machines.\n* MACHINE_SHUTDOWN: Shutdown local machines.\n* MACHINE_MANAGE_VDI_SESSION: Disconnect, logoff, and send messages to local sessions.\n* MACHINE_MANAGE_OFFLINE_SESSION: Roll back offline sessions and initiate replications.\n* MACHINE_USER_MANAGEMENT: Assign and un-assign users for machines, Update machine aliases for machines.\n* MACHINE_MAINTENANCE: Put machine in and out of maintenance mode.\n* MANAGE_REMOTE_PROCESS: Manage Remote Processes and Applications.\n* REMOTE_ASSISTANCE: Remote Assistance to Remote desktop pool.\n* GLOBAL_CVP_REGISTER: Global CVP Register. This is a non-selectable privilege.\n* GLOBAL_CVP_PUBLICATION: Global CVP Publication. This is a non-selectable privilege.\n* CVP_INTERACTIVE: CVP Interactive. This is a non-selectable privilege.\n* CVP_VIEW: CVP View. This is a non-selectable privilege.\n* CVP_MANAGEMENT: CVP Management.This is a non-selectable privilege.\n* CVP_OWNERSHIP: CVP Ownership.This is a non-selectable privilege.\n* API_SMART_CARD_BYPASS: Allows API's credential based login when smart card authentication mode is REQUIRED.\n* UDD_VIEW: Read only access to persistent disks. This is a non-selectable privilege.\n* UDD_MANAGEMENT: Manage persistent disks.\n* HORIZON_CLOUD_SERVICE: Allows subscription license activation and cloud monitoring through horizon cloud service.\n* SUBSCRIPTION_LICENSE_ADD: Allows subscription license activation.\n* CLOUD_ADMIN: Allows Cloud Admin Authentication.\n* CLOUD_ON_BOARDING_MANAGEMENT: Allows Cloud on-boarding.\n* CLOUD_OPS_MANAGEMENT: Allows Cloud operations post on-boarding.\n* CAPACITY_PROVIDER_CONFIG_VIEW: Manage Capacity Provider Configuration (Read Only).\n* CAPACITY_PROVIDER_CONFIG_MANAGEMENT: Manage Capacity Provider Configuration.\n* MANAGE_EXTERNAL_KEYS: Manage External Keys.\n* UNKNOWN_PRIVILEGE: Unknown Privilege type. This is a non-selectable privilege.","example":"[\"VC_CONFIG_VIEW\",\"FEDERATED_LDAP_MANAGE\",\"GLOBAL_CONFIG_MANAGEMENT\"]","enum":["ADMINISTRATOR","ADMINISTRATOR_VIEW","VC_CONFIG_VIEW","LOG_COLLECTION","FORENSICS","MANAGE_CERTIFICATES","LCM_MANAGEMENT","LCM_VIEW","LOCAL_ADMINISTRATOR","LOCAL_ADMINISTRATOR_VIEW","INVENTORY_ADMINISTRATOR","INVENTORY_ADMINISTRATOR_VIEW","HELPDESK_ADMINISTRATOR","HELPDESK_ADMINISTRATOR_VIEW","FEDERATED_LDAP_MANAGE","FEDERATED_LDAP_VIEW","FEDERATED_SESSIONS_MANAGE","FEDERATED_SESSIONS_VIEW","GLOBAL_ADMINISTRATOR","GLOBAL_ADMINISTRATOR_VIEW","GLOBAL_ADMIN_UI_INTERACTIVE","GLOBAL_ADMIN_SDK_INTERACTIVE","GLOBAL_MACHINE_REGISTER","GLOBAL_ROLE_PERMISSION_MANAGEMENT","GLOBAL_ROLE_MANAGEMENT","GLOBAL_ROLE_VIEW","GLOBAL_PERMISSION_VIEW","GLOBAL_PERMISSION_MANAGEMENT","GLOBAL_CONFIG_VIEW","GLOBAL_CONFIG_MANAGEMENT","FOLDER_MANAGEMENT","FOLDER_VIEW","POOL_VIEW","POOL_MANAGEMENT","POOL_ENABLE","POOL_ENTITLE","POOL_SVI_IMAGE_MANAGEMENT","MACHINE_VIEW","MACHINE_MANAGEMENT","MACHINE_REBOOT","MACHINE_SHUTDOWN","MACHINE_MANAGE_VDI_SESSION","MACHINE_MANAGE_OFFLINE_SESSION","MACHINE_USER_MANAGEMENT","MACHINE_MAINTENANCE","MANAGE_REMOTE_PROCESS","REMOTE_ASSISTANCE","GLOBAL_CVP_REGISTER","GLOBAL_CVP_PUBLICATION","CVP_INTERACTIVE","CVP_VIEW","CVP_MANAGEMENT","CVP_OWNERSHIP","API_SMART_CARD_BYPASS","UDD_VIEW","UDD_MANAGEMENT","HORIZON_CLOUD_SERVICE","SUBSCRIPTION_LICENSE_ADD","CLOUD_ADMIN","CLOUD_ON_BOARDING_MANAGEMENT","CLOUD_OPS_MANAGEMENT","CAPACITY_PROVIDER_CONFIG_VIEW","CAPACITY_PROVIDER_CONFIG_MANAGEMENT","MANAGE_EXTERNAL_KEYS","UNKNOWN_PRIVILEGE"]}}},"description":"Role object to be created."},"RoleInfo":{"type":"object","properties":{"applies_to_federation_access_group":{"type":"boolean","description":"Specifies whether federated access group is applicable for this role. This will be true when the role contains atleast one of FEDEREATED_LDAP_MANAGE, FEDEREATED_LDAP_VIEW, FEDERATED_SESSIONS_MANAGE or FEDERATED_SESSIONS_VIEW privilege.","example":true},"applies_to_local_access_group":{"type":"boolean","description":"Specifies whether local access group is applicable for this role. This will be true when the role contains atleast one inventory specific privilege.","example":true},"built_in_role_type":{"type":"string","description":"The role type. It will be null for custom roles.\n* ADMINISTRATOR: Role with full administrative rights.\n* ADMINISTRATOR_READ_ONLY: Role with full read-only administrative rights.\n* AGENT_REGISTRATION_ADMIN: Role with rights to register Agents.\n* GLOBAL_CONFIG_AND_POLICY_ADMIN: Role with rights for View Configuration settings and policies.\n* GLOBAL_CONFIG_AND_POLICY_ADMIN_READ_ONLY: Role with read-only rights for View Configuration settings and policies.\n* HELP_DESK_ADMIN: Role with rights for Help Desk portal management.\n* HELP_DESK_ADMIN_READ_ONLY: Role with read only rights for Help Desk portal management.\n* INVENTORY_ADMIN: Role with rights for inventory management.\n* INVENTORY_ADMIN_READ_ONLY: Role with read only rights for inventory management.\n* LOCAL_ADMIN: Local Pod Administration role with full administrative rights.\n* LOCAL_ADMIN_READ_ONLY: Local Pod Administration role with full read-only administrative rights.\n* UNKNOWN_ROLE: Unknown Role type.","example":"INVENTORY_ADMIN","enum":["ADMINISTRATOR","ADMINISTRATOR_READ_ONLY","AGENT_REGISTRATION_ADMIN","GLOBAL_CONFIG_AND_POLICY_ADMIN","GLOBAL_CONFIG_AND_POLICY_ADMIN_READ_ONLY","HELP_DESK_ADMIN","HELP_DESK_ADMIN_READ_ONLY","INVENTORY_ADMIN","INVENTORY_ADMIN_READ_ONLY","LOCAL_ADMIN","LOCAL_ADMIN_READ_ONLY","UNKNOWN_ROLE"]},"description":{"type":"string","description":"Role description.","example":"Administration users with rights for global and per Connection Server configuration settings."},"id":{"type":"string","description":"Unique ID representing this role.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"name":{"type":"string","description":"Role name.","example":"Global Configuration and Policy Administrators"},"permission_ids":{"type":"array","description":"Administrative permissions (user/group and access group) for this role.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","6fd4638a-381f-4518-aed6-042aa3d9f14c"],"items":{"type":"string","description":"Administrative permissions (user/group and access group) for this role.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\",\"6fd4638a-381f-4518-aed6-042aa3d9f14c\"]"}},"privileges":{"type":"array","description":"Privileges for this role.","example":["GLOBAL_ADMIN_UI_INTERACTIVE","GLOBAL_CONFIG_MANAGEMENT","GLOBAL_CONFIG_VIEW","GLOBAL_CVP_PUBLICATION"],"items":{"type":"string","description":"* ADMINISTRATOR_VIEW: Full read only administrator privilege, including Multi-Datacenter View configuration. This is a non-selectable privilege.\n* VC_CONFIG_VIEW: Manage vCenter Configuration (Read Only).\n* LOG_COLLECTION: Collect Operation Logs.\n* FORENSICS: Manage Forensics Operations.\n* MANAGE_CERTIFICATES: Manage Certificates.\n* LCM_MANAGEMENT: Manage Server Life Cycle Management Operations.\n* LCM_VIEW: Manage Server Life Cycle Management Operations (Read Only).\n* LOCAL_ADMINISTRATOR: Full administrator privilege, except to Multi-Datacenter View configuration and to manage roles and privileges. This is a non-selectable privilege.\n* LOCAL_ADMINISTRATOR_VIEW: Full read only administrator privilege, except to Multi-Datacenter View configuration. This is a non-selectable privilege.\n* INVENTORY_ADMINISTRATOR: Access to all inventory objects. This is a non-selectable privilege.\n* INVENTORY_ADMINISTRATOR_VIEW: Read only access to all inventory objects. This is a non-selectable privilege.\n* HELPDESK_ADMINISTRATOR: Manage Help Desk. This is a non-selectable privilege.\n* HELPDESK_ADMINISTRATOR_VIEW: Manage Help Desk (Read only).\n* FEDERATED_LDAP_MANAGE: Manage Pod Federation. \n* FEDERATED_LDAP_VIEW: Manage Global LDAP (Read only). This is a non-selectable privilege.\n* FEDERATED_SESSIONS_MANAGE: Manage Federated Sessions.\n* FEDERATED_SESSIONS_VIEW: Manage Federated Sessions (Read only). This is a non-selectable privilege.\n* GLOBAL_ADMINISTRATOR: Manage Global Configuration. This is a non-selectable privilege.\n* GLOBAL_ADMINISTRATOR_VIEW: Manage Global Configuration (Read only). This is a non-selectable privilege.\n* GLOBAL_ADMIN_UI_INTERACTIVE: Can log into View Administrator. This is a non-selectable privilege.\n* GLOBAL_ADMIN_SDK_INTERACTIVE: Can run all command line utilities and PowerShell commands. This is a non-selectable privilege.\n* GLOBAL_MACHINE_REGISTER: Register non-vCenter machine sources such as Windows Terminal Servers and physical PCs.\n* GLOBAL_ROLE_PERMISSION_MANAGEMENT: Add, modify, and delete administrator roles and permissions.\n* GLOBAL_ROLE_MANAGEMENT: Add, modify, and delete administrator roles. This is a non-selectable privilege.\n* GLOBAL_ROLE_VIEW: Read only access to administrator roles. This is a non-selectable privilege.\n* GLOBAL_PERMISSION_VIEW: Read only access to administrator permissions. This is a non-selectable privilege.\n* GLOBAL_PERMISSION_MANAGEMENT: Add, modify, and delete administrator permissions. This is a non-selectable privilege.\n* GLOBAL_CONFIG_VIEW: Read only access to global (non-inventory) policy, configuration, and RDS server settings, except administrator roles and permissions and global (Multi-Datacenter View) LDAP. This is a non-selectable privilege.\n* GLOBAL_CONFIG_MANAGEMENT: View and change global (non-inventory) policy, configuration, and RDS server settings, except for administrator roles and permissions.\n* FOLDER_MANAGEMENT: Add, modify, and delete access groups.\n* FOLDER_VIEW: Read only access to access groups. This is a non-selectable privilege.\n* POOL_VIEW: Read only access to desktop pools, farms, applications, their local sessions, and their machines. This is a non-selectable privilege.\n* POOL_MANAGEMENT: Add, modify, and delete desktop pools, applications and farms. Add and remove machines from desktop pools.\n* POOL_ENABLE: Enable and disable desktop pools, farms, and applications.\n* POOL_ENTITLE: Add and remove desktop pool and application entitlements.\n* POOL_SVI_IMAGE_MANAGEMENT: Schedule push image, schedule maintenance and change default image for desktop pool and farm.\n* MACHINE_VIEW: Read only access to machines and their local sessions. This is a non-selectable privilege.\n* MACHINE_MANAGEMENT: Perform all machine and session-related commands.\n* MACHINE_REBOOT: Reset local machines.\n* MACHINE_SHUTDOWN: Shutdown local machines.\n* MACHINE_MANAGE_VDI_SESSION: Disconnect, logoff, and send messages to local sessions.\n* MACHINE_MANAGE_OFFLINE_SESSION: Roll back offline sessions and initiate replications.\n* MACHINE_USER_MANAGEMENT: Assign and un-assign users for machines, Update machine aliases for machines.\n* MACHINE_MAINTENANCE: Put machine in and out of maintenance mode.\n* MANAGE_REMOTE_PROCESS: Manage Remote Processes and Applications.\n* REMOTE_ASSISTANCE: Remote Assistance to Remote desktop pool.\n* GLOBAL_CVP_REGISTER: Global CVP Register. This is a non-selectable privilege.\n* GLOBAL_CVP_PUBLICATION: Global CVP Publication. This is a non-selectable privilege.\n* CVP_INTERACTIVE: CVP Interactive. This is a non-selectable privilege.\n* CVP_VIEW: CVP View. This is a non-selectable privilege.\n* CVP_MANAGEMENT: CVP Management.This is a non-selectable privilege.\n* CVP_OWNERSHIP: CVP Ownership.This is a non-selectable privilege.\n* API_SMART_CARD_BYPASS: Allows API's credential based login when smart card authentication mode is REQUIRED.\n* UDD_VIEW: Read only access to persistent disks. This is a non-selectable privilege.\n* UDD_MANAGEMENT: Manage persistent disks.\n* HORIZON_CLOUD_SERVICE: Allows subscription license activation and cloud monitoring through horizon cloud service.\n* SUBSCRIPTION_LICENSE_ADD: Allows subscription license activation.\n* CLOUD_ADMIN: Allows Cloud Admin Authentication.\n* CLOUD_ON_BOARDING_MANAGEMENT: Allows Cloud on-boarding.\n* CLOUD_OPS_MANAGEMENT: Allows Cloud operations post on-boarding.\n* CAPACITY_PROVIDER_CONFIG_VIEW: Manage Capacity Provider Configuration (Read Only).\n* CAPACITY_PROVIDER_CONFIG_MANAGEMENT: Manage Capacity Provider Configuration.\n* MANAGE_EXTERNAL_KEYS: Manage External Keys.\n* UNKNOWN_PRIVILEGE: Unknown Privilege type. This is a non-selectable privilege.","example":"[\"GLOBAL_ADMIN_UI_INTERACTIVE\",\"GLOBAL_CONFIG_MANAGEMENT\",\"GLOBAL_CONFIG_VIEW\",\"GLOBAL_CVP_PUBLICATION\"]","enum":["ADMINISTRATOR","ADMINISTRATOR_VIEW","VC_CONFIG_VIEW","LOG_COLLECTION","FORENSICS","MANAGE_CERTIFICATES","LCM_MANAGEMENT","LCM_VIEW","LOCAL_ADMINISTRATOR","LOCAL_ADMINISTRATOR_VIEW","INVENTORY_ADMINISTRATOR","INVENTORY_ADMINISTRATOR_VIEW","HELPDESK_ADMINISTRATOR","HELPDESK_ADMINISTRATOR_VIEW","FEDERATED_LDAP_MANAGE","FEDERATED_LDAP_VIEW","FEDERATED_SESSIONS_MANAGE","FEDERATED_SESSIONS_VIEW","GLOBAL_ADMINISTRATOR","GLOBAL_ADMINISTRATOR_VIEW","GLOBAL_ADMIN_UI_INTERACTIVE","GLOBAL_ADMIN_SDK_INTERACTIVE","GLOBAL_MACHINE_REGISTER","GLOBAL_ROLE_PERMISSION_MANAGEMENT","GLOBAL_ROLE_MANAGEMENT","GLOBAL_ROLE_VIEW","GLOBAL_PERMISSION_VIEW","GLOBAL_PERMISSION_MANAGEMENT","GLOBAL_CONFIG_VIEW","GLOBAL_CONFIG_MANAGEMENT","FOLDER_MANAGEMENT","FOLDER_VIEW","POOL_VIEW","POOL_MANAGEMENT","POOL_ENABLE","POOL_ENTITLE","POOL_SVI_IMAGE_MANAGEMENT","MACHINE_VIEW","MACHINE_MANAGEMENT","MACHINE_REBOOT","MACHINE_SHUTDOWN","MACHINE_MANAGE_VDI_SESSION","MACHINE_MANAGE_OFFLINE_SESSION","MACHINE_USER_MANAGEMENT","MACHINE_MAINTENANCE","MANAGE_REMOTE_PROCESS","REMOTE_ASSISTANCE","GLOBAL_CVP_REGISTER","GLOBAL_CVP_PUBLICATION","CVP_INTERACTIVE","CVP_VIEW","CVP_MANAGEMENT","CVP_OWNERSHIP","API_SMART_CARD_BYPASS","UDD_VIEW","UDD_MANAGEMENT","HORIZON_CLOUD_SERVICE","SUBSCRIPTION_LICENSE_ADD","CLOUD_ADMIN","CLOUD_ON_BOARDING_MANAGEMENT","CLOUD_OPS_MANAGEMENT","CAPACITY_PROVIDER_CONFIG_VIEW","CAPACITY_PROVIDER_CONFIG_MANAGEMENT","MANAGE_EXTERNAL_KEYS","UNKNOWN_PRIVILEGE"]}}},"description":"Information about role."},"RoleUpdateSpec":{"required":["privileges"],"type":"object","properties":{"description":{"pattern":"[\\S\\s]{0,400}","type":"string","description":"Role description.","example":"Administration users with full administrative rights."},"privileges":{"uniqueItems":true,"type":"array","description":"Privileges for this role. When being created or updated, input non-selectable privileges are ignored. ","example":["VC_CONFIG_VIEW","FEDERATED_LDAP_MANAGE","GLOBAL_CONFIG_MANAGEMENT"],"items":{"type":"string","description":"* ADMINISTRATOR_VIEW: Full read only administrator privilege, including Multi-Datacenter View configuration. This is a non-selectable privilege.\n* VC_CONFIG_VIEW: Manage vCenter Configuration (Read Only).\n* LOG_COLLECTION: Collect Operation Logs.\n* FORENSICS: Manage Forensics Operations.\n* MANAGE_CERTIFICATES: Manage Certificates.\n* LCM_MANAGEMENT: Manage Server Life Cycle Management Operations.\n* LCM_VIEW: Manage Server Life Cycle Management Operations (Read Only).\n* LOCAL_ADMINISTRATOR: Full administrator privilege, except to Multi-Datacenter View configuration and to manage roles and privileges. This is a non-selectable privilege.\n* LOCAL_ADMINISTRATOR_VIEW: Full read only administrator privilege, except to Multi-Datacenter View configuration. This is a non-selectable privilege.\n* INVENTORY_ADMINISTRATOR: Access to all inventory objects. This is a non-selectable privilege.\n* INVENTORY_ADMINISTRATOR_VIEW: Read only access to all inventory objects. This is a non-selectable privilege.\n* HELPDESK_ADMINISTRATOR: Manage Help Desk. This is a non-selectable privilege.\n* HELPDESK_ADMINISTRATOR_VIEW: Manage Help Desk (Read only).\n* FEDERATED_LDAP_MANAGE: Manage Pod Federation. \n* FEDERATED_LDAP_VIEW: Manage Global LDAP (Read only). This is a non-selectable privilege.\n* FEDERATED_SESSIONS_MANAGE: Manage Federated Sessions.\n* FEDERATED_SESSIONS_VIEW: Manage Federated Sessions (Read only). This is a non-selectable privilege.\n* GLOBAL_ADMINISTRATOR: Manage Global Configuration. This is a non-selectable privilege.\n* GLOBAL_ADMINISTRATOR_VIEW: Manage Global Configuration (Read only). This is a non-selectable privilege.\n* GLOBAL_ADMIN_UI_INTERACTIVE: Can log into View Administrator. This is a non-selectable privilege.\n* GLOBAL_ADMIN_SDK_INTERACTIVE: Can run all command line utilities and PowerShell commands. This is a non-selectable privilege.\n* GLOBAL_MACHINE_REGISTER: Register non-vCenter machine sources such as Windows Terminal Servers and physical PCs.\n* GLOBAL_ROLE_PERMISSION_MANAGEMENT: Add, modify, and delete administrator roles and permissions.\n* GLOBAL_ROLE_MANAGEMENT: Add, modify, and delete administrator roles. This is a non-selectable privilege.\n* GLOBAL_ROLE_VIEW: Read only access to administrator roles. This is a non-selectable privilege.\n* GLOBAL_PERMISSION_VIEW: Read only access to administrator permissions. This is a non-selectable privilege.\n* GLOBAL_PERMISSION_MANAGEMENT: Add, modify, and delete administrator permissions. This is a non-selectable privilege.\n* GLOBAL_CONFIG_VIEW: Read only access to global (non-inventory) policy, configuration, and RDS server settings, except administrator roles and permissions and global (Multi-Datacenter View) LDAP. This is a non-selectable privilege.\n* GLOBAL_CONFIG_MANAGEMENT: View and change global (non-inventory) policy, configuration, and RDS server settings, except for administrator roles and permissions.\n* FOLDER_MANAGEMENT: Add, modify, and delete access groups.\n* FOLDER_VIEW: Read only access to access groups. This is a non-selectable privilege.\n* POOL_VIEW: Read only access to desktop pools, farms, applications, their local sessions, and their machines. This is a non-selectable privilege.\n* POOL_MANAGEMENT: Add, modify, and delete desktop pools, applications and farms. Add and remove machines from desktop pools.\n* POOL_ENABLE: Enable and disable desktop pools, farms, and applications.\n* POOL_ENTITLE: Add and remove desktop pool and application entitlements.\n* POOL_SVI_IMAGE_MANAGEMENT: Schedule push image, schedule maintenance and change default image for desktop pool and farm.\n* MACHINE_VIEW: Read only access to machines and their local sessions. This is a non-selectable privilege.\n* MACHINE_MANAGEMENT: Perform all machine and session-related commands.\n* MACHINE_REBOOT: Reset local machines.\n* MACHINE_SHUTDOWN: Shutdown local machines.\n* MACHINE_MANAGE_VDI_SESSION: Disconnect, logoff, and send messages to local sessions.\n* MACHINE_MANAGE_OFFLINE_SESSION: Roll back offline sessions and initiate replications.\n* MACHINE_USER_MANAGEMENT: Assign and un-assign users for machines, Update machine aliases for machines.\n* MACHINE_MAINTENANCE: Put machine in and out of maintenance mode.\n* MANAGE_REMOTE_PROCESS: Manage Remote Processes and Applications.\n* REMOTE_ASSISTANCE: Remote Assistance to Remote desktop pool.\n* GLOBAL_CVP_REGISTER: Global CVP Register. This is a non-selectable privilege.\n* GLOBAL_CVP_PUBLICATION: Global CVP Publication. This is a non-selectable privilege.\n* CVP_INTERACTIVE: CVP Interactive. This is a non-selectable privilege.\n* CVP_VIEW: CVP View. This is a non-selectable privilege.\n* CVP_MANAGEMENT: CVP Management.This is a non-selectable privilege.\n* CVP_OWNERSHIP: CVP Ownership.This is a non-selectable privilege.\n* API_SMART_CARD_BYPASS: Allows API's credential based login when smart card authentication mode is REQUIRED.\n* UDD_VIEW: Read only access to persistent disks. This is a non-selectable privilege.\n* UDD_MANAGEMENT: Manage persistent disks.\n* HORIZON_CLOUD_SERVICE: Allows subscription license activation and cloud monitoring through horizon cloud service.\n* SUBSCRIPTION_LICENSE_ADD: Allows subscription license activation.\n* CLOUD_ADMIN: Allows Cloud Admin Authentication.\n* CLOUD_ON_BOARDING_MANAGEMENT: Allows Cloud on-boarding.\n* CLOUD_OPS_MANAGEMENT: Allows Cloud operations post on-boarding.\n* CAPACITY_PROVIDER_CONFIG_VIEW: Manage Capacity Provider Configuration (Read Only).\n* CAPACITY_PROVIDER_CONFIG_MANAGEMENT: Manage Capacity Provider Configuration.\n* MANAGE_EXTERNAL_KEYS: Manage External Keys.\n* UNKNOWN_PRIVILEGE: Unknown Privilege type. This is a non-selectable privilege.","example":"[\"VC_CONFIG_VIEW\",\"FEDERATED_LDAP_MANAGE\",\"GLOBAL_CONFIG_MANAGEMENT\"]","enum":["ADMINISTRATOR","ADMINISTRATOR_VIEW","VC_CONFIG_VIEW","LOG_COLLECTION","FORENSICS","MANAGE_CERTIFICATES","LCM_MANAGEMENT","LCM_VIEW","LOCAL_ADMINISTRATOR","LOCAL_ADMINISTRATOR_VIEW","INVENTORY_ADMINISTRATOR","INVENTORY_ADMINISTRATOR_VIEW","HELPDESK_ADMINISTRATOR","HELPDESK_ADMINISTRATOR_VIEW","FEDERATED_LDAP_MANAGE","FEDERATED_LDAP_VIEW","FEDERATED_SESSIONS_MANAGE","FEDERATED_SESSIONS_VIEW","GLOBAL_ADMINISTRATOR","GLOBAL_ADMINISTRATOR_VIEW","GLOBAL_ADMIN_UI_INTERACTIVE","GLOBAL_ADMIN_SDK_INTERACTIVE","GLOBAL_MACHINE_REGISTER","GLOBAL_ROLE_PERMISSION_MANAGEMENT","GLOBAL_ROLE_MANAGEMENT","GLOBAL_ROLE_VIEW","GLOBAL_PERMISSION_VIEW","GLOBAL_PERMISSION_MANAGEMENT","GLOBAL_CONFIG_VIEW","GLOBAL_CONFIG_MANAGEMENT","FOLDER_MANAGEMENT","FOLDER_VIEW","POOL_VIEW","POOL_MANAGEMENT","POOL_ENABLE","POOL_ENTITLE","POOL_SVI_IMAGE_MANAGEMENT","MACHINE_VIEW","MACHINE_MANAGEMENT","MACHINE_REBOOT","MACHINE_SHUTDOWN","MACHINE_MANAGE_VDI_SESSION","MACHINE_MANAGE_OFFLINE_SESSION","MACHINE_USER_MANAGEMENT","MACHINE_MAINTENANCE","MANAGE_REMOTE_PROCESS","REMOTE_ASSISTANCE","GLOBAL_CVP_REGISTER","GLOBAL_CVP_PUBLICATION","CVP_INTERACTIVE","CVP_VIEW","CVP_MANAGEMENT","CVP_OWNERSHIP","API_SMART_CARD_BYPASS","UDD_VIEW","UDD_MANAGEMENT","HORIZON_CLOUD_SERVICE","SUBSCRIPTION_LICENSE_ADD","CLOUD_ADMIN","CLOUD_ON_BOARDING_MANAGEMENT","CLOUD_OPS_MANAGEMENT","CAPACITY_PROVIDER_CONFIG_VIEW","CAPACITY_PROVIDER_CONFIG_MANAGEMENT","MANAGE_EXTERNAL_KEYS","UNKNOWN_PRIVILEGE"]}}},"description":"Role object to be updated."},"SAMLAuthMonitorDetails":{"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for the SAML authenticator.","example":"https://vidm.example.com/saas/api/1.0/GET/admindata"},"label":{"type":"string","description":"The label of the SAML Authenticator.","example":"vidm.example.com"},"metadata_url":{"type":"string","description":"The metadata URL of the SAML Authenticator.","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"}},"description":"Details of the SAML authenticator."},"SAMLAuthMonitorDetailsV2":{"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for the SAML authenticator.","example":"https://vidm.example.com/saas/api/1.0/GET/admindata"},"description":{"type":"string","description":" The description of the SAML authenticator. ","example":"description"},"label":{"type":"string","description":"The label of the SAML Authenticator.","example":"vidm.example.com"},"metadata_url":{"type":"string","description":"The metadata URL of the SAML Authenticator.","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"},"require_encrypted_assertions":{"type":"boolean","description":"Enforcing the Encrypted Assertion coming from the Identity Provider","example":true},"trigger_mode":{"type":"string","description":"Indicates how True SSO is triggered on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.\n* REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.\n* ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.\n* REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.","example":"DISABLED","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]}},"description":"Details of the SAML authenticator."},"SAMLAuthMonitorDetailsV3":{"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for the SAML authenticator.","example":"https://vidm.example.com/saas/api/1.0/GET/admindata"},"description":{"type":"string","description":" The description of the SAML authenticator. ","example":"description"},"force_saml_auth":{"type":"boolean","description":"This indicates that IDP will force the user to authenticate even if the user is already logged in.","example":true},"label":{"type":"string","description":"The label of the SAML Authenticator.","example":"vidm.example.com"},"metadata_url":{"type":"string","description":"The metadata URL of the SAML Authenticator.","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"},"require_encrypted_assertions":{"type":"boolean","description":"Enforcing the Encrypted Assertion coming from the Identity Provider","example":true},"trigger_mode":{"type":"string","description":"Indicates how True SSO is triggered on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.\n* REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.\n* ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.\n* REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.","example":"DISABLED","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]},"workspace_one_enabled":{"type":"boolean","description":"This indicates that particular Authenticator is for Workspace one or not. If it is true then Authenticator is related to WorkspaceOne","example":true}},"description":"Details of the SAML authenticator."},"SAMLAuthenticatorAssociationSpec":{"required":["connection_server_id","saml_support"],"type":"object","properties":{"connection_server_id":{"type":"string","description":"Connection server ID"},"saml_support":{"type":"string","description":"SAML support state to set on connection servers\n* DISABLED: Indicates that the SAML support is disabled.\n* MULTI_ENABLED: Indicates that the SAML multi auth support is enabled.\n* MULTI_REQUIRED: Indicates that the SAML multi auth support is mandatory.","enum":["DISABLED","MULTI_ENABLED","MULTI_REQUIRED"]}},"description":"Request specification for associating SAML authenticator with connection servers"},"SAMLAuthenticatorCreateSpec":{"required":["authenticator_type","label"],"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for this SAML authenticator. This must specify a protocol (scheme) of http or https.","example":"https://vidm.example.com/saas/api/1.0/GET/admindata"},"authenticator_type":{"type":"string","description":"The type of SAML authenticator.\n* STATIC: Static SAML Authenticator, which contains SAML metadata.\n* DYNAMIC: Dynamic SAML Authenticator fetches metadata dynamically using a provided URL.","example":"DYNAMIC","enum":["STATIC","DYNAMIC"]},"certificate":{"type":"string","description":"SAML Authenticator certificate.","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"connection_server_ids":{"uniqueItems":true,"type":"array","description":"The list of Connection Servers for which this SAML authenticator is enabled.","example":["11bd230b-87ce-3306-a943-810affe7b68a","aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b"],"items":{"type":"string","description":"The list of Connection Servers for which this SAML authenticator is enabled.","example":"[\"11bd230b-87ce-3306-a943-810affe7b68a\",\"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of this SAML authenticator.","example":"Dynamic Saml Authenticator"},"label":{"maxLength":32,"minLength":0,"type":"string","description":"The label for this SAML authenticator. It must be unique among all other SAML authenticators.","example":"vidm.example.com"},"metadata_url":{"type":"string","description":"The metadata URL that this SAML authenticator uses to fetch metadata. This must specify a protocol (scheme) of https. It must be unique among all other SAML authenticators. This is required if authenticator_type is set to DYNAMIC.","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"},"password_mode":{"type":"string","description":"Indicates how password present in SAML assertion is handled if True SSO is triggered. This is required if the trigger_mode is set to ENABLE_ALWAYS or REQUIRE_ALWAYS.\n* REMOVE: Remove any passwords.\n* PASSTHRU: Pass through any passwords.\n* ERROR: Error if there is a password.","example":"REMOVE","enum":["REMOVE","PASSTHRU","ERROR"]},"static_metadata":{"type":"string","description":"The static metadata of a SAML authenticator which contains an entity id, signing keys, and encryption keys for processing SAML authentication. This property is required if authenticator_type is set to STATIC.","example":"<md:EntityDescriptor xmlns:..</md:EntityDescriptor>"},"trigger_mode":{"type":"string","description":"Indicates how True SSO is triggered on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.\n* REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.\n* ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.\n* REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.","example":"DISABLED","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]}},"description":"SAML Authenticator specification"},"SAMLAuthenticatorCreateSpecV2":{"required":["authenticator_type","label"],"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for this SAML authenticator. This must specify a protocol (scheme) of http or https.","example":"https://vidm.example.com/saas/api/1.0/GET/admindata"},"authenticator_type":{"type":"string","description":"The type of SAML authenticator.\n* STATIC: Static SAML Authenticator, which contains SAML metadata.\n* DYNAMIC: Dynamic SAML Authenticator fetches metadata dynamically using a provided URL.","example":"DYNAMIC","enum":["STATIC","DYNAMIC"]},"certificate":{"type":"string","description":"SAML Authenticator certificate.","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"connection_server_ids":{"uniqueItems":true,"type":"array","description":"The list of Connection Servers for which this SAML authenticator is enabled.","example":["11bd230b-87ce-3306-a943-810affe7b68a","aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b"],"items":{"type":"string","description":"The list of Connection Servers for which this SAML authenticator is enabled.","example":"[\"11bd230b-87ce-3306-a943-810affe7b68a\",\"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of this SAML authenticator.","example":"Dynamic Saml Authenticator"},"label":{"maxLength":32,"minLength":0,"type":"string","description":"The label for this SAML authenticator. It must be unique among all other SAML authenticators.","example":"vidm.example.com"},"metadata_url":{"type":"string","description":"The metadata URL that this SAML authenticator uses to fetch metadata. This must specify a protocol (scheme) of https. It must be unique among all other SAML authenticators. This is required if authenticator_type is set to DYNAMIC.","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"},"password_mode":{"type":"string","description":"Indicates how password present in SAML assertion is handled if True SSO is triggered. This is required if the trigger_mode is set to ENABLE_ALWAYS or REQUIRE_ALWAYS.\n* REMOVE: Remove any passwords.\n* PASSTHRU: Pass through any passwords.\n* ERROR: Error if there is a password.","example":"REMOVE","enum":["REMOVE","PASSTHRU","ERROR"]},"require_encrypted_assertions":{"type":"boolean","description":"enforcing the Encrypted Assertion coming from the Identity Provider. It is false by default.","example":false},"static_metadata":{"type":"string","description":"The static metadata of a SAML authenticator which contains an entity id, signing keys, and encryption keys for processing SAML authentication. This property is required if authenticator_type is set to STATIC.","example":"<md:EntityDescriptor xmlns:..</md:EntityDescriptor>"},"trigger_mode":{"type":"string","description":"Indicates how True SSO is triggered on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.\n* REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.\n* ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.\n* REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.","example":"DISABLED","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]}},"description":"SAML Authenticator specification"},"SAMLAuthenticatorCreateSpecV3":{"required":["authenticator_type","force_saml_auth","label","workspace_one_enabled"],"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for this SAML authenticator. This must specify a protocol (scheme) of http or https.","example":"https://vidm.example.com/saas/api/1.0/GET/admindata"},"authenticator_type":{"type":"string","description":"The type of SAML authenticator.\n* STATIC: Static SAML Authenticator, which contains SAML metadata.\n* DYNAMIC: Dynamic SAML Authenticator fetches metadata dynamically using a provided URL.","example":"DYNAMIC","enum":["STATIC","DYNAMIC"]},"certificate":{"type":"string","description":"SAML Authenticator certificate.","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"connection_server_ids":{"uniqueItems":true,"type":"array","description":"The list of Connection Servers for which this SAML authenticator is enabled.","example":["11bd230b-87ce-3306-a943-810affe7b68a","aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b"],"items":{"type":"string","description":"The list of Connection Servers for which this SAML authenticator is enabled.","example":"[\"11bd230b-87ce-3306-a943-810affe7b68a\",\"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of this SAML authenticator.","example":"Dynamic Saml Authenticator"},"force_saml_auth":{"type":"boolean","description":"This indicates that IDP will force the user to authenticate even if the user is already logged in.","example":true,"default":false},"label":{"maxLength":32,"minLength":0,"type":"string","description":"The label for this SAML authenticator. It must be unique among all other SAML authenticators.","example":"vidm.example.com"},"metadata_url":{"type":"string","description":"The metadata URL that this SAML authenticator uses to fetch metadata. This must specify a protocol (scheme) of https. It must be unique among all other SAML authenticators. This is required if authenticator_type is set to DYNAMIC.","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"},"password_mode":{"type":"string","description":"Indicates how password present in SAML assertion is handled if True SSO is triggered. This is required if the trigger_mode is set to ENABLE_ALWAYS or REQUIRE_ALWAYS.\n* REMOVE: Remove any passwords.\n* PASSTHRU: Pass through any passwords.\n* ERROR: Error if there is a password.","example":"REMOVE","enum":["REMOVE","PASSTHRU","ERROR"]},"require_encrypted_assertions":{"type":"boolean","description":"enforcing the Encrypted Assertion coming from the Identity Provider. It is false by default.","example":false},"static_metadata":{"type":"string","description":"The static metadata of a SAML authenticator which contains an entity id, signing keys, and encryption keys for processing SAML authentication. This property is required if authenticator_type is set to STATIC.","example":"<md:EntityDescriptor xmlns:..</md:EntityDescriptor>"},"trigger_mode":{"type":"string","description":"Indicates how True SSO is triggered on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.\n* REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.\n* ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.\n* REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.","example":"DISABLED","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]},"workspace_one_enabled":{"type":"boolean","description":"This indicates that particular Authenticator is for Workspace one or not. If it is true then Authenticator is related to WorkspaceOne","example":true,"default":false}},"description":"SAML Authenticator specification"},"SAMLAuthenticatorInfo":{"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for the SAML authenticator.","example":"https://vidm.example.com/saas/api/1.0/GET/admindata"},"authenticator_type":{"type":"string","description":"The type of SAML authenticator.\n* STATIC: Static SAML Authenticator, which contains SAML metadata.\n* DYNAMIC: Dynamic SAML Authenticator fetches metadata dynamically using a provided URL.","example":"DYNAMIC","enum":["STATIC","DYNAMIC"]},"certificate":{"type":"string","description":"SAML Authenticator certificate.","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"description":{"type":"string","description":"The description of this SAML authenticator.","example":"Dynamic Saml Authenticator"},"id":{"type":"string","description":"Unique ID representing this SAML Authenticator.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"label":{"type":"string","description":"The label for this SAML authenticator.","example":"vidm.example.com"},"metadata_url":{"type":"string","description":"The metadata URL of the SAML Authenticator.","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"},"password_mode":{"type":"string","description":"Indicates how password present in SAML assertion is handled if True SSO is triggered.\n* REMOVE: Remove any passwords.\n* PASSTHRU: Pass through any passwords.\n* ERROR: Error if there is a password.","example":"REMOVE","enum":["REMOVE","PASSTHRU","ERROR"]},"static_metadata":{"type":"string","description":"The static metadata of a SAML authenticator which contains an entity id, signing keys, and encryption keys for processing SAML authentication.","example":"<md:EntityDescriptor xmlns:..</md:EntityDescriptor>"},"trigger_mode":{"type":"string","description":"Indicates how True SSO is triggered on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.\n* REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.\n* ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.\n* REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.","example":"DISABLED","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]}},"description":"Information about SAML Authenticator."},"SAMLAuthenticatorInfoV2":{"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for the SAML authenticator.","example":"https://vidm.example.com/saas/api/1.0/GET/admindata"},"authenticator_type":{"type":"string","description":"The type of SAML authenticator.\n* STATIC: Static SAML Authenticator, which contains SAML metadata.\n* DYNAMIC: Dynamic SAML Authenticator fetches metadata dynamically using a provided URL.","example":"DYNAMIC","enum":["STATIC","DYNAMIC"]},"certificate":{"type":"string","description":"SAML Authenticator certificate.","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"description":{"type":"string","description":"The description of this SAML authenticator.","example":"Dynamic Saml Authenticator"},"id":{"type":"string","description":"Unique ID representing this SAML Authenticator.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"label":{"type":"string","description":"The label for this SAML authenticator.","example":"vidm.example.com"},"metadata_url":{"type":"string","description":"The metadata URL of the SAML Authenticator.","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"},"password_mode":{"type":"string","description":"Indicates how password present in SAML assertion is handled if True SSO is triggered.\n* REMOVE: Remove any passwords.\n* PASSTHRU: Pass through any passwords.\n* ERROR: Error if there is a password.","example":"REMOVE","enum":["REMOVE","PASSTHRU","ERROR"]},"require_encrypted_assertions":{"type":"boolean","description":"enforcing the Encrypted Assertion coming from the Identity Provider"},"static_metadata":{"type":"string","description":"The static metadata of a SAML authenticator which contains an entity id, signing keys, and encryption keys for processing SAML authentication.","example":"<md:EntityDescriptor xmlns:..</md:EntityDescriptor>"},"trigger_mode":{"type":"string","description":"Indicates how True SSO is triggered on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.\n* REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.\n* ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.\n* REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.","example":"DISABLED","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]}},"description":"Information about SAML Authenticator."},"SAMLAuthenticatorInfoV3":{"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for the SAML authenticator.","example":"https://vidm.example.com/saas/api/1.0/GET/admindata"},"authenticator_type":{"type":"string","description":"The type of SAML authenticator.\n* STATIC: Static SAML Authenticator, which contains SAML metadata.\n* DYNAMIC: Dynamic SAML Authenticator fetches metadata dynamically using a provided URL.","example":"DYNAMIC","enum":["STATIC","DYNAMIC"]},"certificate":{"type":"string","description":"SAML Authenticator certificate.","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"description":{"type":"string","description":"The description of this SAML authenticator.","example":"Dynamic Saml Authenticator"},"force_saml_auth":{"type":"boolean","description":"This indicates that IDP will force the user to authenticate even if the user is already logged in.","example":true},"id":{"type":"string","description":"Unique ID representing this SAML Authenticator.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"label":{"type":"string","description":"The label for this SAML authenticator.","example":"vidm.example.com"},"metadata_url":{"type":"string","description":"The metadata URL of the SAML Authenticator.","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"},"password_mode":{"type":"string","description":"Indicates how password present in SAML assertion is handled if True SSO is triggered.\n* REMOVE: Remove any passwords.\n* PASSTHRU: Pass through any passwords.\n* ERROR: Error if there is a password.","example":"REMOVE","enum":["REMOVE","PASSTHRU","ERROR"]},"require_encrypted_assertions":{"type":"boolean","description":"enforcing the Encrypted Assertion coming from the Identity Provider"},"static_metadata":{"type":"string","description":"The static metadata of a SAML authenticator which contains an entity id, signing keys, and encryption keys for processing SAML authentication.","example":"<md:EntityDescriptor xmlns:..</md:EntityDescriptor>"},"trigger_mode":{"type":"string","description":"Indicates how True SSO is triggered on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.\n* REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.\n* ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.\n* REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.","example":"DISABLED","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]},"workspace_one_enabled":{"type":"boolean","description":"This indicates that particular Authenticator is for Workspace one or not. If it is true then Authenticator is related to WorkspaceOne","example":true}}},"SAMLAuthenticatorMonitorConnectionServer":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the SAML authenticator with respect to this Connection Server.\n* OK: The connection to SAML authenticator is working properly.\n* ERROR: Error occurred when connecting to SAML authenticator.\n* WARN: The connection to SAML authenticator has minor issues.\n* UNKNOWN: State of SAML authenticator is unknown.","example":"OK","enum":["OK","ERROR","WARN","UNKNOWN"]},"thumbprint_accepted":{"type":"boolean","description":"Indicates if the thumbprint of the SAML authenticator was accepted.","example":false}},"description":"Information about the SAML authenticator connection from a connection server."},"SAMLAuthenticatorMonitorConnectionServerV2":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the SAML authenticator with respect to this Connection Server.\n* OK: The connection to SAML authenticator is working properly.\n* ERROR: Error occurred when connecting to SAML authenticator.\n* WARN: The connection to SAML authenticator has minor issues.\n* UNKNOWN: State of SAML authenticator is unknown.","example":"OK","enum":["OK","ERROR","WARN","UNKNOWN"]},"thumbprint_accepted":{"type":"boolean","description":"Indicates if the thumbprint of the SAML authenticator was accepted.","example":false}},"description":"Information about the SAML authenticator connection from a connection server."},"SAMLAuthenticatorMonitorConnectionServerV3":{"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/CertificateMonitorInfoV2"},"error_message":{"type":"string","description":"Error message if connection server failed to connect to SAML authenticator.","example":"error"},"id":{"type":"string","description":"Unique ID of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the SAML authenticator with respect to this Connection Server.\n* OK: The connection to SAML authenticator is working properly.\n* ERROR: Error occurred when connecting to SAML authenticator.\n* WARN: The connection to SAML authenticator has minor issues.\n* UNKNOWN: State of SAML authenticator is unknown.","example":"OK","enum":["OK","ERROR","WARN","UNKNOWN"]},"thumbprint_accepted":{"type":"boolean","description":"Indicates if the thumbprint of the SAML authenticator was accepted.","example":false}},"description":"Information about the SAML authenticator connection from a connection server."},"SAMLAuthenticatorMonitorInfo":{"required":["id"],"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the SAML authenticator connections from each of the connection servers.","items":{"$ref":"#/components/schemas/SAMLAuthenticatorMonitorConnectionServer"}},"details":{"$ref":"#/components/schemas/SAMLAuthMonitorDetails"},"id":{"type":"string","description":"Unique ID of the SAML Authenticator.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}},"description":"Monitoring information related to SAML Authenticator."},"SAMLAuthenticatorMonitorInfoV2":{"required":["id"],"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the SAML authenticator connections from each of the connection servers.","items":{"$ref":"#/components/schemas/SAMLAuthenticatorMonitorConnectionServerV2"}},"details":{"$ref":"#/components/schemas/SAMLAuthMonitorDetails"},"id":{"type":"string","description":"Unique ID of the SAML Authenticator.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}},"description":"Monitoring information related to SAML Authenticator."},"SAMLAuthenticatorMonitorInfoV3":{"required":["id"],"type":"object","properties":{"connection_servers_v3":{"type":"array","description":"Details about the SAML authenticator.","items":{"$ref":"#/components/schemas/SAMLAuthenticatorMonitorConnectionServerV3"}},"details":{"$ref":"#/components/schemas/SAMLAuthMonitorDetailsV2"},"id":{"type":"string","description":"Unique ID of the SAML Authenticator.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}},"description":"Monitoring information related to SAML Authenticator."},"SAMLAuthenticatorMonitorInfoV4":{"required":["id"],"type":"object","properties":{"connection_servers_v3":{"type":"array","description":"Details about the SAML authenticator.","items":{"$ref":"#/components/schemas/SAMLAuthenticatorMonitorConnectionServerV3"}},"details":{"$ref":"#/components/schemas/SAMLAuthMonitorDetailsV3"},"id":{"type":"string","description":"Unique ID of the SAML Authenticator.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}}},"SAMLAuthenticatorServerSpec":{"required":["metadata_url"],"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for the SAML authenticator.","example":"https://vidm.example.com/SAAS/API/1.0/GET/admindata"},"metadata_url":{"type":"string","description":"The metadata URL of the SAML Authenticator.","example":"https://vidm.example.com/SAAS/API/1.0/GET/metadata/idp.xml"}},"description":"SAML Authenticator Server Spec."},"SAMLAuthenticatorUpdateSpec":{"required":["label","trigger_mode"],"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for this SAML authenticator. This must specify a protocol (scheme) of http or https.","example":"https://vidm.example.com/saas/api/1.0/GET/admindata"},"certificate":{"type":"string","description":"SAML Authenticator certificate.","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of this SAML authenticator.","example":"Dynamic Saml Authenticator"},"label":{"maxLength":32,"minLength":0,"type":"string","description":"The label for this SAML authenticator. It must be unique among all other SAML authenticators.","example":"vidm.example.com"},"metadata_url":{"type":"string","description":"The metadata URL that this SAML authenticator uses to fetch metadata. This must specify a protocol (scheme) of https. It must be unique among all other SAML authenticators. This is required if authenticator_type is set to DYNAMIC.","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"},"password_mode":{"type":"string","description":"Indicates how password present in SAML assertion is handled if True SSO is triggered. This is required if the trigger_mode is set to ENABLE_ALWAYS or REQUIRE_ALWAYS.\n* REMOVE: Remove any passwords.\n* PASSTHRU: Pass through any passwords.\n* ERROR: Error if there is a password.","example":"REMOVE","enum":["REMOVE","PASSTHRU","ERROR"]},"static_metadata":{"type":"string","description":"The static metadata of a SAML authenticator which contains an entity id, signing keys, and encryption keys for processing SAML authentication. This property is required if authenticator_type is set to STATIC.","example":"<md:EntityDescriptor xmlns:..</md:EntityDescriptor>"},"trigger_mode":{"type":"string","description":"Indicates how True SSO is triggered on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.\n* REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.\n* ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.\n* REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.","example":"DISABLED","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]}},"description":"SAML Authenticator object to be updated."},"SAMLAuthenticatorUpdateSpecV2":{"required":["label","require_encrypted_assertions","trigger_mode"],"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for this SAML authenticator. This must specify a protocol (scheme) of http or https.","example":"https://vidm.example.com/saas/api/1.0/GET/admindata"},"certificate":{"type":"string","description":"SAML Authenticator certificate.","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of this SAML authenticator.","example":"Dynamic Saml Authenticator"},"label":{"maxLength":32,"minLength":0,"type":"string","description":"The label for this SAML authenticator. It must be unique among all other SAML authenticators.","example":"vidm.example.com"},"metadata_url":{"type":"string","description":"The metadata URL that this SAML authenticator uses to fetch metadata. This must specify a protocol (scheme) of https. It must be unique among all other SAML authenticators. This is required if authenticator_type is set to DYNAMIC.","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"},"password_mode":{"type":"string","description":"Indicates how password present in SAML assertion is handled if True SSO is triggered. This is required if the trigger_mode is set to ENABLE_ALWAYS or REQUIRE_ALWAYS.\n* REMOVE: Remove any passwords.\n* PASSTHRU: Pass through any passwords.\n* ERROR: Error if there is a password.","example":"REMOVE","enum":["REMOVE","PASSTHRU","ERROR"]},"require_encrypted_assertions":{"type":"boolean","description":"enforcing the Encrypted Assertion coming from the Identity Provider."},"static_metadata":{"type":"string","description":"The static metadata of a SAML authenticator which contains an entity id, signing keys, and encryption keys for processing SAML authentication. This property is required if authenticator_type is set to STATIC.","example":"<md:EntityDescriptor xmlns:..</md:EntityDescriptor>"},"trigger_mode":{"type":"string","description":"Indicates how True SSO is triggered on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.\n* REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.\n* ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.\n* REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.","example":"DISABLED","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]}},"description":"SAML Authenticator object to be updated."},"SAMLAuthenticatorUpdateSpecV3":{"required":["force_saml_auth","label","require_encrypted_assertions","trigger_mode","workspace_one_enabled"],"type":"object","properties":{"administrator_url":{"type":"string","description":"The administrator URL for this SAML authenticator. This must specify a protocol (scheme) of http or https.","example":"https://vidm.example.com/saas/api/1.0/GET/admindata"},"certificate":{"type":"string","description":"SAML Authenticator certificate.","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"},"certificate_type":{"type":"string","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","example":"PEM","enum":["PEM","UNKNOWN"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"The description of this SAML authenticator.","example":"Dynamic Saml Authenticator"},"force_saml_auth":{"type":"boolean","description":"This indicates that IDP will force the user to authenticate even if the user is already logged in.","example":true},"label":{"maxLength":32,"minLength":0,"type":"string","description":"The label for this SAML authenticator. It must be unique among all other SAML authenticators.","example":"vidm.example.com"},"metadata_url":{"type":"string","description":"The metadata URL that this SAML authenticator uses to fetch metadata. This must specify a protocol (scheme) of https. It must be unique among all other SAML authenticators. This is required if authenticator_type is set to DYNAMIC.","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"},"password_mode":{"type":"string","description":"Indicates how password present in SAML assertion is handled if True SSO is triggered. This is required if the trigger_mode is set to ENABLE_ALWAYS or REQUIRE_ALWAYS.\n* REMOVE: Remove any passwords.\n* PASSTHRU: Pass through any passwords.\n* ERROR: Error if there is a password.","example":"REMOVE","enum":["REMOVE","PASSTHRU","ERROR"]},"require_encrypted_assertions":{"type":"boolean","description":"enforcing the Encrypted Assertion coming from the Identity Provider."},"static_metadata":{"type":"string","description":"The static metadata of a SAML authenticator which contains an entity id, signing keys, and encryption keys for processing SAML authentication. This property is required if authenticator_type is set to STATIC.","example":"<md:EntityDescriptor xmlns:..</md:EntityDescriptor>"},"trigger_mode":{"type":"string","description":"Indicates how True SSO is triggered on sessions using this authenticator.\n* DISABLED: Do not use True SSO.\n* ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.\n* REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.\n* ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.\n* REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.","example":"DISABLED","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]},"workspace_one_enabled":{"type":"boolean","description":"This indicates that particular Authenticator is for Workspace one or not. If it is true then Authenticator is related to WorkspaceOne","example":true}},"description":"SAML Authenticator object to be updated."},"ScheduleMaintenanceSettings":{"type":"object","properties":{"additional_settings":{"type":"object","additionalProperties":{"type":"string","description":"Additional settings of scheduled maintenance"},"description":"Additional settings of scheduled maintenance"},"immediate_maintenance_scheduled":{"type":"boolean","description":"Indicates whether immediate maintenance is scheduled","example":true},"logoff_policy":{"type":"string","description":"Determines the logoff policy on the active session\n* FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.\n* WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.","example":"FORCE_LOGOFF","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"recurring_maintenance_settings":{"$ref":"#/components/schemas/RecurringMaintenanceSettings"},"start_time":{"type":"integer","description":"Time when maintenance would happen","format":"int64","example":1237081283000},"stop_on_first_error":{"type":"boolean","description":"Indicates whether the operation should stop on the its first error","example":true}},"description":"Schedule maintenance settings for the automated farm"},"SecondaryCredentialCreateSpec":{"required":["domain","owner_id","password","username"],"type":"object","properties":{"domain":{"type":"string","description":"DNS name of one way or two way trusted domain.","example":"AD-TEST-DOMAIN"},"owner_id":{"type":"string","description":"The user sid of the owner of the secondary credential.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"password":{"type":"array","description":"Password for secondary credentials account of the one way or two way trusted domain.","example":"<password>","items":{"type":"string","description":"Password for secondary credentials account of the one way or two way trusted domain.","example":"<password>"}},"username":{"type":"string","description":"Username for secondary credentials account of the one way or two way trusted domain.","example":"administrator"}},"description":"Secondary credential object to be created"},"SecondaryCredentialInfo":{"type":"object","properties":{"ad_distinguished_name":{"type":"string","description":"Distinguished name of secondary user account of the one way or two way trusted domain.\t","example":"CN=user3,CN=Users,DC=test,DC=eng,DC=example,DC=com"},"domain":{"type":"string","description":"DNS name of one way or two way trusted domain.","example":"AD-TEST-DOMAIN"},"id":{"type":"string","description":"The id of the secondary credential account.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"owner_id":{"type":"string","description":"The user sid of the owner of the secondary credential.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"username":{"type":"string","description":"Username for secondary credentials account of the one way or two way trusted domain.","example":"administrator"}},"description":"Information about secondary credentials."},"SecondaryCredentialUpdateSpec":{"required":["password"],"type":"object","properties":{"password":{"type":"array","description":"Password for secondary credentials account of the one way or two way trusted domain.","example":"<password>","items":{"type":"string","description":"Password for secondary credentials account of the one way or two way trusted domain.","example":"<password>"}}},"description":"Password object to be updated."},"SecurityConfigInfo":{"type":"object","properties":{"certificate_properties":{"$ref":"#/components/schemas/CertificateProperties"},"connection_server_security_config":{"$ref":"#/components/schemas/SecurityConfiguration"},"secure_gateway_security_config":{"$ref":"#/components/schemas/SecurityConfiguration"}},"description":"Security configuration of connection server and secure gateway."},"SecurityConfiguration":{"type":"object","properties":{"client_properties":{"$ref":"#/components/schemas/ClientProperties"},"server_properties":{"$ref":"#/components/schemas/ServerProperties"}},"description":"Client and server properties of Security configuration."},"SecurityGatewayData":{"type":"object","properties":{"address":{"type":"string","description":"IP address of the security gateway. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"127.0.0.1"},"domain_name":{"type":"string","description":"Computer machine name or DNS name of the security gateway. \nThis property need not be set.<br>Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"SECURE-GW.example.com"},"location":{"type":"string","description":"Location of the security gateway. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* EXTERNAL: Gateway location is external.\n* INTERNAL: Gateway location is internal.\n* UNKNOWN: Gateway location is unknown.","example":"EXTERNAL","enum":["EXTERNAL","INTERNAL","UNKNOWN"]}},"description":"Security gateway data associated with the session."},"SecuritySettings":{"type":"object","properties":{"cluster_public_key":{"type":"string","description":"The Base 64 encoded public key of the cluster in PEM format.","example":"3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c"},"cluster_public_key_id":{"type":"string","description":"Key Id to identify the cluster's active key pair.","example":"cluster key"},"data_recovery_password_configured":{"type":"boolean","description":"Indicates whether the backup recovery password has been configured.","example":true},"message_security_mode":{"type":"string","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"ENABLED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"message_security_status":{"type":"string","description":"The status of the JMS message security. This tracks the application of changes to messageSecurityMode.\n* NOTSET: The cluster is performing at the specified message security mode.\n* ENHANCED: The Cluster is in Enhanced message security mode.\n* WAITING_FOR_BUS_RESTARTS: The cluster is waiting for the bus restart The cluster is waiting for a bus restart to transition to ENHANCED messagesecurity mode or from ENHANCED message security mode .\n* PENDING_ENHANCED: The cluster is propagating the change to ENHANCED message security mode to all nodes.\n* LEAVING_ENHANCED: The cluster is leaving the ENHANCED message security mode.\n* PREPARING_ENHANCED: The cluster is preparing to go in Enhanced mode.\n* DISABLED: Message security mode is disabled.\n* MIXED: Message security mode is enabled but not enforced.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.","example":"NOTSET","enum":["NOTSET","ENHANCED","WAITING_FOR_BUS_RESTARTS","PENDING_ENHANCED","LEAVING_ENHANCED","PREPARING_ENHANCED","DISABLED","MIXED","ENABLED"]},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","description":"Determines if user credentials must be re-authenticated after a network interruption when Horizon clients use secure tunnel connections to Horizon resources. When you select this setting, if a secure tunnel connection ends during a session, Horizon Client requires the user to re-authenticate before reconnecting.","example":true}},"description":"Information related to Security Settings."},"SecuritySettingsUpdateSpec":{"required":["message_security_mode"],"type":"object","properties":{"data_recovery_password_hash":{"type":"array","description":"The SHA-384 hash of the (UTF-8) data recovery password.","example":"f39de487a8aed2d19069ed7a7bcfc274e9f026bba97c8f059be6a2e5eed051d7ee437b93d80aa6163bf8039543b612dd","items":{"type":"string","description":"The SHA-384 hash of the (UTF-8) data recovery password.","example":"f39de487a8aed2d19069ed7a7bcfc274e9f026bba97c8f059be6a2e5eed051d7ee437b93d80aa6163bf8039543b612dd"}},"data_recovery_password_hint":{"type":"string","description":"The data recovery password hint. This property has a maximum length of 128 characters.","example":"password hint"},"message_security_mode":{"type":"string","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"ENABLED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","description":"Determines if user credentials must be re-authenticated after a network interruption when Horizon clients use secure tunnel connections to Horizon resources. When you select this setting, if a secure tunnel connection ends during a session, Horizon Client requires the user to re-authenticate before reconnecting.","example":true}},"description":"Security settings object to be updated."},"SecuritySettingsUpdateSpecV3":{"required":["message_security_mode"],"type":"object","properties":{"cert_auth_mapping":{"uniqueItems":true,"type":"array","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":["x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%","x509:<I>%issuer_dn%<SR>%serial%"],"items":{"type":"string","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":"[\"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%\",\"x509:<I>%issuer_dn%<SR>%serial%\"]"}},"cert_auth_mapping_control":{"uniqueItems":true,"type":"array","description":"Indicates the type of search for validating the Smart card.","example":["CUSTOM","SID"],"items":{"type":"string","description":"* LEGACY: Certificate validation on LEGACY.","example":"[\"CUSTOM\",\"SID\"]","enum":["SID","CUSTOM","LEGACY"]}},"data_recovery_password_hash":{"type":"array","description":"The SHA-384 hash of the (UTF-8) data recovery password.","example":"f39de487a8aed2d19069ed7a7bcfc274e9f026bba97c8f059be6a2e5eed051d7ee437b93d80aa6163bf8039543b612dd","items":{"type":"string","description":"The SHA-384 hash of the (UTF-8) data recovery password.","example":"f39de487a8aed2d19069ed7a7bcfc274e9f026bba97c8f059be6a2e5eed051d7ee437b93d80aa6163bf8039543b612dd"}},"data_recovery_password_hint":{"type":"string","description":"The data recovery password hint. This property has a maximum length of 128 characters.","example":"password hint"},"message_security_mode":{"type":"string","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"ENABLED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","description":"Determines if user credentials must be re-authenticated after a network interruption when Horizon clients use secure tunnel connections to Horizon resources. When you select this setting, if a secure tunnel connection ends during a session, Horizon Client requires the user to re-authenticate before reconnecting.","example":true}},"description":"Security settings object to be updated."},"SecuritySettingsUpdateSpecV4":{"required":["message_security_mode"],"type":"object","properties":{"cert_auth_mapping":{"uniqueItems":true,"type":"array","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":["x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%","x509:<I>%issuer_dn%<SR>%serial%"],"items":{"type":"string","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":"[\"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%\",\"x509:<I>%issuer_dn%<SR>%serial%\"]"}},"cert_auth_mapping_control":{"uniqueItems":true,"type":"array","description":"Indicates the type of search for validating the Smart card.","example":["CUSTOM","SID"],"items":{"type":"string","description":"* LEGACY: Certificate validation on LEGACY.","example":"[\"CUSTOM\",\"SID\"]","enum":["SID","CUSTOM","LEGACY"]}},"crl_distribution_points":{"uniqueItems":true,"type":"array","description":"List of CRL distribution point urls, from where CRLs will be fetched by crl prefetch service.It supports only http url and .crl and .pem file type.","example":["http://www.cdpexample.com/file.crl","http://crls.pki.goog/gts1c3/file1.pem"],"items":{"type":"string","description":"List of CRL distribution point urls, from where CRLs will be fetched by crl prefetch service.It supports only http url and .crl and .pem file type.","example":"[\"http://www.cdpexample.com/file.crl\",\"http://crls.pki.goog/gts1c3/file1.pem\"]"}},"crl_file_max_size_kb":{"minimum":0,"type":"integer","description":"Maximum allowed size in kb for CRL file that can be downloaded by crl prefetch service. This property has a default value of 1024.","format":"int32","example":1024},"crl_refresh_period_minutes":{"minimum":0,"type":"integer","description":"Refresh time period in minutes for CRL prefetch. This property has a default value of 60.","format":"int32","example":100},"data_recovery_password_hash":{"type":"array","description":"The SHA-384 hash of the (UTF-8) data recovery password.","example":"f39de487a8aed2d19069ed7a7bcfc274e9f026bba97c8f059be6a2e5eed051d7ee437b93d80aa6163bf8039543b612dd","items":{"type":"string","description":"The SHA-384 hash of the (UTF-8) data recovery password.","example":"f39de487a8aed2d19069ed7a7bcfc274e9f026bba97c8f059be6a2e5eed051d7ee437b93d80aa6163bf8039543b612dd"}},"data_recovery_password_hint":{"type":"string","description":"The data recovery password hint. This property has a maximum length of 128 characters.","example":"password hint"},"message_security_mode":{"type":"string","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"ENABLED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","description":"Determines if user credentials must be re-authenticated after a network interruption when Horizon clients use secure tunnel connections to Horizon resources. When you select this setting, if a secure tunnel connection ends during a session, Horizon Client requires the user to re-authenticate before reconnecting.","example":true}},"description":"Security settings object to be updated."},"SecuritySettingsUpdateSpecV5":{"required":["message_security_mode"],"type":"object","properties":{"cert_auth_mapping":{"uniqueItems":true,"type":"array","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":["x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%","x509:<I>%issuer_dn%<SR>%serial%"],"items":{"type":"string","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":"[\"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%\",\"x509:<I>%issuer_dn%<SR>%serial%\"]"}},"cert_auth_mapping_control":{"uniqueItems":true,"type":"array","description":"Indicates the type of search for validating the Smart card.","example":["CUSTOM","SID"],"items":{"type":"string","description":"* LEGACY: Certificate validation on LEGACY.","example":"[\"CUSTOM\",\"SID\"]","enum":["SID","CUSTOM","LEGACY"]}},"crl_distribution_points":{"uniqueItems":true,"type":"array","description":"List of CRL distribution point urls, from where CRLs will be fetched by crl prefetch service.It supports only http url and .crl and .pem file type.","example":["http://www.cdpexample.com/file.crl","http://crls.pki.goog/gts1c3/file1.pem"],"items":{"type":"string","description":"List of CRL distribution point urls, from where CRLs will be fetched by crl prefetch service.It supports only http url and .crl and .pem file type.","example":"[\"http://www.cdpexample.com/file.crl\",\"http://crls.pki.goog/gts1c3/file1.pem\"]"}},"crl_file_max_size_kb":{"minimum":0,"type":"integer","description":"Maximum allowed size in kb for CRL file that can be downloaded by crl prefetch service. This property has a default value of 1024.","format":"int32","example":1024},"crl_refresh_period_minutes":{"minimum":0,"type":"integer","description":"Refresh time period in minutes for CRL prefetch. This property has a default value of 60.","format":"int32","example":100},"data_recovery_password_hash":{"type":"array","description":"The SHA-384 hash of the (UTF-8) data recovery password.","example":"f39de487a8aed2d19069ed7a7bcfc274e9f026bba97c8f059be6a2e5eed051d7ee437b93d80aa6163bf8039543b612dd","items":{"type":"string","description":"The SHA-384 hash of the (UTF-8) data recovery password.","example":"f39de487a8aed2d19069ed7a7bcfc274e9f026bba97c8f059be6a2e5eed051d7ee437b93d80aa6163bf8039543b612dd"}},"data_recovery_password_hint":{"type":"string","description":"The data recovery password hint. This property has a maximum length of 128 characters.","example":"password hint"},"enforce_strong_auth":{"type":"boolean","description":"Indicates whether access restriction to pool based on auth strength should be enforced.\nDefault value is false."},"message_security_mode":{"type":"string","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"ENABLED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","description":"Determines if user credentials must be re-authenticated after a network interruption when Horizon clients use secure tunnel connections to Horizon resources. When you select this setting, if a secure tunnel connection ends during a session, Horizon Client requires the user to re-authenticate before reconnecting.","example":true},"strong_auth_types":{"uniqueItems":true,"type":"array","description":"Indicates the set of end user authentication types considered strong.","items":{"type":"string","description":"* USERNAME_PASSWORD: Windows username password authentication.\n* CERTIFICATE: Certificate authentication.\n* GSSAPI: GSSAPI authentication.\n* RADIUS: RADIUS authentication.\n* SAML: SAML authentication.\n* RSA_SECURID: RSA SecurID authentication.\n* JWT: JWT authentication.","enum":["USERNAME_PASSWORD","CERTIFICATE","GSSAPI","RADIUS","SAML","RSA_SECURID","JWT"]}}},"description":"Security settings object to be updated."},"SecuritySettingsV2":{"type":"object","properties":{"cluster_public_key":{"type":"string","description":"The Base 64 encoded public key of the cluster in PEM format.","example":"3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c"},"cluster_public_key_id":{"type":"string","description":"Key Id to identify the cluster's active key pair.","example":"cluster key"},"data_recovery_password_configured":{"type":"boolean","description":"Indicates whether the backup recovery password has been configured.","example":true},"getdisallowEnhancedSecurityMode":{"type":"boolean","description":"If true, Enhanced message security mode is disallowed (FIPS mode only). If set when Enhanced message security mode is in force, this will cause an automatic transition to Enabled mode. ","example":true},"message_security_mode":{"type":"string","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"ENABLED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"message_security_status":{"type":"string","description":"The status of the JMS message security. This tracks the application of changes to messageSecurityMode.\n* NOTSET: The cluster is performing at the specified message security mode.\n* ENHANCED: The Cluster is in Enhanced message security mode.\n* WAITING_FOR_BUS_RESTARTS: The cluster is waiting for the bus restart The cluster is waiting for a bus restart to transition to ENHANCED messagesecurity mode or from ENHANCED message security mode .\n* PENDING_ENHANCED: The cluster is propagating the change to ENHANCED message security mode to all nodes.\n* LEAVING_ENHANCED: The cluster is leaving the ENHANCED message security mode.\n* PREPARING_ENHANCED: The cluster is preparing to go in Enhanced mode.\n* DISABLED: Message security mode is disabled.\n* MIXED: Message security mode is enabled but not enforced.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.","example":"NOTSET","enum":["NOTSET","ENHANCED","WAITING_FOR_BUS_RESTARTS","PENDING_ENHANCED","LEAVING_ENHANCED","PREPARING_ENHANCED","DISABLED","MIXED","ENABLED"]},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","description":"Determines if user credentials must be re-authenticated after a network interruption when Horizon clients use secure tunnel connections to Horizon resources. When you select this setting, if a secure tunnel connection ends during a session, Horizon Client requires the user to re-authenticate before reconnecting.","example":true}},"description":"Information related to Security Settings."},"SecuritySettingsV3":{"type":"object","properties":{"cert_auth_mapping":{"uniqueItems":true,"type":"array","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":["x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%","x509:<I>%issuer_dn%<SR>%serial%"],"items":{"type":"string","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":"[\"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%\",\"x509:<I>%issuer_dn%<SR>%serial%\"]"}},"cert_auth_mapping_control":{"uniqueItems":true,"type":"array","description":"Indicates the type of search for validating the smart card.","example":["CUSTOM","SID"],"items":{"type":"string","description":"* LEGACY: Certificate validation on LEGACY.","example":"[\"CUSTOM\",\"SID\"]","enum":["SID","CUSTOM","LEGACY"]}},"cert_auth_mapping_names":{"type":"array","description":"List of all supported certificate properties.","example":["issuer_dn","subject_dn","san_dns"],"items":{"type":"string","description":"List of all supported certificate properties.","example":"[\"issuer_dn\",\"subject_dn\",\"san_dns\"]"}},"cluster_public_key":{"type":"string","description":"The Base 64 encoded public key of the cluster in PEM format.","example":"3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c"},"cluster_public_key_id":{"type":"string","description":"Key Id to identify the cluster's active key pair.","example":"cluster key"},"data_recovery_password_configured":{"type":"boolean","description":"Indicates whether the backup recovery password has been configured.","example":true},"getdisallowEnhancedSecurityMode":{"type":"boolean","description":"If true, Enhanced message security mode is disallowed (FIPS mode only). If set when Enhanced message security mode is in force, this will cause an automatic transition to Enabled mode. ","example":true},"message_security_mode":{"type":"string","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"ENABLED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"message_security_status":{"type":"string","description":"The status of the JMS message security. This tracks the application of changes to messageSecurityMode.\n* NOTSET: The cluster is performing at the specified message security mode.\n* ENHANCED: The Cluster is in Enhanced message security mode.\n* WAITING_FOR_BUS_RESTARTS: The cluster is waiting for the bus restart The cluster is waiting for a bus restart to transition to ENHANCED messagesecurity mode or from ENHANCED message security mode .\n* PENDING_ENHANCED: The cluster is propagating the change to ENHANCED message security mode to all nodes.\n* LEAVING_ENHANCED: The cluster is leaving the ENHANCED message security mode.\n* PREPARING_ENHANCED: The cluster is preparing to go in Enhanced mode.\n* DISABLED: Message security mode is disabled.\n* MIXED: Message security mode is enabled but not enforced.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.","example":"NOTSET","enum":["NOTSET","ENHANCED","WAITING_FOR_BUS_RESTARTS","PENDING_ENHANCED","LEAVING_ENHANCED","PREPARING_ENHANCED","DISABLED","MIXED","ENABLED"]},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","description":"Determines if user credentials must be re-authenticated after a network interruption when Horizon clients use secure tunnel connections to Horizon resources. When you select this setting, if a secure tunnel connection ends during a session, Horizon Client requires the user to re-authenticate before reconnecting.","example":true}},"description":"Information related to Security Settings."},"SecuritySettingsV4":{"type":"object","properties":{"cert_auth_mapping":{"uniqueItems":true,"type":"array","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":["x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%","x509:<I>%issuer_dn%<SR>%serial%"],"items":{"type":"string","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":"[\"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%\",\"x509:<I>%issuer_dn%<SR>%serial%\"]"}},"cert_auth_mapping_control":{"uniqueItems":true,"type":"array","description":"Indicates the type of search for validating the smart card.","example":["CUSTOM","SID"],"items":{"type":"string","description":"* LEGACY: Certificate validation on LEGACY.","example":"[\"CUSTOM\",\"SID\"]","enum":["SID","CUSTOM","LEGACY"]}},"cert_auth_mapping_names":{"type":"array","description":"List of all supported certificate properties.","example":["issuer_dn","subject_dn","san_dns"],"items":{"type":"string","description":"List of all supported certificate properties.","example":"[\"issuer_dn\",\"subject_dn\",\"san_dns\"]"}},"cluster_public_key":{"type":"string","description":"The Base 64 encoded public key of the cluster in PEM format.","example":"3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c"},"cluster_public_key_id":{"type":"string","description":"Key Id to identify the cluster's active key pair.","example":"cluster key"},"crl_distribution_points":{"uniqueItems":true,"type":"array","description":"List of CRL distribution point urls, from where CRLs will be fetched by crl prefetch service.","example":["http://www.cdpexample.com/file.crl","http://crls.pki.goog/gts1c3/file1.pem"],"items":{"type":"string","description":"List of CRL distribution point urls, from where CRLs will be fetched by crl prefetch service.","example":"[\"http://www.cdpexample.com/file.crl\",\"http://crls.pki.goog/gts1c3/file1.pem\"]"}},"crl_file_max_size_kb":{"type":"integer","description":"Maximum allowed size in kb for CRL file that can be downloaded by crl prefetch service.","format":"int32","example":1024},"crl_refresh_period_minutes":{"type":"integer","description":"Refresh time period in minutes for CRL prefetch.","format":"int32","example":100},"data_recovery_password_configured":{"type":"boolean","description":"Indicates whether the backup recovery password has been configured.","example":true},"getdisallowEnhancedSecurityMode":{"type":"boolean","description":"If true, Enhanced message security mode is disallowed (FIPS mode only). If set when Enhanced message security mode is in force, this will cause an automatic transition to Enabled mode. ","example":true},"message_security_mode":{"type":"string","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"ENABLED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"message_security_status":{"type":"string","description":"The status of the JMS message security. This tracks the application of changes to messageSecurityMode.\n* NOTSET: The cluster is performing at the specified message security mode.\n* ENHANCED: The Cluster is in Enhanced message security mode.\n* WAITING_FOR_BUS_RESTARTS: The cluster is waiting for the bus restart The cluster is waiting for a bus restart to transition to ENHANCED messagesecurity mode or from ENHANCED message security mode .\n* PENDING_ENHANCED: The cluster is propagating the change to ENHANCED message security mode to all nodes.\n* LEAVING_ENHANCED: The cluster is leaving the ENHANCED message security mode.\n* PREPARING_ENHANCED: The cluster is preparing to go in Enhanced mode.\n* DISABLED: Message security mode is disabled.\n* MIXED: Message security mode is enabled but not enforced.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.","example":"NOTSET","enum":["NOTSET","ENHANCED","WAITING_FOR_BUS_RESTARTS","PENDING_ENHANCED","LEAVING_ENHANCED","PREPARING_ENHANCED","DISABLED","MIXED","ENABLED"]},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","description":"Determines if user credentials must be re-authenticated after a network interruption when Horizon clients use secure tunnel connections to Horizon resources. When you select this setting, if a secure tunnel connection ends during a session, Horizon Client requires the user to re-authenticate before reconnecting.","example":true}},"description":"Information related to Security Settings."},"SecuritySettingsV5":{"type":"object","properties":{"cert_auth_mapping":{"uniqueItems":true,"type":"array","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":["x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%","x509:<I>%issuer_dn%<SR>%serial%"],"items":{"type":"string","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":"[\"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%\",\"x509:<I>%issuer_dn%<SR>%serial%\"]"}},"cert_auth_mapping_control":{"uniqueItems":true,"type":"array","description":"Indicates the type of search for validating the smart card.","example":["CUSTOM","SID"],"items":{"type":"string","description":"* LEGACY: Certificate validation on LEGACY.","example":"[\"CUSTOM\",\"SID\"]","enum":["SID","CUSTOM","LEGACY"]}},"cert_auth_mapping_names":{"type":"array","description":"List of all supported certificate properties.","example":["issuer_dn","subject_dn","san_dns"],"items":{"type":"string","description":"List of all supported certificate properties.","example":"[\"issuer_dn\",\"subject_dn\",\"san_dns\"]"}},"cluster_public_key":{"type":"string","description":"The Base 64 encoded public key of the cluster in PEM format.","example":"3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c"},"cluster_public_key_id":{"type":"string","description":"Key Id to identify the cluster's active key pair.","example":"cluster key"},"crl_distribution_points":{"uniqueItems":true,"type":"array","description":"List of CRL distribution point urls, from where CRLs will be fetched by crl prefetch service.","example":["http://www.cdpexample.com/file.crl","http://crls.pki.goog/gts1c3/file1.pem"],"items":{"type":"string","description":"List of CRL distribution point urls, from where CRLs will be fetched by crl prefetch service.","example":"[\"http://www.cdpexample.com/file.crl\",\"http://crls.pki.goog/gts1c3/file1.pem\"]"}},"crl_file_max_size_kb":{"type":"integer","description":"Maximum allowed size in kb for CRL file that can be downloaded by crl prefetch service.","format":"int32","example":1024},"crl_refresh_period_minutes":{"type":"integer","description":"Refresh time period in minutes for CRL prefetch.","format":"int32","example":100},"data_recovery_password_configured":{"type":"boolean","description":"Indicates whether the backup recovery password has been configured.","example":true},"data_recovery_password_hint":{"type":"string","description":"The data recovery password hint. This property has a maximum length of 128 characters.","example":"password hint"},"getdisallowEnhancedSecurityMode":{"type":"boolean","description":"If true, Enhanced message security mode is disallowed (FIPS mode only). If set when Enhanced message security mode is in force, this will cause an automatic transition to Enabled mode. ","example":true},"message_security_mode":{"type":"string","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"ENABLED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"message_security_status":{"type":"string","description":"The status of the JMS message security. This tracks the application of changes to messageSecurityMode.\n* NOTSET: The cluster is performing at the specified message security mode.\n* ENHANCED: The Cluster is in Enhanced message security mode.\n* WAITING_FOR_BUS_RESTARTS: The cluster is waiting for the bus restart The cluster is waiting for a bus restart to transition to ENHANCED messagesecurity mode or from ENHANCED message security mode .\n* PENDING_ENHANCED: The cluster is propagating the change to ENHANCED message security mode to all nodes.\n* LEAVING_ENHANCED: The cluster is leaving the ENHANCED message security mode.\n* PREPARING_ENHANCED: The cluster is preparing to go in Enhanced mode.\n* DISABLED: Message security mode is disabled.\n* MIXED: Message security mode is enabled but not enforced.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.","example":"NOTSET","enum":["NOTSET","ENHANCED","WAITING_FOR_BUS_RESTARTS","PENDING_ENHANCED","LEAVING_ENHANCED","PREPARING_ENHANCED","DISABLED","MIXED","ENABLED"]},"no_managed_certs":{"type":"boolean","description":"Reserved for future use Default value: false","example":false},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","description":"Determines if user credentials must be re-authenticated after a network interruption when Horizon clients use secure tunnel connections to Horizon resources. When you select this setting, if a secure tunnel connection ends during a session, Horizon Client requires the user to re-authenticate before reconnecting.","example":true}},"description":"Information related to Security Settings."},"SecuritySettingsV6":{"type":"object","properties":{"cert_auth_mapping":{"uniqueItems":true,"type":"array","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":["x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%","x509:<I>%issuer_dn%<SR>%serial%"],"items":{"type":"string","description":"Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.","example":"[\"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%\",\"x509:<I>%issuer_dn%<SR>%serial%\"]"}},"cert_auth_mapping_control":{"uniqueItems":true,"type":"array","description":"Indicates the type of search for validating the smart card.","example":["CUSTOM","SID"],"items":{"type":"string","description":"* LEGACY: Certificate validation on LEGACY.","example":"[\"CUSTOM\",\"SID\"]","enum":["SID","CUSTOM","LEGACY"]}},"cert_auth_mapping_names":{"type":"array","description":"List of all supported certificate properties.","example":["issuer_dn","subject_dn","san_dns"],"items":{"type":"string","description":"List of all supported certificate properties.","example":"[\"issuer_dn\",\"subject_dn\",\"san_dns\"]"}},"cluster_public_key":{"type":"string","description":"The Base 64 encoded public key of the cluster in PEM format.","example":"3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c"},"cluster_public_key_id":{"type":"string","description":"Key Id to identify the cluster's active key pair.","example":"cluster key"},"crl_distribution_points":{"uniqueItems":true,"type":"array","description":"List of CRL distribution point urls, from where CRLs will be fetched by crl prefetch service.","example":["http://www.cdpexample.com/file.crl","http://crls.pki.goog/gts1c3/file1.pem"],"items":{"type":"string","description":"List of CRL distribution point urls, from where CRLs will be fetched by crl prefetch service.","example":"[\"http://www.cdpexample.com/file.crl\",\"http://crls.pki.goog/gts1c3/file1.pem\"]"}},"crl_file_max_size_kb":{"type":"integer","description":"Maximum allowed size in kb for CRL file that can be downloaded by crl prefetch service.","format":"int32","example":1024},"crl_refresh_period_minutes":{"type":"integer","description":"Refresh time period in minutes for CRL prefetch.","format":"int32","example":100},"data_recovery_password_configured":{"type":"boolean","description":"Indicates whether the backup recovery password has been configured.","example":true},"data_recovery_password_hint":{"type":"string","description":"The data recovery password hint. This property has a maximum length of 128 characters.","example":"password hint"},"enforce_strong_auth":{"type":"boolean","description":"Indicates whether access restriction to pool based on auth strength should be enforced."},"getdisallowEnhancedSecurityMode":{"type":"boolean","description":"If true, Enhanced message security mode is disallowed (FIPS mode only). If set when Enhanced message security mode is in force, this will cause an automatic transition to Enabled mode. ","example":true},"message_security_mode":{"type":"string","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\n* DISABLED: Message security mode is disabled.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.\n* MIXED: Message security mode is enabled but not enforced.","example":"ENABLED","enum":["DISABLED","ENABLED","ENHANCED","MIXED"]},"message_security_status":{"type":"string","description":"The status of the JMS message security. This tracks the application of changes to messageSecurityMode.\n* NOTSET: The cluster is performing at the specified message security mode.\n* ENHANCED: The Cluster is in Enhanced message security mode.\n* WAITING_FOR_BUS_RESTARTS: The cluster is waiting for the bus restart The cluster is waiting for a bus restart to transition to ENHANCED messagesecurity mode or from ENHANCED message security mode .\n* PENDING_ENHANCED: The cluster is propagating the change to ENHANCED message security mode to all nodes.\n* LEAVING_ENHANCED: The cluster is leaving the ENHANCED message security mode.\n* PREPARING_ENHANCED: The cluster is preparing to go in Enhanced mode.\n* DISABLED: Message security mode is disabled.\n* MIXED: Message security mode is enabled but not enforced.\n* ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.","example":"NOTSET","enum":["NOTSET","ENHANCED","WAITING_FOR_BUS_RESTARTS","PENDING_ENHANCED","LEAVING_ENHANCED","PREPARING_ENHANCED","DISABLED","MIXED","ENABLED"]},"no_managed_certs":{"type":"boolean","description":"Reserved for future use Default value: false","example":false},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","description":"Determines if user credentials must be re-authenticated after a network interruption when Horizon clients use secure tunnel connections to Horizon resources. When you select this setting, if a secure tunnel connection ends during a session, Horizon Client requires the user to re-authenticate before reconnecting.","example":true},"strong_auth_types":{"uniqueItems":true,"type":"array","description":"Indicates the set of end user authentication types considered strong.","items":{"type":"string","description":"* USERNAME_PASSWORD: Windows username password authentication.\n* CERTIFICATE: Certificate authentication.\n* GSSAPI: GSSAPI authentication.\n* RADIUS: RADIUS authentication.\n* SAML: SAML authentication.\n* RSA_SECURID: RSA SecurID authentication.\n* JWT: JWT authentication.","enum":["USERNAME_PASSWORD","CERTIFICATE","GSSAPI","RADIUS","SAML","RSA_SECURID","JWT"]}}},"description":"Information related to Security Settings."},"ServerDetailsSpec":{"required":["password","server_name","user_name"],"type":"object","properties":{"certificate_thumbprint":{"$ref":"#/components/schemas/CertificateThumbprintSpec"},"password":{"type":"array","description":"Password to use for the connection","example":"<password>","items":{"type":"string","description":"Password to use for the connection","example":"<password>"}},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port of the virtual center to connect to.","format":"int32","example":443},"server_name":{"type":"string","description":"Virtual Center’s server name or IP address","example":"vc1.example.com"},"user_name":{"type":"string","description":"User name to use for the connection.","example":"administrator@vsphere.local"}},"description":"Server information."},"ServerKeyDerivationInfo":{"type":"object","properties":{"client_reference_id":{"type":"string","description":"Client reference identifier which is required to be passed as query param to login api, to enable decryption of encrypted sensitive information.","example":"855ea6c5-720a-41e1-96f4-958c90e6e424"},"identifier":{"type":"string","format":"byte"},"proof":{"type":"string","format":"byte"},"public_key":{"type":"string","format":"byte"},"scheme":{"type":"string","description":"Selected scheme for key derivation.\n* SCHEME_AES1: Diffie Hellman algo used by low power clients.\n* SCHEME_AES2: Diffie Hellman algo used by high power clients.\n* SCHEME_EC_AES1: Elliptic-curve Diffie Hellman algo used by low power clients.\n* SCHEME_EC_AES2: Elliptic-curve Diffie Hellman algo used by high power clients.","example":"SCHEME-AES2","enum":["SCHEME-AES1","SCHEME-AES2","SCHEME-EC-AES1","SCHEME-EC-AES2"]}},"description":"Server key derivation information."},"ServerProperties":{"type":"object","properties":{"cipher_suites":{"type":"array","description":"List of cipher suites of server.","example":["TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256","TLS_RSA_WITH_AES_128_CBC_SHA256"],"items":{"type":"string","description":"List of cipher suites of server.","example":"[\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\"TLS_RSA_WITH_AES_128_CBC_SHA256\"]"}},"named_groups":{"type":"array","description":"List of named groups of server.","example":["SECP384_R1","FFDHE_4096"],"items":{"type":"string","description":"List of named groups of server.","example":"[\"SECP384_R1\",\"FFDHE_4096\"]"}},"signature_algorithms":{"type":"array","description":"List of signature algorithms of server.","example":["RSA_PSS_RSAE_SHA512","RSA_PKCS1_SHA512","RSA_PKCS1_SHA1"],"items":{"type":"string","description":"List of signature algorithms of server.","example":"[\"RSA_PSS_RSAE_SHA512\",\"RSA_PKCS1_SHA512\",\"RSA_PKCS1_SHA1\"]"}},"thumbprint_algorithms":{"type":"array","description":"List of thumbprint algorithms of server.","example":["SHA_512","SHA_384"],"items":{"type":"string","description":"List of thumbprint algorithms of server.","example":"[\"SHA_512\",\"SHA_384\"]"}}},"description":"Server properties of Security configuration."},"ServerSpec":{"required":["port","server_name"],"type":"object","properties":{"password":{"type":"array","description":"Password to use for the connection. This property is not required if the server is already added.","example":"<password>","items":{"type":"string","description":"Password to use for the connection. This property is not required if the server is already added.","example":"<password>"}},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port of the server to connect to.","format":"int32","example":443},"server_name":{"type":"string","description":"Url of the server without the protocol prefix.","example":"horizon.com"},"username":{"type":"string","description":"User name to use for the connection.","example":"administrator"}},"description":"Server Spec."},"ServiceAccount":{"type":"object","properties":{"owner_id":{"type":"string","description":"The owner of the service account.","example":"S-1-1-1-3965912346-1012345398-3123456564-123"},"status":{"type":"string","description":"The status of the service account.\n* ACTIVE: The service account credentials are working properly.\n* ERROR: The service account credentials are not working.\n* UNKNOWN: Status of the service account credentials is unknown.","example":"ACTIVE","enum":["ACTIVE","ERROR","UNKNOWN"]},"username":{"type":"string","description":"The username of the service account.","example":"USER1"}},"description":"Service accounts for the domain."},"ServiceAccountValidateSpec":{"required":["account_name"],"type":"object","properties":{"account_name":{"type":"string","description":"The fully qualified account name including domain. Supported formats: DOMAIN\\\\accountName or accountName@DOMAIN.","example":"HORIZONCTE\\\\sqlodbcgmsa"},"gmsa":{"type":"boolean","description":"Set to true for gMSA (Group Managed Service Account) validation. For gMSA accounts, no password is required.","example":false},"password":{"type":"array","description":"Optional password for credential validation. If omitted or empty for non-gMSA, the stored LDAP password is used when available; otherwise only account existence is checked.","example":"<password>","items":{"type":"string","description":"Optional password for credential validation. If omitted or empty for non-gMSA, the stored LDAP password is used when available; otherwise only account existence is checked.","example":"<password>"}}},"description":"Service account details to validate."},"ServiceAccountValidationInfo":{"type":"object","properties":{"account_type":{"type":"string","description":"The type of account validated: MANAGED_SA_AUTH for gMSA, DOMAIN_USER_AUTH for non-gMSA.","example":"DOMAIN_USER_AUTH","enum":["MANAGED_SA_AUTH","DOMAIN_USER_AUTH"]},"error_message":{"type":"string","description":"Error message if validation failed."},"resolved_name":{"type":"string","description":"The fully qualified account name on success.","example":"MYDOMAIN\\\\svc_account"},"valid":{"type":"boolean","description":"Whether the validation succeeded.","example":true}},"description":"Result of service account validation."},"ServiceErrorInfo":{"type":"object","properties":{"error_code":{"type":"string"},"service_name":{"type":"string"}},"description":"Information about gateway service errors."},"SessionClientMetrics":{"type":"object","properties":{"num_android_clients":{"type":"integer","description":"The number of sessions whose client type is Android.","format":"int32"},"num_browser_clients":{"type":"integer","description":"The number of sessions whose client type is htmlaccess.","format":"int32"},"num_ios_clients":{"type":"integer","description":"The number of sessions whose client type is iOS.","format":"int32"},"num_linux_clients":{"type":"integer","description":"The number of sessions whose client type is Linux.","format":"int32"},"num_mac_clients":{"type":"integer","description":"The number of sessions whose client type is Mac.","format":"int32"},"num_other_clients":{"type":"integer","description":"The number of sessions whose client type is other.","format":"int32"},"num_windows_clients":{"type":"integer","description":"The number of sessions whose client type is Windows.","format":"int32"}},"description":"The client Metrics for sessions."},"SessionGatewayMetrics":{"type":"object","properties":{"num_external_gateways":{"type":"integer","description":"The number of sessions whose gateway location is external.","format":"int32"},"num_internal_gateways":{"type":"integer","description":"The number of sessions whose gateway location is internal.","format":"int32"},"num_unknown_gateways":{"type":"integer","description":"The number of sessions whose gateway location is unknown. If the agent of a session is not upgraded to required version, the gateway location is unknown, this number is for this type of sessions.","format":"int32"}},"description":"The gateway Metrics for sessions."},"SessionInfo":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id associated with the session. \nFor a non-RDS desktop session, this is the desktop pool's access group id. \nFor an RDS desktop session, this is the RDS desktop pool's farm's access group id. \nFor an application session, this is the application's farm's access group id.<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_version":{"type":"string","description":"Version of agent\nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12.0"},"application_names":{"type":"array","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":["Calculator"],"items":{"type":"string","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":"[\"Calculator\"]"}},"broker_user_id":{"type":"string","description":"User SID for the broker user associated with the session. \nIt will be unset for non-broker sessions.<br>Supported Filters : 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"brokered_remotely":{"type":"boolean","description":"Indicates whether the session is brokered from a remote pod. \nIt is set only if the Horizon View agent where the session resides is version 6.0 or later.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"client_data":{"$ref":"#/components/schemas/ClientData"},"desktop_pool_id":{"type":"string","description":"Unique desktop pool id for the session. \nThis is unset if the session is not brokered through a desktop, such as for direct console access.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"disconnected_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was last disconnected. \nThis will be unset if the session's machine has an error state, or if the session has never been disconnected.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181947320},"farm_id":{"type":"string","description":"Unique farm id for this RDS desktop or application session.\nThis is unset if the session is not brokered through a farm, such as for application sessions or direct console access.<br>Supported Filters : 'Equals'.","example":"0dbd14ba-5795-4141-9cec-128ff6d494b0"},"id":{"type":"string","description":"Unique id representing a session.<br>Supported Filters : 'Equals'.","example":"7cdd624f-37d1-46c1-ab96-695a5d13956f"},"idle_duration":{"type":"integer","description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for.\nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":60},"last_session_duration_ms":{"type":"integer","description":"Duration of the last connection period of the session in milli seconds. If the session is currently connected, this is the duration that the session has been in connected state. If the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":116320},"machine_id":{"type":"string","description":"Unique machine id for the session. \nThis is unset for RDS Desktop or application sessions. If desktop pool id is unset, it is the id of registered un-managed physical machine.<br>Supported Filters : 'Equals'.","example":"a00eda55-708a-4f7d-8cbc-1d1b3a2b5f73"},"rds_server_id":{"type":"string","description":"Unique RDS server id for the RDS desktop or application session.\nThis property need not be set.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"resourced_remotely":{"type":"boolean","description":"Indicates whether the session is running on remote pod resource.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"security_gateway_data":{"$ref":"#/components/schemas/SecurityGatewayData"},"session_protocol":{"type":"string","description":"Protocol for the session. \nIt will be unset for disconnected sessions.<br>Supported Filters : 'Equals', 'Conatins'.\nThis property can be used for sorting.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"PCOIP","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]},"session_state":{"type":"string","description":"State of session.<br>Supported Filters : 'Equals', 'NotEquals', 'Contains'.\nThis property can be used for sorting.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","description":"Type of session.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","example":"APPLICATION","enum":["DESKTOP","APPLICATION"]},"start_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences in between. The first connection time will be shortly after this time. \nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181831000},"unauthenticated":{"type":"boolean","description":"Indicates whether the session is of unauthenticated access user. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"user_id":{"type":"string","description":"Unique SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.<br>Supported Filters : 'Equals', 'Contains', 'StartsWith'.\nThis property can be used for sorting.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"}},"description":"Information related to Session. <br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.<br>See the field description to know the filter types it supports."},"SessionInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id associated with the session. \nFor a non-RDS desktop session, this is the desktop pool's access group id. \nFor an RDS desktop session, this is the RDS desktop pool's farm's access group id. \nFor an application session, this is the application's farm's access group id.<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_version":{"type":"string","description":"Version of agent\nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12.0"},"application_names":{"type":"array","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":["Calculator"],"items":{"type":"string","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":"[\"Calculator\"]"}},"broker_user_id":{"type":"string","description":"User SID for the broker user associated with the session. \nIt will be unset for non-broker sessions.<br>Supported Filters : 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"brokered_remotely":{"type":"boolean","description":"Indicates whether the session is brokered from a remote pod. \nIt is set only if the Horizon View agent where the session resides is version 6.0 or later.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"client_data":{"$ref":"#/components/schemas/ClientData"},"desktop_pool_id":{"type":"string","description":"Unique desktop pool id for the session. \nThis is unset if the session is not brokered through a desktop, such as for direct console access.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"disconnected_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was last disconnected. \nThis will be unset if the session's machine has an error state, or if the session has never been disconnected.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181947320},"farm_id":{"type":"string","description":"Unique farm id for this RDS desktop or application session.\nThis is unset if the session is not brokered through a farm, such as for application sessions or direct console access.<br>Supported Filters : 'Equals'.","example":"0dbd14ba-5795-4141-9cec-128ff6d494b0"},"guid":{"type":"string","description":"common identifier between agent and connection server.\nThis guid does not changes for a particular session during disconnects and reconnects.\n Supported Filters : Equals"},"id":{"type":"string","description":"Unique id representing a session.<br>Supported Filters : 'Equals'.","example":"7cdd624f-37d1-46c1-ab96-695a5d13956f"},"idle_duration":{"type":"integer","description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for.\nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":60},"last_session_duration_ms":{"type":"integer","description":"Duration of the last connection period of the session in milli seconds. If the session is currently connected, this is the duration that the session has been in connected state. If the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":116320},"machine_id":{"type":"string","description":"Unique machine id for the session. \nThis is unset for RDS Desktop or application sessions. If desktop pool id is unset, it is the id of registered un-managed physical machine.<br>Supported Filters : 'Equals'.","example":"a00eda55-708a-4f7d-8cbc-1d1b3a2b5f73"},"rds_server_id":{"type":"string","description":"Unique RDS server id for the RDS desktop or application session.\nThis property need not be set.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"resourced_remotely":{"type":"boolean","description":"Indicates whether the session is running on remote pod resource.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"security_gateway_data":{"$ref":"#/components/schemas/SecurityGatewayData"},"session_protocol":{"type":"string","description":"Protocol for the session. \nIt will be unset for disconnected sessions.<br>Supported Filters : 'Equals', 'Conatins'.\nThis property can be used for sorting.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"PCOIP","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]},"session_state":{"type":"string","description":"State of session.<br>Supported Filters : 'Equals', 'NotEquals', 'Contains'.\nThis property can be used for sorting.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","description":"Type of session.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","example":"APPLICATION","enum":["DESKTOP","APPLICATION"]},"start_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences in between. The first connection time will be shortly after this time. \nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181831000},"unauthenticated":{"type":"boolean","description":"Indicates whether the session is of unauthenticated access user. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"user_id":{"type":"string","description":"Unique SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.<br>Supported Filters : 'Equals', 'Contains', 'StartsWith'.\nThis property can be used for sorting.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"}},"description":"Information related to Session. <br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.<br>See the field description to know the filter types it supports."},"SessionInfoV3":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id associated with the session. \nFor a non-RDS desktop session, this is the desktop pool's access group id. \nFor an RDS desktop session, this is the RDS desktop pool's farm's access group id. \nFor an application session, this is the application's farm's access group id.<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_version":{"type":"string","description":"Version of agent\nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12.0"},"application_names":{"type":"array","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":["Calculator"],"items":{"type":"string","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":"[\"Calculator\"]"}},"broker_user_id":{"type":"string","description":"User SID for the broker user associated with the session. \nIt will be unset for non-broker sessions.<br>Supported Filters : 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"brokered_remotely":{"type":"boolean","description":"Indicates whether the session is brokered from a remote pod. \nIt is set only if the Horizon View agent where the session resides is version 6.0 or later.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"client_data":{"$ref":"#/components/schemas/ClientData"},"desktop_pool_id":{"type":"string","description":"Unique desktop pool id for the session. \nThis is unset if the session is not brokered through a desktop, such as for direct console access.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"disconnected_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was last disconnected. \nThis will be unset if the session's machine has an error state, or if the session has never been disconnected.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181947320},"farm_id":{"type":"string","description":"Unique farm id for this RDS desktop or application session.\nThis is unset if the session is not brokered through a farm, such as for application sessions or direct console access.<br>Supported Filters : 'Equals'.","example":"0dbd14ba-5795-4141-9cec-128ff6d494b0"},"guid":{"type":"string","description":"common identifier between agent and connection server.\nThis guid does not changes for a particular session during disconnects and reconnects.\n Supported Filters : Equals"},"id":{"type":"string","description":"Unique id representing a session.<br>Supported Filters : 'Equals'.","example":"7cdd624f-37d1-46c1-ab96-695a5d13956f"},"idle_duration":{"type":"integer","description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for.\nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":60},"internal_session_id":{"type":"string","description":"Internal session Id Supported Filters : Equals","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A="},"last_session_duration_ms":{"type":"integer","description":"Duration of the last connection period of the session in milli seconds. If the session is currently connected, this is the duration that the session has been in connected state. If the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":116320},"machine_id":{"type":"string","description":"Unique machine id for the session. \nThis is unset for RDS Desktop or application sessions. If desktop pool id is unset, it is the id of registered un-managed physical machine.<br>Supported Filters : 'Equals'.","example":"a00eda55-708a-4f7d-8cbc-1d1b3a2b5f73"},"rds_server_id":{"type":"string","description":"Unique RDS server id for the RDS desktop or application session.\nThis property need not be set.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"resourced_remotely":{"type":"boolean","description":"Indicates whether the session is running on remote pod resource.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"security_gateway_data":{"$ref":"#/components/schemas/SecurityGatewayData"},"session_protocol":{"type":"string","description":"Protocol for the session. \nIt will be unset for disconnected sessions.<br>Supported Filters : 'Equals', 'Conatins'.\nThis property can be used for sorting.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"PCOIP","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]},"session_state":{"type":"string","description":"State of session.<br>Supported Filters : 'Equals', 'NotEquals', 'Contains'.\nThis property can be used for sorting.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","description":"Type of session.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","example":"APPLICATION","enum":["DESKTOP","APPLICATION"]},"start_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences in between. The first connection time will be shortly after this time. \nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181831000},"unauthenticated":{"type":"boolean","description":"Indicates whether the session is of unauthenticated access user. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"user_id":{"type":"string","description":"Unique SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.<br>Supported Filters : 'Equals', 'Contains', 'StartsWith'.\nThis property can be used for sorting.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"}},"description":"Information related to Session. <br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.<br>See the field description to know the filter types it supports."},"SessionInfoV4":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id associated with the session. \nFor a non-RDS desktop session, this is the desktop pool's access group id. \nFor an RDS desktop session, this is the RDS desktop pool's farm's access group id. \nFor an application session, this is the application's farm's access group id.<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_version":{"type":"string","description":"Version of agent\nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12.0"},"application_names":{"type":"array","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":["Calculator"],"items":{"type":"string","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":"[\"Calculator\"]"}},"broker_user_id":{"type":"string","description":"User SID for the broker user associated with the session. \nIt will be unset for non-broker sessions.<br>Supported Filters : 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"brokered_remotely":{"type":"boolean","description":"Indicates whether the session is brokered from a remote pod. \nIt is set only if the Horizon View agent where the session resides is version 6.0 or later.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"client_data":{"$ref":"#/components/schemas/ClientData"},"desktop_pool_id":{"type":"string","description":"Unique desktop pool id for the session. \nThis is unset if the session is not brokered through a desktop, such as for direct console access.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"disconnected_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was last disconnected. \nThis will be unset if the session's machine has an error state, or if the session has never been disconnected.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181947320},"farm_id":{"type":"string","description":"Unique farm id for this RDS desktop or application session.\nThis is unset if the session is not brokered through a farm, such as for application sessions or direct console access.<br>Supported Filters : 'Equals'.","example":"0dbd14ba-5795-4141-9cec-128ff6d494b0"},"groups":{"type":"array","description":"All group ids associated with the session's user Supported Filters : Contains","example":"S-1-5-21-1111111111-2222222222-500","items":{"type":"string","description":"All group ids associated with the session's user Supported Filters : Contains","example":"S-1-5-21-1111111111-2222222222-500"}},"guid":{"type":"string","description":"common identifier between agent and connection server.\nThis guid does not changes for a particular session during disconnects and reconnects.\n Supported Filters : Equals"},"id":{"type":"string","description":"Unique id representing a session.<br>Supported Filters : 'Equals'.","example":"7cdd624f-37d1-46c1-ab96-695a5d13956f"},"idle_duration":{"type":"integer","description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for.\nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":60},"internal_session_id":{"type":"string","description":"Internal session Id Supported Filters : Equals","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A="},"last_session_duration_ms":{"type":"integer","description":"Duration of the last connection period of the session in milli seconds. If the session is currently connected, this is the duration that the session has been in connected state. If the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":116320},"machine_id":{"type":"string","description":"Unique machine id for the session. \nThis is unset for RDS Desktop or application sessions. If desktop pool id is unset, it is the id of registered un-managed physical machine.<br>Supported Filters : 'Equals'.","example":"a00eda55-708a-4f7d-8cbc-1d1b3a2b5f73"},"rds_server_id":{"type":"string","description":"Unique RDS server id for the RDS desktop or application session.\nThis property need not be set.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"resourced_remotely":{"type":"boolean","description":"Indicates whether the session is running on remote pod resource.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"security_gateway_data":{"$ref":"#/components/schemas/SecurityGatewayData"},"session_protocol":{"type":"string","description":"Protocol for the session. \nIt will be unset for disconnected sessions.<br>Supported Filters : 'Equals', 'Conatins'.\nThis property can be used for sorting.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"PCOIP","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]},"session_state":{"type":"string","description":"State of session.<br>Supported Filters : 'Equals', 'NotEquals', 'Contains'.\nThis property can be used for sorting.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","description":"Type of session.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","example":"APPLICATION","enum":["DESKTOP","APPLICATION"]},"start_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences in between. The first connection time will be shortly after this time. \nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181831000},"unauthenticated":{"type":"boolean","description":"Indicates whether the session is of unauthenticated access user. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"user_id":{"type":"string","description":"Unique SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.<br>Supported Filters : 'Equals', 'Contains', 'StartsWith'.\nThis property can be used for sorting.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"user_name":{"type":"string","description":"User for this sessionSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"User1"}},"description":"Information related to Session. <br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.<br>See the field description to know the filter types it supports."},"SessionInfoV5":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id associated with the session. \nFor a non-RDS desktop session, this is the desktop pool's access group id. \nFor an RDS desktop session, this is the RDS desktop pool's farm's access group id. \nFor an application session, this is the application's farm's access group id.<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_version":{"type":"string","description":"Version of agent\nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12.0"},"application_names":{"type":"array","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":["Calculator"],"items":{"type":"string","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":"[\"Calculator\"]"}},"broker_user_id":{"type":"string","description":"User SID for the broker user associated with the session. \nIt will be unset for non-broker sessions.<br>Supported Filters : 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"brokered_remotely":{"type":"boolean","description":"Indicates whether the session is brokered from a remote pod. \nIt is set only if the Horizon View agent where the session resides is version 6.0 or later.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"client_data":{"$ref":"#/components/schemas/ClientData"},"cloud_managed":{"type":"boolean","description":"Indicates if the session is cloud managed or not.\nSupported Filters : Equals","example":false},"desktop_pool_id":{"type":"string","description":"Unique desktop pool id for the session. \nThis is unset if the session is not brokered through a desktop, such as for direct console access.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"disconnected_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was last disconnected. \nThis will be unset if the session's machine has an error state, or if the session has never been disconnected.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181947320},"farm_id":{"type":"string","description":"Unique farm id for this RDS desktop or application session.\nThis is unset if the session is not brokered through a farm, such as for application sessions or direct console access.<br>Supported Filters : 'Equals'.","example":"0dbd14ba-5795-4141-9cec-128ff6d494b0"},"groups":{"type":"array","description":"All group ids associated with the session's user Supported Filters : Contains","example":"S-1-5-21-1111111111-2222222222-500","items":{"type":"string","description":"All group ids associated with the session's user Supported Filters : Contains","example":"S-1-5-21-1111111111-2222222222-500"}},"guid":{"type":"string","description":"common identifier between agent and connection server.\nThis guid does not changes for a particular session during disconnects and reconnects.\n Supported Filters : Equals"},"id":{"type":"string","description":"Unique id representing a session.<br>Supported Filters : 'Equals'.","example":"7cdd624f-37d1-46c1-ab96-695a5d13956f"},"idle_duration":{"type":"integer","description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for.\nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":60},"internal_session_id":{"type":"string","description":"Internal session Id Supported Filters : Equals","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A="},"last_session_duration_ms":{"type":"integer","description":"Duration of the last connection period of the session in milli seconds. If the session is currently connected, this is the duration that the session has been in connected state. If the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":116320},"machine_id":{"type":"string","description":"Unique machine id for the session. \nThis is unset for RDS Desktop or application sessions. If desktop pool id is unset, it is the id of registered un-managed physical machine.<br>Supported Filters : 'Equals'.","example":"a00eda55-708a-4f7d-8cbc-1d1b3a2b5f73"},"rds_server_id":{"type":"string","description":"Unique RDS server id for the RDS desktop or application session.\nThis property need not be set.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"resourced_remotely":{"type":"boolean","description":"Indicates whether the session is running on remote pod resource.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"security_gateway_data":{"$ref":"#/components/schemas/SecurityGatewayData"},"session_protocol":{"type":"string","description":"Protocol for the session. \nIt will be unset for disconnected sessions.<br>Supported Filters : 'Equals', 'Conatins'.\nThis property can be used for sorting.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"PCOIP","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]},"session_state":{"type":"string","description":"State of session.<br>Supported Filters : 'Equals', 'NotEquals', 'Contains'.\nThis property can be used for sorting.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","description":"Type of session.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","example":"APPLICATION","enum":["DESKTOP","APPLICATION"]},"start_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences in between. The first connection time will be shortly after this time. \nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181831000},"unauthenticated":{"type":"boolean","description":"Indicates whether the session is of unauthenticated access user. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"user_id":{"type":"string","description":"Unique SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.<br>Supported Filters : 'Equals', 'Contains', 'StartsWith'.\nThis property can be used for sorting.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"user_name":{"type":"string","description":"User for this sessionSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"User1"}},"description":"Information related to Session. <br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.<br>See the field description to know the filter types it supports."},"SessionInfoV6":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id associated with the session. \nFor a non-RDS desktop session, this is the desktop pool's access group id. \nFor an RDS desktop session, this is the RDS desktop pool's farm's access group id. \nFor an application session, this is the application's farm's access group id.<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_version":{"type":"string","description":"Version of agent\nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12.0"},"application_names":{"type":"array","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":["Calculator"],"items":{"type":"string","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":"[\"Calculator\"]"}},"broker_user_id":{"type":"string","description":"User SID for the broker user associated with the session. \nIt will be unset for non-broker sessions.<br>Supported Filters : 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"brokered_remotely":{"type":"boolean","description":"Indicates whether the session is brokered from a remote pod. \nIt is set only if the Horizon View agent where the session resides is version 6.0 or later.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"client_data":{"$ref":"#/components/schemas/ClientData"},"cloud_managed":{"type":"boolean","description":"Indicates if the session is cloud managed or not.\nSupported Filters : Equals","example":false},"desktop_pool_id":{"type":"string","description":"Unique desktop pool id for the session. \nThis is unset if the session is not brokered through a desktop, such as for direct console access.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_or_farm_name":{"type":"string","description":"Display name of the desktop pool or name of the farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. \nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Farm-Name"},"desktop_pool_or_farm_source":{"type":"string","description":"Source of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"VIRTUAL_CENTER","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"desktop_pool_or_farm_type":{"type":"string","description":"Type of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"disconnected_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was last disconnected. \nThis will be unset if the session's machine has an error state, or if the session has never been disconnected.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181947320},"domain_name":{"type":"string","description":"Domain name of the machine or rds server.\nSupported Filters : Equals, Contains, StartsWith\nThis property can be used for sorting.","example":"example.net"},"farm_id":{"type":"string","description":"Unique farm id for this RDS desktop or application session.\nThis is unset if the session is not brokered through a farm, such as for application sessions or direct console access.<br>Supported Filters : 'Equals'.","example":"0dbd14ba-5795-4141-9cec-128ff6d494b0"},"groups":{"type":"array","description":"All group ids associated with the session's user Supported Filters : Contains","example":"S-1-5-21-1111111111-2222222222-500","items":{"type":"string","description":"All group ids associated with the session's user Supported Filters : Contains","example":"S-1-5-21-1111111111-2222222222-500"}},"guid":{"type":"string","description":"common identifier between agent and connection server.\nThis guid does not changes for a particular session during disconnects and reconnects.\n Supported Filters : Equals"},"id":{"type":"string","description":"Unique id representing a session.<br>Supported Filters : 'Equals'.","example":"7cdd624f-37d1-46c1-ab96-695a5d13956f"},"idle_duration":{"type":"integer","description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for.\nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":60},"internal_session_id":{"type":"string","description":"Internal session Id Supported Filters : Equals","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A="},"last_session_duration_ms":{"type":"integer","description":"Duration of the last connection period of the session in milli seconds. If the session is currently connected, this is the duration that the session has been in connected state. If the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":116320},"machine_id":{"type":"string","description":"Unique machine id for the session. \nThis is unset for RDS Desktop or application sessions. If desktop pool id is unset, it is the id of registered un-managed physical machine.<br>Supported Filters : 'Equals'.","example":"a00eda55-708a-4f7d-8cbc-1d1b3a2b5f73"},"rds_server_id":{"type":"string","description":"Unique RDS server id for the RDS desktop or application session.\nThis property need not be set.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"resourced_remotely":{"type":"boolean","description":"Indicates whether the session is running on remote pod resource.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"security_gateway_data":{"$ref":"#/components/schemas/SecurityGatewayData"},"session_protocol":{"type":"string","description":"Protocol for the session. \nIt will be unset for disconnected sessions.<br>Supported Filters : 'Equals', 'Conatins'.\nThis property can be used for sorting.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"PCOIP","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]},"session_state":{"type":"string","description":"State of session.<br>Supported Filters : 'Equals', 'NotEquals', 'Contains'.\nThis property can be used for sorting.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","description":"Type of session.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","example":"APPLICATION","enum":["DESKTOP","APPLICATION"]},"start_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences in between. The first connection time will be shortly after this time. \nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181831000},"unauthenticated":{"type":"boolean","description":"Indicates whether the session is of unauthenticated access user. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"user_id":{"type":"string","description":"Unique SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.<br>Supported Filters : 'Equals', 'Contains', 'StartsWith'.\nThis property can be used for sorting.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"user_name":{"type":"string","description":"User for this sessionSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"User1"}},"description":"Information related to Session. <br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.<br>See the field description to know the filter types it supports."},"SessionInfoV7":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id associated with the session. \nFor a non-RDS desktop session, this is the desktop pool's access group id. \nFor an RDS desktop session, this is the RDS desktop pool's farm's access group id. \nFor an application session, this is the application's farm's access group id.<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_version":{"type":"string","description":"Version of agent\nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12.0"},"application_names":{"type":"array","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":["Calculator"],"items":{"type":"string","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":"[\"Calculator\"]"}},"broker_user_id":{"type":"string","description":"User SID for the broker user associated with the session. \nIt will be unset for non-broker sessions.<br>Supported Filters : 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"brokered_remotely":{"type":"boolean","description":"Indicates whether the session is brokered from a remote pod. \nIt is set only if the Horizon View agent where the session resides is version 6.0 or later.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"client_data":{"$ref":"#/components/schemas/ClientData"},"cloud_managed":{"type":"boolean","description":"Indicates if the session is cloud managed or not.\nSupported Filters : Equals","example":false},"desktop_pool_id":{"type":"string","description":"Unique desktop pool id for the session. \nThis is unset if the session is not brokered through a desktop, such as for direct console access.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_or_farm_name":{"type":"string","description":"Display name of the desktop pool or name of the farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. \nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Farm-Name"},"desktop_pool_or_farm_source":{"type":"string","description":"Source of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"VIRTUAL_CENTER","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"desktop_pool_or_farm_type":{"type":"string","description":"Type of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"disconnected_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was last disconnected. \nThis will be unset if the session's machine has an error state, or if the session has never been disconnected.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181947320},"domain_name":{"type":"string","description":"Domain name of the machine or rds server.\nSupported Filters : Equals, Contains, StartsWith\nThis property can be used for sorting.","example":"example.net"},"farm_id":{"type":"string","description":"Unique farm id for this RDS desktop or application session.\nThis is unset if the session is not brokered through a farm, such as for application sessions or direct console access.<br>Supported Filters : 'Equals'.","example":"0dbd14ba-5795-4141-9cec-128ff6d494b0"},"forever_session":{"type":"boolean","description":"Indicates whether the application session will continue to run indefinitely on reaching global idle timeout or max session timeout.\nSupported Filters : Equals\nThis property can be used for sorting.","example":false},"groups":{"type":"array","description":"All group ids associated with the session's user Supported Filters : Contains","example":"S-1-5-21-1111111111-2222222222-500","items":{"type":"string","description":"All group ids associated with the session's user Supported Filters : Contains","example":"S-1-5-21-1111111111-2222222222-500"}},"guid":{"type":"string","description":"common identifier between agent and connection server.\nThis guid does not changes for a particular session during disconnects and reconnects.\n Supported Filters : Equals"},"id":{"type":"string","description":"Unique id representing a session.<br>Supported Filters : 'Equals'.","example":"7cdd624f-37d1-46c1-ab96-695a5d13956f"},"idle_duration":{"type":"integer","description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for.\nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":60},"internal_session_id":{"type":"string","description":"Internal session Id Supported Filters : Equals","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A="},"last_session_duration_ms":{"type":"integer","description":"Duration of the last connection period of the session in milli seconds. If the session is currently connected, this is the duration that the session has been in connected state. If the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":116320},"machine_id":{"type":"string","description":"Unique machine id for the session. \nThis is unset for RDS Desktop or application sessions. If desktop pool id is unset, it is the id of registered un-managed physical machine.<br>Supported Filters : 'Equals'.","example":"a00eda55-708a-4f7d-8cbc-1d1b3a2b5f73"},"machine_or_rds_server_dns":{"type":"string","description":"Machine or RDSServer DNS name for this session.\nSupported Filters : Equals, Contains, StartsWith\n\nThis property can be used for sorting.","example":"machineDns"},"machine_or_rds_server_name":{"type":"string","description":"Machine or RDSServer name for this session.\nSupported Filters : Equals, Contains, StartsWith\n\nThis property can be used for sorting.","example":"machineName"},"rds_server_id":{"type":"string","description":"Unique RDS server id for the RDS desktop or application session.\nThis property need not be set.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"resourced_remotely":{"type":"boolean","description":"Indicates whether the session is running on remote pod resource.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"security_gateway_data":{"$ref":"#/components/schemas/SecurityGatewayData"},"session_protocol":{"type":"string","description":"Protocol for the session. \nIt will be unset for disconnected sessions.<br>Supported Filters : 'Equals', 'Conatins'.\nThis property can be used for sorting.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"PCOIP","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]},"session_state":{"type":"string","description":"State of session.<br>Supported Filters : 'Equals', 'NotEquals', 'Contains'.\nThis property can be used for sorting.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","description":"Type of session.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","example":"APPLICATION","enum":["DESKTOP","APPLICATION"]},"start_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences in between. The first connection time will be shortly after this time. \nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181831000},"unauthenticated":{"type":"boolean","description":"Indicates whether the session is of unauthenticated access user. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"user_id":{"type":"string","description":"Unique SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.<br>Supported Filters : 'Equals', 'Contains', 'StartsWith'.\nThis property can be used for sorting.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"user_name":{"type":"string","description":"User for this sessionSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"User1"}},"description":"Information related to Session. <br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.<br>See the field description to know the filter types it supports."},"SessionInfoV8":{"type":"object","properties":{"access_group_id":{"type":"string","description":"Access group id associated with the session. \nFor a non-RDS desktop session, this is the desktop pool's access group id. \nFor an RDS desktop session, this is the RDS desktop pool's farm's access group id. \nFor an application session, this is the application's farm's access group id.<br>Supported Filters : 'Equals'.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"agent_version":{"type":"string","description":"Version of agent\nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"7.12.0"},"application_names":{"type":"array","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":["Calculator"],"items":{"type":"string","description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.<br>Supported Filters : 'Contains'.","example":"[\"Calculator\"]"}},"broker_user_id":{"type":"string","description":"User SID for the broker user associated with the session. \nIt will be unset for non-broker sessions.<br>Supported Filters : 'Equals'.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"brokered_remotely":{"type":"boolean","description":"Indicates whether the session is brokered from a remote pod. \nIt is set only if the Horizon View agent where the session resides is version 6.0 or later.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"client_data":{"$ref":"#/components/schemas/ClientData"},"cloud_managed":{"type":"boolean","description":"Indicates if the session is cloud managed or not.\nSupported Filters : Equals","example":false},"desktop_pool_id":{"type":"string","description":"Unique desktop pool id for the session. \nThis is unset if the session is not brokered through a desktop, such as for direct console access.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_or_farm_name":{"type":"string","description":"Display name of the desktop pool or name of the farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. \nSupported Filters: 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Farm-Name"},"desktop_pool_or_farm_source":{"type":"string","description":"Source of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.\nThis property can be used for sorting.\n* INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.\n* RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.\n* UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers, blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.\n* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.\n* AWS_CORE: The Desktop Pool uses AWS core as source for provisioning the machines.\n* PRISM: The Desktop Pool uses PRISM as source for provisioning the machines.\n* UNKNOWN: Source is unknown.","example":"VIRTUAL_CENTER","enum":["INSTANT_CLONE","LINKED_CLONE","RDS","UNMANAGED","VIRTUAL_CENTER","AWS_CORE","PRISM","UNKNOWN"]},"desktop_pool_or_farm_type":{"type":"string","description":"Type of the desktop pool or farm for the session. \nThis will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access.Supported Filters : 'Equals'.\nThis property can be used for sorting.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","example":"AUTOMATED","enum":["AUTOMATED","MANUAL","RDS"]},"disconnected_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was last disconnected. \nThis will be unset if the session's machine has an error state, or if the session has never been disconnected.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181947320},"domain_name":{"type":"string","description":"Domain name of the machine or rds server.\nSupported Filters : Equals, Contains, StartsWith\nThis property can be used for sorting.","example":"example.net"},"farm_id":{"type":"string","description":"Unique farm id for this RDS desktop or application session.\nThis is unset if the session is not brokered through a farm, such as for application sessions or direct console access.<br>Supported Filters : 'Equals'.","example":"0dbd14ba-5795-4141-9cec-128ff6d494b0"},"forever_session":{"type":"boolean","description":"Indicates whether the application session will continue to run indefinitely on reaching global idle timeout or max session timeout.\nSupported Filters : Equals\nThis property can be used for sorting.","example":false},"groups":{"type":"array","description":"All group ids associated with the session's user Supported Filters : Contains","example":"S-1-5-21-1111111111-2222222222-500","items":{"type":"string","description":"All group ids associated with the session's user Supported Filters : Contains","example":"S-1-5-21-1111111111-2222222222-500"}},"guid":{"type":"string","description":"common identifier between agent and connection server.\nThis guid does not changes for a particular session during disconnects and reconnects.\n Supported Filters : Equals"},"id":{"type":"string","description":"Unique id representing a session.<br>Supported Filters : 'Equals'.","example":"7cdd624f-37d1-46c1-ab96-695a5d13956f"},"idle_duration":{"type":"integer","description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for.\nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":60},"internal_session_id":{"type":"string","description":"Internal session Id Supported Filters : Equals","example":"QUQtUkFjbj1mbxQGNuPWJkNGViNmFmLTUXZkaSxkYz12bXdhcmUsZGM9aW50LmNujPWludDpCTEFTVDowOkRFU0tUT1A="},"last_session_duration_ms":{"type":"integer","description":"Duration of the last connection period of the session in milli seconds. If the session is currently connected, this is the duration that the session has been in connected state. If the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":116320},"machine_id":{"type":"string","description":"Unique machine id for the session. \nThis is unset for RDS Desktop or application sessions. If desktop pool id is unset, it is the id of registered un-managed physical machine.<br>Supported Filters : 'Equals'.","example":"a00eda55-708a-4f7d-8cbc-1d1b3a2b5f73"},"machine_or_rds_server_dns":{"type":"string","description":"Machine or RDSServer DNS name for this session.\nSupported Filters : Equals, Contains, StartsWith\n\nThis property can be used for sorting.","example":"machineDns"},"machine_or_rds_server_name":{"type":"string","description":"Machine or RDSServer name for this session.\nSupported Filters : Equals, Contains, StartsWith\n\nThis property can be used for sorting.","example":"machineName"},"rds_server_id":{"type":"string","description":"Unique RDS server id for the RDS desktop or application session.\nThis property need not be set.<br>Supported Filters : 'Equals'.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"resourced_remotely":{"type":"boolean","description":"Indicates whether the session is running on remote pod resource.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"security_gateway_data":{"$ref":"#/components/schemas/SecurityGatewayData"},"session_protocol":{"type":"string","description":"Protocol for the session. \nIt will be unset for disconnected sessions.<br>Supported Filters : 'Equals', 'Conatins'.\nThis property can be used for sorting.\n* PCOIP: Display protocol is PCoIP.\n* RDP: Display protocol is RDP.\n* BLAST: Display protocol is BLAST.\n* CONSOLE: Display protocol is console.\n* ULTRA: Display protocol is ULTRA.\n* UNKNOWN: Display protocol is unknown.","example":"PCOIP","enum":["PCOIP","RDP","BLAST","CONSOLE","ULTRA","UNKNOWN"]},"session_state":{"type":"string","description":"State of session.<br>Supported Filters : 'Equals', 'NotEquals', 'Contains'.\nThis property can be used for sorting.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","description":"Type of session.<br>Supported Filters : 'Equals', 'Contains'.\nThis property can be used for sorting.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","example":"APPLICATION","enum":["DESKTOP","APPLICATION"]},"start_time":{"type":"integer","description":"Epoch time in milli seconds, when the session was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences in between. The first connection time will be shortly after this time. \nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181831000},"total_session_duration_ms":{"type":"integer","description":"Epoch time in milli seconds, for the total session duration since it was originally logged in. \nThe lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences in between. The total connection time will be from the start time till now. \nThis property need not be set.<br>Supported Filters : 'Equals', 'Between'.\nThis property can be used for sorting.","format":"int64","example":1582181831000},"unauthenticated":{"type":"boolean","description":"Indicates whether the session is of unauthenticated access user. \nThis property need not be set.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"user_id":{"type":"string","description":"Unique SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.<br>Supported Filters : 'Equals', 'Contains', 'StartsWith'.\nThis property can be used for sorting.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"user_name":{"type":"string","description":"User for this sessionSupported Filters: 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"User1"}},"description":"Information related to Session. <br>Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.<br>See the field description to know the filter types it supports."},"SessionMetrics":{"type":"object","properties":{"application_session_metrics":{"$ref":"#/components/schemas/SessionStateMetrics"},"client_metrics":{"$ref":"#/components/schemas/SessionClientMetrics"},"desktop_session_metrics":{"$ref":"#/components/schemas/SessionStateMetrics"},"gateway_metrics":{"$ref":"#/components/schemas/SessionGatewayMetrics"},"num_sessions":{"type":"integer","description":"The total number of sessions.","format":"int32"},"num_users":{"type":"integer","description":"The total number of users.","format":"int32"},"protocol_metrics":{"$ref":"#/components/schemas/SessionProtocolMetrics"},"rds_session_metrics":{"$ref":"#/components/schemas/SessionStateMetrics"}},"description":"Session Metrics."},"SessionProtocolMetrics":{"type":"object","properties":{"num_blast_sessions":{"type":"integer","description":"The number of sessions using blast display protocol.","format":"int32"},"num_other_protocols":{"type":"integer","description":"The number of sessions using protocol not belonging to blast, pcoip, RDP.","format":"int32"},"num_pcoip_sessions":{"type":"integer","description":"The number of sessions using pcoip display protocol.","format":"int32"},"num_rdp_sessions":{"type":"integer","description":"The number of sessions using RDP display protocol.","format":"int32"}},"description":"The protocol Metrics for sessions."},"SessionSendMessageSpec":{"required":["message","message_type","session_ids"],"type":"object","properties":{"message":{"type":"string","description":"Message to be sent to session(s).","example":"Sample Info Message"},"message_type":{"type":"string","description":"Type of message to be sent to session(s).\n* ERROR: Message is of error type.\n* WARNING: Message is of warning type.\n* INFO: Message is of information type.","example":"INFO","enum":["ERROR","WARNING","INFO"]},"session_ids":{"type":"array","description":"List of session ids to which message is to be sent","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"List of session ids to which message is to be sent","example":"[\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}}},"description":"Message information object to be sent to sessions."},"SessionStateMetrics":{"type":"object","properties":{"num_active_sessions":{"type":"integer","description":"The number of active sessions.","format":"int32"},"num_disconnected_sessions":{"type":"integer","description":"The number of disconnected sessions.","format":"int32"},"num_idle_sessions":{"type":"integer","description":"The number of idle sessions.","format":"int32"},"num_pending_sessions":{"type":"integer","description":"The number of pending sessions.","format":"int32"}},"description":"The session state Metrics for application sessions."},"SettingsInfo":{"type":"object","properties":{"feature_settings":{"$ref":"#/components/schemas/FeatureSettings"},"general_settings":{"$ref":"#/components/schemas/GeneralSettings"},"security_settings":{"$ref":"#/components/schemas/SecuritySettings"}},"description":"Information related to Settings."},"SettingsInfoV10":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsInfo"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsInfoV2"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsV4"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsV7"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsV6"}},"description":"Information related to Settings."},"SettingsInfoV11":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsInfo"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsInfoV2"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsV5"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsV7"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsV6"}},"description":"Information related to Settings."},"SettingsInfoV2":{"type":"object","properties":{"feature_settings":{"$ref":"#/components/schemas/FeatureSettings"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsV2"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsV2"}},"description":"Information related to Settings."},"SettingsInfoV3":{"type":"object","properties":{"feature_settings":{"$ref":"#/components/schemas/FeatureSettings"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsV3"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsV2"}},"description":"Information related to Settings."},"SettingsInfoV4":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsInfo"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsInfo"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettings"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsV4"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsV3"}},"description":"Information related to Settings."},"SettingsInfoV5":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsInfo"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsInfo"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettings"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsV4"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsV4"}},"description":"Information related to Settings."},"SettingsInfoV6":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsInfo"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsInfo"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsV2"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsV5"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsV5"}},"description":"Information related to Settings."},"SettingsInfoV7":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsInfo"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsInfo"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsV3"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsV5"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsV6"}},"description":"Information related to Settings."},"SettingsInfoV8":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsInfo"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsInfo"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsV3"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsV6"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsV6"}},"description":"Information related to Settings."},"SettingsInfoV9":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsInfo"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsInfo"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsV4"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsV7"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsV6"}},"description":"Information related to Settings."},"SettingsUpdateSpec":{"type":"object","properties":{"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpec"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpec"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpec"}},"description":"Configuration settings object to be updated."},"SettingsUpdateSpecV10":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsUpdateSpec"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsUpdateSpecV2"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpecV4"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV7"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpecV5"}},"description":"Configuration settings object to be updated."},"SettingsUpdateSpecV11":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsUpdateSpec"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsUpdateSpecV2"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpecV5"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV7"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpecV5"}},"description":"Configuration settings object to be updated."},"SettingsUpdateSpecV2":{"type":"object","properties":{"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpec"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV2"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpec"}},"description":"Configuration settings object to be updated."},"SettingsUpdateSpecV3":{"type":"object","properties":{"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpec"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV3"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpec"}},"description":"Configuration settings object to be updated."},"SettingsUpdateSpecV4":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsUpdateSpec"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsUpdateSpec"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpec"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV4"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpecV3"}},"description":"Configuration settings object to be updated."},"SettingsUpdateSpecV5":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsUpdateSpec"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsUpdateSpec"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpec"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV5"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpecV4"}},"description":"Configuration settings object to be updated."},"SettingsUpdateSpecV6":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsUpdateSpec"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsUpdateSpec"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpecV2"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV5"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpecV4"}},"description":"Configuration settings object to be updated."},"SettingsUpdateSpecV7":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsUpdateSpec"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsUpdateSpec"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpecV3"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV5"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpecV5"}},"description":"Configuration settings object to be updated."},"SettingsUpdateSpecV8":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsUpdateSpec"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsUpdateSpec"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpecV3"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV6"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpecV5"}},"description":"Configuration settings object to be updated."},"SettingsUpdateSpecV9":{"type":"object","properties":{"agent_restriction_settings":{"$ref":"#/components/schemas/AgentRestrictionSettingsUpdateSpec"},"client_settings":{"$ref":"#/components/schemas/ClientSettingsUpdateSpec"},"feature_settings":{"$ref":"#/components/schemas/FeatureSettingsUpdateSpecV4"},"general_settings":{"$ref":"#/components/schemas/GeneralSettingsUpdateSpecV7"},"security_settings":{"$ref":"#/components/schemas/SecuritySettingsUpdateSpecV5"}},"description":"Configuration settings object to be updated."},"SiteCreateSpec":{"required":["name"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Detailed description of the site.","example":"This is US site"},"name":{"maxLength":64,"minLength":0,"type":"string","description":"The name of the site.","example":"US Site"}},"description":"Site object to be created."},"SiteCreateSpecV2":{"required":["name"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Detailed description of the site.","example":"This is US site"},"name":{"maxLength":64,"minLength":0,"type":"string","description":"The name of the site.","example":"US Site"},"site_url":{"type":"string","description":"URL of the site. This must specify a protocol (scheme) of http or https.","example":"https://site1.example.com/"}},"description":"Site object to be created."},"SiteCreateSpecV3":{"required":["name"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Detailed description of the site.","example":"This is US site"},"name":{"maxLength":64,"minLength":0,"type":"string","description":"The name of the site.","example":"US Site"},"preferred_sites":{"type":"array","description":"List of preferred site UUIDs.","example":["13b45e23-8a43-4dae-8f84-0cbff0de9905","f1002693-23e3-44e6-9fe4-8fa111ae230e"],"items":{"type":"string","description":"List of preferred site UUIDs.","example":"[\"13b45e23-8a43-4dae-8f84-0cbff0de9905\",\"f1002693-23e3-44e6-9fe4-8fa111ae230e\"]"}},"site_url":{"type":"string","description":"URL of the site. This must specify a protocol (scheme) of http or https.","example":"https://site1.example.com/"}},"description":"Site object to be created."},"SiteInfo":{"type":"object","properties":{"description":{"type":"string","description":"Detailed description of the site.","example":"This is US site"},"id":{"type":"string","description":"Unique ID representing the site.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"name":{"type":"string","description":"Name of the site.","example":"US Site"},"pods":{"type":"array","description":"Member pods for this site.","example":["c617fd51-e118-4cae-970c-54a7144aaadc","bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"],"items":{"type":"string","description":"Member pods for this site.","example":"[\"c617fd51-e118-4cae-970c-54a7144aaadc\",\"bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c\"]"}}},"description":"Information related to sites in a pod federation."},"SiteInfoV2":{"type":"object","properties":{"description":{"type":"string","description":"Detailed description of the site.","example":"This is US site"},"id":{"type":"string","description":"Unique ID representing the site.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"name":{"type":"string","description":"Name of the site.","example":"US Site"},"pods":{"type":"array","description":"Member pods for this site.","example":["c617fd51-e118-4cae-970c-54a7144aaadc","bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"],"items":{"type":"string","description":"Member pods for this site.","example":"[\"c617fd51-e118-4cae-970c-54a7144aaadc\",\"bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c\"]"}},"site_url":{"type":"string","description":"URL of the site.","example":"https://site1.example.com/"}},"description":"Information related to sites in a pod federation."},"SiteInfoV3":{"type":"object","properties":{"description":{"type":"string","description":"Detailed description of the site.","example":"This is US site"},"id":{"type":"string","description":"Unique ID representing the site.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"name":{"type":"string","description":"Name of the site.","example":"US Site"},"pods":{"type":"array","description":"Member pods for this site.","example":["c617fd51-e118-4cae-970c-54a7144aaadc","bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"],"items":{"type":"string","description":"Member pods for this site.","example":"[\"c617fd51-e118-4cae-970c-54a7144aaadc\",\"bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c\"]"}},"preferred_sites":{"type":"array","description":"List of preferred site UUIDs.","example":["13b45e23-8a43-4dae-8f84-0cbff0de9905","f1002693-23e3-44e6-9fe4-8fa111ae230e"],"items":{"type":"string","description":"List of preferred site UUIDs.","example":"[\"13b45e23-8a43-4dae-8f84-0cbff0de9905\",\"f1002693-23e3-44e6-9fe4-8fa111ae230e\"]"}},"site_url":{"type":"string","description":"URL of the site.","example":"https://site1.example.com/"}},"description":"Information related to sites in a pod federation."},"SiteRedirectionSettings":{"required":["site_redirection_enabled","site_redirection_enabled_without_sso"],"type":"object","properties":{"site_redirection_enabled":{"type":"boolean","description":"Indicates / enables site redirection globally (requires CPA initialized)."},"site_redirection_enabled_without_sso":{"type":"boolean","description":"Indicates / enables site redirection when SSO is absent."}},"description":"Site redirection settings."},"SiteUpdateSpec":{"required":["name"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Detailed description of the site.","example":"This is US site"},"name":{"maxLength":64,"minLength":0,"type":"string","description":"The name of the site.","example":"US Site"}},"description":"Site object to be updated."},"SiteUpdateSpecV2":{"required":["name"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Detailed description of the site.","example":"This is US site"},"name":{"maxLength":64,"minLength":0,"type":"string","description":"The name of the site.","example":"US Site"},"site_url":{"type":"string","description":"URL of the site. This must specify a protocol (scheme) of http or https.","example":"https://site1.example.com/"}},"description":"Site object to be updated."},"SiteUpdateSpecV3":{"required":["name"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Detailed description of the site.","example":"This is US site"},"name":{"maxLength":64,"minLength":0,"type":"string","description":"The name of the site.","example":"US Site"},"preferred_sites":{"type":"array","description":"List of preferred site UUIDs.","example":["13b45e23-8a43-4dae-8f84-0cbff0de9905","f1002693-23e3-44e6-9fe4-8fa111ae230e"],"items":{"type":"string","description":"List of preferred site UUIDs.","example":"[\"13b45e23-8a43-4dae-8f84-0cbff0de9905\",\"f1002693-23e3-44e6-9fe4-8fa111ae230e\"]"}},"site_url":{"type":"string","description":"URL of the site. This must specify a protocol (scheme) of http or https.","example":"https://site1.example.com/"}},"description":"Site object to be updated."},"SmartCardAuthTokens":{"type":"object","properties":{"access_token":{"type":"string","description":"Access Token to be used in API calls.","example":"<jwt.access.token>"},"domain":{"type":"string","description":"Domain","example":"AD-TEST-DOMAIN"},"refresh_token":{"type":"string","description":"Refresh Token to be used to get a new Access token.","example":"<jwt.refresh.token>"},"user_name":{"type":"string","description":"User Name","example":"Administrator"}},"description":"Smart card authentication tokens."},"SpecifiedNamesValidationInfo":{"type":"object","properties":{"machine_name":{"type":"string","description":"The virtual machine name.","example":"Machine-002-jdoe"},"specified_names_statuses":{"type":"array","description":"The status information captured after validation.","example":"VM_NAME_TOO_LONG","items":{"type":"string","description":"* VM_NAME_TOO_LONG: The given VM name is longer than 15 bytes.\n* INVALID_VM_NAME: Invalid name for a VM.\n* DUPLICATE_VM_NAME: Duplicate VM name.\n* INVALID_USER_NAME: User name not found.\n* DUPLICATE_USER_NAME: Duplicate user name.","example":"VM_NAME_TOO_LONG","enum":["SUCCESS","VM_NAME_TOO_LONG","INVALID_VM_NAME","DUPLICATE_VM_NAME","INVALID_USER_NAME","DUPLICATE_USER_NAME"]}},"user_id":{"type":"string","description":"The SID of the user.","example":"S-1-5-21-3711839221-3344336616-3511462156-1117"},"user_name":{"type":"string","description":"The name of the user entitled to the VM.","example":"abcorp.com\\jdoe"}},"description":"Information about specified names validation."},"SpecifiedNamesValidationSpec":{"required":["names_spec"],"type":"object","properties":{"dedicated":{"type":"boolean","description":"Indicates whether desktop pool is dedicated or floating. Default value is false.","example":false},"id":{"type":"string","description":"ID of the desktop pool to which the manually defined virtual machines will belong. This is required only if virtual machines are being added to an existing pool.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"names_spec":{"type":"array","description":"List of manually defined virtual machines and users.","items":{"$ref":"#/components/schemas/NamesSpec"}}},"description":"The specification for specified names validation that needs to be validated."},"StartsWithFilter":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseFilter"},{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"object"}}}],"required":["name","type","value"]},"StateCountMetrics":{"type":"object","properties":{"prepared_count":{"$ref":"#/components/schemas/PreparedCountMetrics"},"problem_count":{"$ref":"#/components/schemas/ProblemCountMetrics"},"under_construction_count":{"$ref":"#/components/schemas/UnderConstructionCountMetrics"}},"description":"Health information about message client."},"StorageAcceleratorData":{"type":"object","properties":{"default_cache_size_mb":{"type":"integer","description":"Default size of the cache in megabytes. This property has a default value of 1024. This property has a minimum value of 100. This property has a maximum value of 2048. ","format":"int32","example":1024},"enabled":{"type":"boolean","description":"Is View Storage Accelerator enabled? This property has a default value of false.","example":false},"host_overrides":{"type":"array","description":"Cache size overrides for hosts which support View Storage Accelerator.","items":{"$ref":"#/components/schemas/HostOverrideData"}}},"description":"Information about the Storage Accelerator Data"},"StorageAcceleratorDataCreateSpec":{"type":"object","properties":{"default_cache_size_mb":{"maximum":32768,"minimum":100,"type":"integer","description":"Default size of the cache in megabytes. This property has a default value of 1024. This property has a minimum value of 100. This property has a maximum value of 32768. ","format":"int32","example":1024},"enabled":{"type":"boolean","description":"Indicates if View Storage Accelerator enabled This property has a default value of false.","example":false},"host_overrides":{"type":"array","description":"Cache size overrides for hosts which support View Storage Accelerator.","items":{"$ref":"#/components/schemas/HostOverrideDataCreateSpec"}}},"description":"Information about the Storage Accelerator Data"},"StorageAcceleratorDataUpdateSpec":{"required":["default_cache_size_mb","enabled","host_overrides"],"type":"object","properties":{"default_cache_size_mb":{"maximum":32768,"minimum":100,"type":"integer","description":"Default size of the cache in megabytes. This property has a default value of 1024. This property has a minimum value of 100. This property has a maximum value of 32768. ","format":"int32","example":1024},"enabled":{"type":"boolean","description":"Indicates if View Storage Accelerator enabled This property has a default value of false.","example":false},"host_overrides":{"type":"array","description":"Cache size overrides for hosts which support View Storage Accelerator.","items":{"$ref":"#/components/schemas/HostOverrideDataUpdateSpec"}}},"description":"Information about the Storage Accelerator Data"},"StorageAcceleratorHostInfo":{"type":"object","properties":{"name":{"type":"string","description":"Host name or IP address.","example":"blrkm.example.com"},"path":{"type":"string","description":"Host path.","example":"/blr/host/cluster/blrkm.example.com"},"version":{"type":"string","description":"Version of the host.","example":"7.0.1"}},"description":"Information related to Storage Accelerator Host."},"StorageDetailsInfo":{"type":"object","properties":{"space_reclamation_status":{"type":"string","description":"Space reclamation status of the given virtual center.\n* VALIDATION_OK: Virtual center supports space reclamation.\n* UNSUPPORTED_VC: Virtual center does not support space reclamation.\n* RECLAMATION_DISABLED: The feature has been disabled for the virtual center.\n* FEATURE_DISABLED: Space reclamation has been disabled globally.","example":"VALIDATION_OK","enum":["VALIDATION_OK","UNSUPPORTED_VC","RECLAMATION_DISABLED","FEATURE_DISABLED"]},"storage_accelerator_host_details":{"type":"array","description":"Details of the host.","items":{"$ref":"#/components/schemas/StorageAcceleratorHostInfo"}},"storage_accelerator_status":{"type":"string","description":"Storage accelerator status of the given virtual center.\n* VALIDATION_OK: Virtual center supports View Storage Accelerator.\n* UNSUPPORTED_VC: Virtual center does not support View Storage Accelerator.","example":"VALIDATION_OK","enum":["VALIDATION_OK","UNSUPPORTED_VC"]},"version":{"type":"string","description":"Version of the Virtual Center.","example":"6.5.0"}},"description":"Information related to Storage Details."},"StorageDetailsSpec":{"type":"object","properties":{"server_details_spec":{"$ref":"#/components/schemas/ServerDetailsSpec"},"virtual_center_id":{"type":"string","description":"Unique id representing virtual center.","example":"446b6892-f3a6-463a-8b39-ac59c8c0d245"}},"description":"Storage Details Spec. Note:Either id or server_details_spec should be set"},"SyslogFileData":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether local/remote file based logging is enabled for all events.","example":true},"enabled_on_error":{"type":"boolean","description":"Indicates whether local/remote file based logging is enabled for audit events when there is any error in writing events to EventDatabase or syslog.","example":true},"unc_domain":{"type":"string","description":"The remote UNC password.","example":"domain"},"unc_path":{"type":"string","description":"The remote UNC path for syslog to move files. If not set, logs are kept locally at path PROGRAMDATA%\\Omnissa\\Horizon\\events\\.","example":"//10.117.146.17/temp"},"unc_username":{"type":"string","description":"The remote UNC user name.","example":"administrator"}},"description":"Information related to File based logging data."},"SyslogFileDataUpdateSpec":{"required":["enabled","enabled_on_error"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether local/remote file based logging is enabled for all events.","example":true},"enabled_on_error":{"type":"boolean","description":"Indicates whether local/remote file based logging is enabled for audit events when there is any error in writing events to EventDatabase or syslog.","example":true},"unc_domain":{"type":"string","description":"The remote UNC domain","example":"domain"},"unc_password":{"type":"array","description":"The remote UNC password.This field is required if unc_user_name is set.","example":"<password>","items":{"type":"string","description":"The remote UNC password.This field is required if unc_user_name is set.","example":"<password>"}},"unc_path":{"type":"string","description":"The remote UNC path for syslog to move files. If not set, logs are kept locally at path PROGRAMDATA%\\Omnissa\\Horizon\\events\\. This field is required if any of the unc_user_name, unc_password, unc_domain is set.","example":"//10.117.146.17/temp"},"unc_username":{"type":"string","description":"The remote UNC user name. This field is required if any of the unc_path, unc_password, unc_domain is set.","example":"administrator"}},"description":"Information related to File based logging data."},"SyslogInfo":{"type":"object","properties":{"file_data":{"$ref":"#/components/schemas/SyslogFileData"},"syslog_server_addresses":{"type":"array","description":"List of Syslog Server addresses","example":["10.117.146.90:514","10.117.146.89:514"],"items":{"type":"string","description":"List of Syslog Server addresses","example":"[\"10.117.146.90:514\",\"10.117.146.89:514\"]"}}},"description":"Information about Syslog."},"SyslogUpdateSpec":{"required":["file_data"],"type":"object","properties":{"file_data":{"$ref":"#/components/schemas/SyslogFileDataUpdateSpec"},"syslog_server_addresses":{"type":"array","description":"List of Syslog Server addresses","example":["10.117.146.90:514","10.117.146.89:514"],"items":{"type":"string","description":"List of Syslog Server addresses","example":"[\"10.117.146.90:514\",\"10.117.146.89:514\"]"}}},"description":"Syslog configuration to be updated."},"SystemMetricsInfo":{"type":"object","properties":{"event_error_count":{"type":"integer","description":"Number of events with the \"Error\" severity.","format":"int32","example":3},"event_warning_count":{"type":"integer","description":"Number of events with the \"Warn\" severity.","format":"int32","example":6},"health_metrics_info":{"$ref":"#/components/schemas/HealthMetricsInfo"},"problem_rds_hosts_count":{"type":"integer","description":"Number of RDS Hosts that are part of a farm and which are in any of the following status statesAGENT_UNREACHABLE, AGENT_CONFIG_ERROR, UNKNOWN, ALREADY_USED, PROVISIONING_ERROR, ERROR and AGENT_ERR_PROTOCOL_FAILURE.","format":"int32","example":3},"problem_vcenter_vms_count":{"type":"integer","description":"Number of the managed VMs which are in any of the following machine's basic_state states AGENT_ERR_DISABLED, AGENT_UNREACHABLE, AGENT_ERR_INVALID_IP, AGENT_ERR_NEED_REBOOT,AGENT_ERR_PROTOCOL_FAILURE, AGENT_ERR_DOMAIN_FAILURE, AGENT_CONFIG_ERROR, PROVISIONING_ERROR, ERROR, UNASSIGNED_USER_CONNECTED,UNASSIGNED_USER_DISCONNECTED, UNKNOWN.","format":"int32","example":2},"sessions_count":{"type":"integer","description":"Number of active sessions.","format":"int32","example":6}},"description":"System Metrics information."},"SystemMetricsInfoV2":{"type":"object","properties":{"event_error_count":{"type":"integer","description":"Number of events with the \"Error\" severity.","format":"int32","example":3},"event_warning_count":{"type":"integer","description":"Number of events with the \"Warn\" severity.","format":"int32","example":6},"health_metrics_info":{"$ref":"#/components/schemas/HealthMetricsInfo"},"problem_capacity_provider_vms_count":{"type":"integer","description":"Number of the Capacity Provider VMs which are in any of the following machine's basic_state states AGENT_ERR_DISABLED, AGENT_UNREACHABLE, AGENT_ERR_INVALID_IP, AGENT_ERR_NEED_REBOOT,AGENT_ERR_PROTOCOL_FAILURE, AGENT_ERR_DOMAIN_FAILURE, AGENT_CONFIG_ERROR, PROVISIONING_ERROR, ERROR, UNASSIGNED_USER_CONNECTED,UNASSIGNED_USER_DISCONNECTED, UNKNOWN.","format":"int32","example":2},"problem_rds_hosts_count":{"type":"integer","description":"Number of RDS Hosts that are part of a farm and which are in any of the following status statesAGENT_UNREACHABLE, AGENT_CONFIG_ERROR, UNKNOWN, ALREADY_USED, PROVISIONING_ERROR, ERROR and AGENT_ERR_PROTOCOL_FAILURE.","format":"int32","example":3},"problem_vcenter_vms_count":{"type":"integer","description":"Number of the managed VMs which are in any of the following machine's basic_state states AGENT_ERR_DISABLED, AGENT_UNREACHABLE, AGENT_ERR_INVALID_IP, AGENT_ERR_NEED_REBOOT,AGENT_ERR_PROTOCOL_FAILURE, AGENT_ERR_DOMAIN_FAILURE, AGENT_CONFIG_ERROR, PROVISIONING_ERROR, ERROR, UNASSIGNED_USER_CONNECTED,UNASSIGNED_USER_DISCONNECTED, UNKNOWN.","format":"int32","example":2},"sessions_count":{"type":"integer","description":"Number of active sessions.","format":"int32","example":6}},"description":"System Metrics information."},"TaskInfo":{"type":"object","properties":{"category":{"type":"string","description":"The category of the task.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.\n* POD_FEDERATION_CATEGORY: Category for PodFederation related tasks.","example":"POD_FEDERATION_CATEGORY","enum":["POD_FEDERATION_CATEGORY"]},"id":{"type":"string","description":"Unique ID representing the task.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"percentage_complete":{"type":"integer","description":"The amount of task completed, in percentage.\nSupported Filters : 'Equals', 'Between'.","format":"int32","example":80},"result":{"$ref":"#/components/schemas/TaskResult"},"status":{"type":"string","description":"The state of the task.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.\n* RUNNING: The task is currently running.\n* WAITING: The task is currently waiting to execute.\n* COMPLETED: The task execution has completed.\n* FAILED: The task execution has failed.\n* PAUSED: The task execution has been paused.\n* CANCELLED: The task execution has been cancelled.","example":"COMPLETED","enum":["RUNNING","WAITING","COMPLETED","FAILED","PAUSED","CANCELLED"]},"type":{"type":"string","description":"The type of the task.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.\n* POD_FEDERATION_INITIALIZING: Task performing PodFederation initialize operation.\n* POD_FEDERATION_UNINITIALIZING: Task performing PodFederation uninitialize operation.\n* POD_FEDERATION_JOINING: Task performing PodFederation join operation.\n* POD_FEDERATION_UNJOINING: Task performing PodFederation unjoin operation.","example":"POD_FEDERATION_INITIALIZING","enum":["POD_FEDERATION_INITIALIZING","POD_FEDERATION_UNINITIALIZING","POD_FEDERATION_JOINING","POD_FEDERATION_UNJOINING"]}},"description":"Information related to CPA tasks.\nList API returning this summary information can use search filter query to filter on specific fields supported by filters.\n Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'.\nSee the field description to know the filter types it supports."},"TaskResult":{"type":"object","properties":{"message":{"type":"string","description":"The result message.","example":"PodFederation initialization completed."},"message_id":{"type":"string","description":"The result message ID.","example":"POD_FEDERATION_INIT_SUCCESS."},"result_code":{"type":"string","description":"The result code of the task.\n* SUCCESS: Task is completed successfully.\n* WARN: Task is finished but has warning.\n* ERROR: Task is finished but the it has error.","example":"SUCCESS","enum":["SUCCESS","WARN","ERROR"]}},"description":"Information about a task result."},"TokenBaseDataCreateSpec":{"type":"object","properties":{"provider_id":{"type":"array","description":"Provider ID for credential based access","example":"AKIAIOSFODNN7EXAMPLE","items":{"type":"string","description":"Provider ID for credential based access","example":"AKIAIOSFODNN7EXAMPLE"}},"provider_key":{"type":"array","description":"Provider Key for credential based access","example":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY","items":{"type":"string","description":"Provider Key for credential based access","example":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"}}},"description":"Token base data of the capacity server"},"TokenBaseDataInfo":{"type":"object","properties":{"provider_id":{"type":"array","description":"Provider ID for credential based access","example":"AKIAIOSFODNN7EXAMPLE","items":{"type":"string","description":"Provider ID for credential based access","example":"AKIAIOSFODNN7EXAMPLE"}},"provider_key":{"type":"array","description":"Provider Key for credential based access","example":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY","items":{"type":"string","description":"Provider Key for credential based access","example":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"}}},"description":"Token base data of the capacity server"},"TokenBaseDataUpdateSpec":{"type":"object","properties":{"provider_id":{"type":"array","description":"Provider ID for credential based access","example":"AKIAIOSFODNN7EXAMPLE","items":{"type":"string","description":"Provider ID for credential based access","example":"AKIAIOSFODNN7EXAMPLE"}},"provider_key":{"type":"array","description":"Provider Key for credential based access","example":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY","items":{"type":"string","description":"Provider Key for credential based access","example":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"}}},"description":"Token base data of the capacity server"},"TrueSSOCertificateDomainInfo":{"type":"object","properties":{"certificate_servers":{"type":"array","description":"Collection of certificate server data available to this domain.","items":{"$ref":"#/components/schemas/TrueSSOCertificateServerInfo"}},"dns_name":{"type":"string","description":"DNS name of the domain.","example":"az.example.com"},"domain_id":{"type":"string","description":"Id of the domain.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"domain_status":{"type":"string","description":"The status of this domain to the enrollment server.\n* READY: The domain is ready.\n* CREATED: The domain is created.\n* INITIALIZED: The domain is initialized.\n* CONNECTING: The domain is connecting.\n* ASSOCIATED: This domain has been associated with a Forest, but we do not yet have a connection to this domain. We have no means of syncing objects for this forest from this domain, so it may only operate as long as there is another domain in the same forest that we can synchronize with.\n* STOPPING: The domain is stopping. A domain with this status cannot be used in connector creation.\n* FAILED: The domain is failed. A domain with this status cannot be used in connector creation.\n* UNKNOWN: The domain status is unknown. A domain with this status cannot be used in connector creation.","example":"READY","enum":["READY","CREATED","INITIALIZED","CONNECTING","ASSOCIATED","STOPPING","FAILED","UNKNOWN"]},"domain_status_reason":{"type":"string","description":"Additional non-localized explanation of the domain status."},"enrollment_certificate_status":{"type":"string","description":"The status of the enrollment server's certificate for this domain's forest.\n* VALID: A valid enrollment certificate for this domain's forest is installed on the enrollment server.\n* NOT_VALID: No valid enrollment certificate for this domain's forest is installed on the enrollment server, or it may have expired. An enrollment server with this status cannot be used in connector creation.","example":"VALID","enum":["VALID","NOT_VALID"]},"forest_dns_name":{"type":"string","description":"DNS name of the domain's forest, if any.","example":"example.com"},"replication_status":{"type":"string","description":"This domain's forest's replication status with the domain controller.\n* OK: The enrollment server has read the enrollment properties at least once and is successfully able to update them periodically.\n* DEGRADED: The enrollment server has read the enrollment properties at least once, but has not been able to reach a domain controller for some time.\n* PENDING: he enrollment server has not yet read the enrollment properties from a domain controller.\n* FAILED: The enrollment server has read the enrollment properties at least once but either has not been able to reach a domain controller for an extended time or another issue exists. An enrollment server with this status cannot be used in connector creation.","example":"OK","enum":["OK","DEGRADED","PENDING","FAILED"]},"replication_status_reason":{"type":"string","description":"Additional non-localized explanation of the replication status."},"templates":{"type":"array","description":"Collection of certificate template data available to certificate servers on this domain. Not all certificate servers may have access to all of these templates.","items":{"$ref":"#/components/schemas/TrueSSOTemplateInfo"}}},"description":"Domain data available to this enrollment server."},"TrueSSOCertificateServerInfo":{"type":"object","properties":{"certificate_server_name":{"type":"string","description":"Unique (common) name of this certificate server.","example":"pod07-POD07-CA1-CA"},"certificate_server_network_address":{"type":"string","description":"DNS name network address of this certificate server.","example":"POD07-CA1.pod07.example.com"},"certificate_status":{"type":"string","description":"The status of the certificate server's certificate.\n* VALID: The certificate is valid.\n* NOT_YET_VALID: The certificate is not yet valid.\n* UNKNOWN: The certificate status is unknown. A certificate server with a certificate with this status cannot be used in connector creation.\n* INVALID: The certificate is corrupt or unable to be used. A certificate server with a certificate with this status cannot be used in connector creation.\n* EXPIRED: The certificate has expired. A certificate server with a certificate with this status cannot be used in connector creation.\n* NOT_TRUSTED: The certificate is not in the NTAuth (Enterprise) store. A certificate server with a certificate with this status cannot be used in connector creation.","example":"VALID","enum":["VALID","NOT_YET_VALID","UNKNOWN","INVALID","EXPIRED","NOT_TRUSTED"]},"connection_status":{"type":"string","description":"The status of the enrollment server's connection to the certificate server.\n* CONNECTED: The enrollment server is connected to the certificate server.\n* CONNECTED_DEGRADED: The enrollment server has connected to the certificate server, but the certificate server is in a degraded state. Either the database is loading and it can't yet issue certificates (for up to 20 seconds) OR the last request took an excessive time to complete (more than 1000 milliseconds).\n* SERVICE_UNAVAILABLE: The enrollment server can connect to the certificate server, but the service is unavailable. A certificate server with a service in this status cannot be used in connector creation.\n* DISCONNECTED: The enrollment server is not connected to the certificate server.","example":"CONNECTED","enum":["CONNECTED","CONNECTED_DEGRADED","SERVICE_UNAVAILABLE","DISCONNECTED"]},"connection_status_reason":{"type":"string","description":"Additional non-localized explanation of the connection status."},"template_names":{"type":"array","description":"Collection of certificate template names available to this certificate server.","example":["TrueSso2","TrueSso1","TrueSsoTemplate"],"items":{"type":"string","description":"Collection of certificate template names available to this certificate server.","example":"[\"TrueSso2\",\"TrueSso1\",\"TrueSsoTemplate\"]"}}},"description":"Certificate server data available to this domain. "},"TrueSSOConnectorCreateSpec":{"required":["ad_domain_id","certificate_server_names","name","primary_enrollment_server_id","template_name"],"type":"object","properties":{"ad_domain_id":{"type":"string","description":"The AD domain id that this connector applies to. This domain must be unique among all connectors. This domain must be accessible to all enrollment servers configured on this connector. This cannot be changed once created.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"certificate_server_names":{"uniqueItems":true,"type":"array","description":"Specifies the certificate server (common) names to send certificate signing requests to. The enrollment service will round-robin the requests to available certificate servers.","example":["SSOConnector"],"items":{"type":"string","description":"Specifies the certificate server (common) names to send certificate signing requests to. The enrollment service will round-robin the requests to available certificate servers.","example":"[\"SSOConnector\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of this TrueSSO Connector.","example":"TrueSSO Connector"},"enabled":{"type":"boolean","description":"Indicates whether or not the connector is enabled. Default value is TRUE.","example":true},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Name of this TrueSSO Connector.","example":"true-sso.example.com"},"primary_enrollment_server_id":{"type":"string","description":"The primary enrollment server id.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"secondary_enrollment_server_id":{"type":"string","description":"The secondary enrollment server id. This cannot be the same as the primary.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed59"},"template_name":{"type":"string","description":"Name of the certificate template to use for this domain. This template must be accessible to all enrollment servers configured on this connector.","example":"TrueSSO Template"}},"description":"TrueSSO Connector object to be created."},"TrueSSOConnectorInfo":{"type":"object","properties":{"ad_domain_id":{"type":"string","description":"The AD domain that this connector applies to.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"certificate_server_names":{"uniqueItems":true,"type":"array","description":"Specifies the certificate server (common) names to send certificate signing requests to. The enrollment service will round-robin the requests to available certificate servers.","example":["SSOConnector"],"items":{"type":"string","description":"Specifies the certificate server (common) names to send certificate signing requests to. The enrollment service will round-robin the requests to available certificate servers.","example":"[\"SSOConnector\"]"}},"description":{"type":"string","description":"Description of this TrueSSO Connector.","example":"TrueSSO Connector"},"enabled":{"type":"boolean","description":"Indicates whether or not the TrueSSO Connector is enabled.","example":true},"id":{"type":"string","description":"Unique ID representing this TrueSSO Connector.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"name":{"type":"string","description":"Name of this TrueSSO Connector.","example":"true-sso.example.com"},"primary_enrollment_server_id":{"type":"string","description":"The primary enrollment server.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"secondary_enrollment_server_id":{"type":"string","description":"The secondary enrollment server.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"template_name":{"type":"string","description":"Name of the certificate template to use for this domain.","example":"TrueSSO Template"}},"description":"Information about TrueSSO Connector."},"TrueSSOConnectorUpdateSpec":{"required":["certificate_server_names","enabled","name","primary_enrollment_server_id","template_name"],"type":"object","properties":{"certificate_server_names":{"uniqueItems":true,"type":"array","description":"Specifies the certificate server (common) names to send certificate signing requests to. The enrollment service will round-robin the requests to available certificate servers.","example":["SSOConnector"],"items":{"type":"string","description":"Specifies the certificate server (common) names to send certificate signing requests to. The enrollment service will round-robin the requests to available certificate servers.","example":"[\"SSOConnector\"]"}},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of this TrueSSO Connector.","example":"TrueSSO Connector"},"enabled":{"type":"boolean","description":"Indicates whether or not the connector is enabled.","example":true},"name":{"maxLength":64,"minLength":0,"type":"string","description":"Name of this TrueSSO Connector.","example":"true-sso.example.com"},"primary_enrollment_server_id":{"type":"string","description":"The primary enrollment server id.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"secondary_enrollment_server_id":{"type":"string","description":"The secondary enrollment server id. This cannot be the same as the primary.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed59"},"template_name":{"type":"string","description":"Name of the certificate template to use for this domain. This template must be accessible to all enrollment servers configured on this connector.","example":"TrueSSO Template"}},"description":"TrueSSO Connector object to be updated."},"TrueSSOEnrollmentServerCreateSpec":{"required":["name"],"type":"object","properties":{"name":{"maxLength":64,"minLength":0,"type":"string","description":"Name of the enrollment server.","example":"pod07-es1.pod07.example.com"}},"description":"TrueSSO Enrollment Server to be added."},"TrueSSOEnrollmentServerInfo":{"type":"object","properties":{"connector_ids":{"uniqueItems":true,"type":"array","description":"TrueSSO connectors, if any, associated with this enrollment server.","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9","d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"items":{"type":"string","description":"TrueSSO connectors, if any, associated with this enrollment server.","example":"[\"42e47f15-aad0-221a-b231-ea4a3a134ec9\",\"d0325b13-2bf1-4fa4-b027-e780004f2d1e\"]"}},"domains":{"type":"array","description":"Collection of domain data available to this enrollment server.","items":{"$ref":"#/components/schemas/TrueSSOCertificateDomainInfo"}},"id":{"type":"string","description":"Unique ID representing this TrueSSO Enrollment Server.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"name":{"type":"string","description":"Name of this enrollment server.","example":"pod07-es1.pod07.example.com"},"network_address":{"type":"string","description":"DNS name network address of this enrollment server.","example":"pod07-es1.pod07.example.com"},"status":{"type":"string","description":"The status of this enrollment server.\n* ONLINE: The connection to the enrollment server is working properly.\n* OFFLINE: The enrollment server is not responding. An enrollment server with this status cannot be used in connector creation.","example":"ONLINE","enum":["ONLINE","OFFLINE"]},"version":{"type":"string","description":"Version number of this enrollment server.","example":"1.0"}},"description":"Information about TrueSSO Enrollment Server."},"TrueSSOMonitorInfo":{"type":"object","properties":{"ad_domain_dns_name":{"type":"string","description":"The DNS name of the domain.","example":"ad-domain.example.com"},"ad_domain_id":{"type":"string","description":"Unique SID of the AD Domain.","example":"S-1-5-21-1085031214-1563985344-725345543"},"ad_domain_status":{"type":"string","description":"The state of the domain health, taken as the most severe reported by one of the enrollment servers.\n* OK: The state of the domain is OK as reported by the enrollment servers.\n* WARN: At least one of the enrollment servers has a warning.\n* ERROR: At least one of the enrollment servers is in an error state.","example":"OK","enum":["OK","WARN","ERROR"]},"certificate_server_details":{"type":"array","description":"Details of each certificate server.","items":{"$ref":"#/components/schemas/CertificateServerDetails"}},"enabled":{"type":"boolean","description":"Indicates if the True SSO connector is enabled.","example":true},"id":{"type":"string","description":"Unique ID of the True SSO Connector.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"name":{"type":"string","description":"True SSO connector name.","example":"true-sso.example.com"},"primary_enrollment_server":{"$ref":"#/components/schemas/EnrollmentServerDetails"},"secondary_enrollment_server":{"$ref":"#/components/schemas/EnrollmentServerDetails"},"status":{"type":"string","description":"Overall status of the True SSO connector.\n* OK: All the components of the True SSO connector are fine.\n* WARN: At least one component of the True SSO connector has a warning.\n* ERROR: At least one component of the True SSO connector has an error.","example":"OK","enum":["OK","WARN","ERROR"]},"template_name":{"type":"string","description":"Unique name for the True SSO template.","example":"TrueSSO Template"},"template_status":{"type":"string","description":"The state of the template health, taken as the most severe reported by one of the enrollment servers.\n* OK: The state of the template is OK as reported by the enrollment servers.\n* WARN: At least one enrollment server reports a warning on this template.\n* ERROR: At least one enrollment server reports an error on this template.","example":"OK","enum":["OK","WARN","ERROR"]}},"description":"Monitoring information related to the True SSO Connector."},"TrueSSOMonitorInfoV2":{"type":"object","properties":{"ad_domain_dns_name":{"type":"string","description":"The DNS name of the domain.","example":"ad-domain.example.com"},"ad_domain_id":{"type":"string","description":"Unique SID of the AD Domain.","example":"S-1-5-21-1085031214-1563985344-725345543"},"ad_domain_primary_enrollment_server_state_reasons":{"type":"array","description":"Reasons for the state from the primary enrollment server.","example":"CONNECTION_ESTABLISHING","items":{"type":"string","description":"* CONNECTION_ESTABLISHING: Error: The enrollment server's connection to the domain is still being established (CREATED, INITIALIZED, or CONNECTING).\n* CONNECTION_FAILED: Error: The enrollment server's connection to the domain is stopping or in a problematic state (ASSOCIATED, STOPPING, FAILED, or UNKNOWN).\n* REPLICATION_DEGRADED: Warn: The enrollment server has read the enrollment properties at least once, but has not been able to reach a domain controller for some time.\n* NOT_FOUND: Error: This domain does not exist on the enrollment server.\n* REPLICATION_PENDING: Error: The enrollment server has not yet read the enrollment properties from a domain controller.\n* REPLICATION_FAILED: Error: The enrollment server has read the enrollment properties at least once but either has not been able to reach a domain controller for an extended time or another issue exists. An enrollment server with this status cannot be used in connector creation.\n* CERTIFICATE_NOT_VALID: Error: No valid enrollment certificate for this domain's forest is installed on the enrollment server, or it may have expired. An enrollment server with this status cannot be used in connector creation.","example":"CONNECTION_ESTABLISHING","enum":["CONNECTION_ESTABLISHING","CONNECTION_FAILED","REPLICATION_DEGRADED","NOT_FOUND","REPLICATION_PENDING","REPLICATION_FAILED","CERTIFICATE_NOT_VALID"]}},"ad_domain_secondary_enrollment_server_state_reasons":{"type":"array","description":"Reasons for the state from the secondary enrollment server.","example":"REPLICATION_DEGRADED","items":{"type":"string","description":"* CONNECTION_ESTABLISHING: Error: The enrollment server's connection to the domain is still being established (CREATED, INITIALIZED, or CONNECTING).\n* CONNECTION_FAILED: Error: The enrollment server's connection to the domain is stopping or in a problematic state (ASSOCIATED, STOPPING, FAILED, or UNKNOWN).\n* REPLICATION_DEGRADED: Warn: The enrollment server has read the enrollment properties at least once, but has not been able to reach a domain controller for some time.\n* NOT_FOUND: Error: This domain does not exist on the enrollment server.\n* REPLICATION_PENDING: Error: The enrollment server has not yet read the enrollment properties from a domain controller.\n* REPLICATION_FAILED: Error: The enrollment server has read the enrollment properties at least once but either has not been able to reach a domain controller for an extended time or another issue exists. An enrollment server with this status cannot be used in connector creation.\n* CERTIFICATE_NOT_VALID: Error: No valid enrollment certificate for this domain's forest is installed on the enrollment server, or it may have expired. An enrollment server with this status cannot be used in connector creation.","example":"REPLICATION_DEGRADED","enum":["CONNECTION_ESTABLISHING","CONNECTION_FAILED","REPLICATION_DEGRADED","NOT_FOUND","REPLICATION_PENDING","REPLICATION_FAILED","CERTIFICATE_NOT_VALID"]}},"ad_domain_status":{"type":"string","description":"The state of the domain health, taken as the most severe reported by one of the enrollment servers.\n* OK: The state of the domain is OK as reported by the enrollment servers.\n* WARN: At least one of the enrollment servers has a warning.\n* ERROR: At least one of the enrollment servers is in an error state.","example":"OK","enum":["OK","WARN","ERROR"]},"certificate_server_details":{"type":"array","description":"Details of each certificate server.","items":{"$ref":"#/components/schemas/CertificateServerDetailsV2"}},"enabled":{"type":"boolean","description":"Indicates if the True SSO connector is enabled.","example":true},"id":{"type":"string","description":"Unique ID of the True SSO Connector.","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50"},"name":{"type":"string","description":"True SSO connector name.","example":"true-sso.example.com"},"primary_enrollment_server":{"$ref":"#/components/schemas/EnrollmentServerDetailsV2"},"secondary_enrollment_server":{"$ref":"#/components/schemas/EnrollmentServerDetailsV2"},"status":{"type":"string","description":"Overall status of the True SSO connector.\n* OK: All the components of the True SSO connector are fine.\n* WARN: At least one component of the True SSO connector has a warning.\n* ERROR: At least one component of the True SSO connector has an error.","example":"OK","enum":["OK","WARN","ERROR"]},"template_name":{"type":"string","description":"Unique name for the True SSO template.","example":"TrueSSO Template"},"template_primary_enrollment_server_state_reasons":{"type":"array","description":"Reasons for the state from the primary enrollment server.","example":"SUPPORTED_NOT_OPTIMAL","items":{"type":"string","description":"* SUPPORTED_NOT_OPTIMAL: Warn: This template does not have the ideal properties for CertSSO.\n* NO_CAPABILITY: Error: This template does not have CertSSO capability.\n* ENABLED_BUT_UNUSABLE: Error: This template is smartcard logon enabled, but cannot be used (INVALID, MANUAL, or UNSUITABLE).\n* NOT_FOUND: Error: This template does not exist on the enrollment server domain.","example":"SUPPORTED_NOT_OPTIMAL","enum":["SUPPORTED_NOT_OPTIMAL","NO_CAPABILITY","ENABLED_BUT_UNUSABLE","NOT_FOUND"]}},"template_secondary_enrollment_server_state_reasons":{"type":"array","description":"Reasons for the state from the secondary enrollment server.","example":"NO_CAPABILITY","items":{"type":"string","description":"* SUPPORTED_NOT_OPTIMAL: Warn: This template does not have the ideal properties for CertSSO.\n* NO_CAPABILITY: Error: This template does not have CertSSO capability.\n* ENABLED_BUT_UNUSABLE: Error: This template is smartcard logon enabled, but cannot be used (INVALID, MANUAL, or UNSUITABLE).\n* NOT_FOUND: Error: This template does not exist on the enrollment server domain.","example":"NO_CAPABILITY","enum":["SUPPORTED_NOT_OPTIMAL","NO_CAPABILITY","ENABLED_BUT_UNUSABLE","NOT_FOUND"]}},"template_status":{"type":"string","description":"The state of the template health, taken as the most severe reported by one of the enrollment servers.\n* OK: The state of the template is OK as reported by the enrollment servers.\n* WARN: At least one enrollment server reports a warning on this template.\n* ERROR: At least one enrollment server reports an error on this template.","example":"OK","enum":["OK","WARN","ERROR"]}},"description":"Monitoring information related to the True SSO Connector."},"TrueSSOTemplateInfo":{"type":"object","properties":{"hash_algorithm":{"type":"string","description":"Hash algorithm used in the certificate signing request.\n* SHA1: SHA-1 hashing algorithm.\n* SHA256: SHA-256 hashing algorithm.\n* SHA384: SHA-384 hashing algorithm.\n* SHA512: SHA-512 hashing algorithm.","example":"SHA_256","enum":["SHA1","SHA256","SHA384","SHA512"]},"minimum_key_length":{"type":"integer","description":"Minimum key-length of the private/public key associated with the certificate.","format":"int32","example":2048},"template_name":{"type":"string","description":"Unique name for this template.","example":"TrueSsoTemplate"},"template_status":{"type":"string","description":"The status of this template.\n* SUPPORTED_OPTIMAL: This template has the optimal properties for TrueSSO.\n* SUPPORTED_NOT_OPTIMAL: This template does not have the ideal properties for TrueSSO.\n* UNKNOWN: This status of this template is unknown. A template with this status cannot be used in connector creation.\n* NO_CAPABILITY: This template is not configured to perform TrueSSO. A template with this status cannot be used in connector creation.\n* INVALID: This template is smart card logon enabled, but some setting is invalid. A template with this status cannot be used in connector creation.\n* MANUAL: This template is smart card logon enabled, but manual enrollment is needed. A template with this status cannot be used in connector creation.\n* UNSUITABLE: This template is smart card logon enabled, but is unsuitable. A template with this status cannot be used in connector creation.","example":"SUPPORTED_OPTIMAL","enum":["SUPPORTED_OPTIMAL","SUPPORTED_NOT_OPTIMAL","UNKNOWN","NO_CAPABILITY","INVALID","MANUAL","UNSUITABLE"]},"template_status_reason":{"type":"string","description":"Additional non-localized explanation of the status."},"validity_seconds":{"type":"integer","description":"Length of time, in seconds, that certificates issues with this template remain valid.","format":"int64","example":36000000000}},"description":"Certificate template data available to certificate servers on this domain."},"UEMServerCreateSpec":{"required":["label","org_name","password","url","username"],"type":"object","properties":{"label":{"type":"string","description":"The name of this UEM Server.","example":"UEM Server 1"},"org_name":{"type":"string","description":"Organization name to be used for enrolment process.","example":"Example Organization"},"password":{"type":"array","description":"Password of the account to be used for enrolment process.","example":"<password>","items":{"type":"string","description":"Password of the account to be used for enrolment process.","example":"<password>"}},"url":{"type":"string","description":"UEM server URL.","example":"https://example.com"},"username":{"type":"string","description":"User name of the account to be used for enrolment process.","example":"administrator"}},"description":"UEM Server object to be added."},"UEMServerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of this UEM Server.","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9"},"label":{"type":"string","description":"The name of this UEM Server.","example":"UEM Server 1"},"managed_desktop_pools":{"type":"array","description":"Desktop Pools Managed by UEM Server.","example":["Pool1","Pool2"],"items":{"type":"string","description":"Desktop Pools Managed by UEM Server.","example":"[\"Pool1\",\"Pool2\"]"}},"org_name":{"type":"string","description":"Organization name to be used for enrolment process.","example":"Example Organization"},"url":{"type":"string","description":"UEM server URL.","example":"https://example.com"},"username":{"type":"string","description":"User name of the account to be used for enrolment process.","example":"administrator"}},"description":"Information about UEM Server Configuration."},"UEMServerUpdateSpec":{"required":["label","org_name","url","username"],"type":"object","properties":{"label":{"type":"string","description":"The name of this UEM Server.","example":"UEM Server 1"},"org_name":{"type":"string","description":"Organization name to be used for enrolment process.","example":"Example Organization"},"password":{"type":"array","description":"Password of the account to be used for enrolment process.","example":"<password>","items":{"type":"string","description":"Password of the account to be used for enrolment process.","example":"<password>"}},"url":{"type":"string","description":"UEM server URL.","example":"https://example.com"},"username":{"type":"string","description":"User name of the account to be used for enrolment process.","example":"administrator"}},"description":"UEM Server object to be updated."},"URLRedirectionCreateSpec":{"required":["scope"],"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of URL Redirection Setting","example":"description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Name for url redirection Settings.","example":"urlredirection"},"enabled":{"type":"boolean","description":"Whether or not this URLRedirection Setting is enabled or not.","example":true,"default":true},"scope":{"type":"string","description":"Represent whether this URL Redirection setting is local or global level.\n* LOCAL: URL Redirection Scope is Local\n* GLOBAL: URL Redirection Scope is Global","example":"LOCAL","enum":["LOCAL","GLOBAL"]},"url_agent_patterns":{"uniqueItems":true,"type":"array","description":"List of URL patterns/Regular expression that must be opened on Agent machine.","items":{"type":"string","description":"List of URL patterns/Regular expression that must be opened on Agent machine."}},"url_client_patterns":{"uniqueItems":true,"type":"array","description":"List of URL patterns/Regular expression that must be opened on client machine.","items":{"type":"string","description":"List of URL patterns/Regular expression that must be opened on client machine."}},"url_global_scheme_info":{"uniqueItems":true,"type":"array","description":"URL Scheme and Global resource (Global Entitlement or Global Application Entitlement) mappings","items":{"$ref":"#/components/schemas/URLRedirectionGlobalSchemeInfo"}},"url_scheme_info":{"uniqueItems":true,"type":"array","description":"URL Scheme and Local resource (Desktop or Application Pool) mappings.","items":{"$ref":"#/components/schemas/URLRedirectionSchemeInfo"}}},"description":"URL Setting object to be created."},"URLRedirectionGlobalSchemeInfo":{"type":"object","properties":{"global_url_scheme":{"type":"string","description":"URL Scheme/protocol used by View Client for URL Filtering. ","example":"https"},"resource_id":{"type":"string","description":"Id of the Resource (Global Application Entitlement or Global Desktop Entitlement) that can handle this URL Scheme.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"type":{"type":"string","description":"Type of the global resource being used.\n* APPLICATION: URL Redirection Scheme type is Application\n* DESKTOP: URL Redirection Scheme type is Desktop","example":"DESKTOP","enum":["APPLICATION","DESKTOP"]}},"description":"Data object having URL Scheme and Global resource (Global Entitlement or Global Application Entitlement) mappings"},"URLRedirectionInfo":{"type":"object","properties":{"description":{"type":"string","description":"Description of the URL Redirection Setting","example":"description"},"display_name":{"type":"string","description":"Name for url redirection Settings.","example":"urlredirection"},"enabled":{"type":"boolean","description":"Whether or not this URLRedirection Setting is enabled or not.","example":true},"id":{"type":"string","description":"Unique entity id for url redirection","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"scope":{"type":"string","description":"Represent whether this URL Redirection setting is local or global level.\n* LOCAL: URL Redirection Scope is Local\n* GLOBAL: URL Redirection Scope is Global","example":"LOCAL","enum":["LOCAL","GLOBAL"]},"url_agent_patterns":{"uniqueItems":true,"type":"array","description":"List of URL patterns/Regular expression that must be opened on Agent machine.","items":{"type":"string","description":"List of URL patterns/Regular expression that must be opened on Agent machine."}},"url_client_patterns":{"uniqueItems":true,"type":"array","description":"List of URL patterns/Regular expression that must be opened on client machine.","items":{"type":"string","description":"List of URL patterns/Regular expression that must be opened on client machine."}},"url_global_scheme_info":{"uniqueItems":true,"type":"array","description":"URL Scheme and Global resource (Global Entitlement or Global Application Entitlement) mappings","items":{"$ref":"#/components/schemas/URLRedirectionGlobalSchemeInfo"}},"url_scheme_info":{"uniqueItems":true,"type":"array","description":"URL Scheme and Local resource (Desktop or Application Pool) mappings.","items":{"$ref":"#/components/schemas/URLRedirectionSchemeInfo"}}},"description":"Configuration Information for the URL Redirection Settings"},"URLRedirectionSchemeInfo":{"type":"object","properties":{"resource_id":{"type":"string","description":"Id of the Resource (Application or Desktop) that can handle this URL Scheme.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"type":{"type":"string","description":"Type of the local resource being used.\n* APPLICATION: URL Redirection Scheme type is Application\n* DESKTOP: URL Redirection Scheme type is Desktop","example":"DESKTOP","enum":["APPLICATION","DESKTOP"]},"url_scheme":{"type":"string","description":"URL Scheme/protocol used by View Client for URL Filtering. ","example":"https"}},"description":"Data Object having URL Scheme and Local resource (Desktop or Application Pool) mappings."},"URLRedirectionUpdateSpec":{"type":"object","properties":{"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Description of URL Redirection Setting","example":"description"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Name for url redirection Settings.","example":"urlredirection"},"enabled":{"type":"boolean","description":"Whether or not this URLRedirection Setting is enabled or not.","example":true,"default":true},"url_agent_patterns":{"uniqueItems":true,"type":"array","description":"List of URL patterns/Regular expression that must be opened on Agent machine.","items":{"type":"string","description":"List of URL patterns/Regular expression that must be opened on Agent machine."}},"url_client_patterns":{"uniqueItems":true,"type":"array","description":"List of URL patterns/Regular expression that must be opened on client machine.","items":{"type":"string","description":"List of URL patterns/Regular expression that must be opened on client machine."}},"url_global_scheme_info":{"uniqueItems":true,"type":"array","description":"URL Scheme and Global resource (Global Entitlement or Global Application Entitlement) mappings","items":{"$ref":"#/components/schemas/URLRedirectionGlobalSchemeInfo"}},"url_scheme_info":{"uniqueItems":true,"type":"array","description":"URL Scheme and Local resource (Desktop or Application Pool) mappings.","items":{"$ref":"#/components/schemas/URLRedirectionSchemeInfo"}}},"description":"URL Setting object to be updated."},"UnauthenticatedAccessUserCreateSpec":{"required":["user_id"],"type":"object","properties":{"alias_name":{"type":"string","description":"Alias to be used for login from client.\nIf unset, AD login name of the user would be used.","example":"unauthenticated-user"},"description":{"type":"string","description":"Description of the unauthenticated access user.","example":"example description"},"hybrid_logon_mode":{"type":"string","description":"Mode to be used for hybrid logon.\nIf unset, hybrid logon will be disabled.\n* PASSWORD: Hybrid logon via username and password.\n* TRUESSO: Hybrid logon via True SSO.\n* DISABLED: Hybrid logon disabled.","example":"PASSWORD","enum":["PASSWORD","TRUESSO","DISABLED"]},"hybrid_logon_password":{"type":"array","description":"Password for the user for hybrid logon.\nThis is required when hybrid_logon_mode is set to PASSWORD.","example":"password","items":{"type":"string","description":"Password for the user for hybrid logon.\nThis is required when hybrid_logon_mode is set to PASSWORD.","example":"password"}},"user_id":{"type":"string","description":"SID of the user for whom unauthenticated access is to be configured.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"}},"description":"Unauthenticated access user specification"},"UnauthenticatedAccessUserInfo":{"type":"object","properties":{"alias_name":{"type":"string","description":"Alias used for login from client.","example":"unauthenticated-user"},"description":{"type":"string","description":"Description of the unauthenticated access user.","example":"example description"},"hybrid_logon_mode":{"type":"string","description":"Mode used for hybrid logon.\n* PASSWORD: Hybrid logon via username and password.\n* TRUESSO: Hybrid logon via True SSO.\n* DISABLED: Hybrid logon disabled.","example":"TRUESSO","enum":["PASSWORD","TRUESSO","DISABLED"]},"id":{"type":"string","description":"ID of the unauthenticated access configuration for the user.","example":"11bd230b-87ce-3306-a943-810affe7b68a"},"source_pod_ids":{"uniqueItems":true,"type":"array","description":"Pods in which the unauthenticated access user was created. \nThis will be unset if CPA is not initialized or if the caller does not have FEDERATED_LDAP_VIEW privilege.","example":["310927ee-1195-44c3-b877-5b194b4b4ea8","78669598-45b6-44a3-aa0d-11b16d45ab73"],"items":{"type":"string","description":"Pods in which the unauthenticated access user was created. \nThis will be unset if CPA is not initialized or if the caller does not have FEDERATED_LDAP_VIEW privilege.","example":"[\"310927ee-1195-44c3-b877-5b194b4b4ea8\",\"78669598-45b6-44a3-aa0d-11b16d45ab73\"]"}},"user_id":{"type":"string","description":"SID of the user for whom unauthenticated access is configured.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"}},"description":"Information related to Unauthenticated Access User."},"UnauthenticatedAccessUserUpdateSpec":{"type":"object","properties":{"description":{"type":"string","description":"Description of the unauthenticated access user.","example":"example description"},"hybrid_logon_mode":{"type":"string","description":"Mode to be used for hybrid logon.\nIf unset, hybrid logon will be disabled.\n* PASSWORD: Hybrid logon via username and password.\n* TRUESSO: Hybrid logon via True SSO.\n* DISABLED: Hybrid logon disabled.","example":"PASSWORD","enum":["PASSWORD","TRUESSO","DISABLED"]},"hybrid_logon_password":{"type":"array","description":"Password for the user for hybrid logon.\nThis is required when hybrid_logon_mode is set to PASSWORD.","example":"password","items":{"type":"string","description":"Password for the user for hybrid logon.\nThis is required when hybrid_logon_mode is set to PASSWORD.","example":"password"}}},"description":"Unauthenticated access user specification"},"UnderConstructionCountMetrics":{"type":"object","properties":{"customizing":{"type":"integer","description":"Number of machines which are in CUSTOMIZING state.","format":"int32","example":1},"deleting":{"type":"integer","description":"Number of machines which are in DELETING state.","format":"int32","example":1},"maintenance":{"type":"integer","description":"Number of machines which are in MAINTENANCE state.","format":"int32","example":1},"provisioning":{"type":"integer","description":"Number of machines which are in PROVISIONING state.","format":"int32","example":1},"start_up_progress":{"type":"integer","description":"Number of machines which are in AGENT_ERR_STARTUP_IN_PROGRESS state.","format":"int32","example":1},"validating":{"type":"integer","description":"Number of machines which are in VALIDATING state.","format":"int32","example":1},"wait_for_agent":{"type":"integer","description":"Number of machines which are in WAIT_FOR_AGENT state.","format":"int32","example":1},"wait_for_hybrid_domain_join":{"type":"integer","description":"Number of machines which are in WAITING_FOR_HYBRID_DOMAIN_JOIN state.","format":"int32","example":1}},"description":"Counts of the RDS server machines which are in under construction state."},"UnentitledMachineInfo":{"type":"object","properties":{"desktop_pool_name":{"type":"string","description":"The name of the Desktop Pool that the machine belongs to.<br>Supported Filters : 'Equals'.\nThis property can be used for sorting.","example":"manualPool"},"dns_name":{"type":"string","description":"DNS name of the machine.<br>Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1.example.com"},"id":{"type":"string","description":"Unique ID representing machine.<br>Supported Filters : 'Equals'.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"name":{"type":"string","description":"Name of the machine.<br>Supported Filters : 'Equals', 'StartsWith' and 'Contains'.\nThis property can be used for sorting.","example":"machine1"},"unentitled_assigned_users":{"uniqueItems":true,"type":"array","description":"The display names of the unentitled users assigned to the machine.<br>Supported Filters : 'Contains'.","example":"[\"example.com\\user1\"]","items":{"type":"string","description":"The display names of the unentitled users assigned to the machine.<br>Supported Filters : 'Contains'.","example":"[\"example.com\\user1\"]"}}},"description":"Information related to unentitled Machines.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br> Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.<br>See the field description to know the filter types it supports."},"UpdateAllowedAccessPathSpec":{"required":["allowed_access_path","pool_ids"],"type":"object","properties":{"allowed_access_path":{"type":"string","description":"Allowed access path to set\n* BOTH: Users from both internal/external network locations are allowed.\n* INTERNAL: Users from internal network location are allowed.\n* EXTERNAL: Users from external network location are allowed.","enum":["BOTH","INTERNAL","EXTERNAL"]},"pool_ids":{"uniqueItems":true,"type":"array","description":"IDs of pools to update","items":{"type":"string","description":"IDs of pools to update"}}},"description":"List of application pool ids for which the allowed access path is to be updated"},"UsageStatisticsLicensingMetrics":{"type":"object","properties":{"concurrent_application_sessions":{"type":"integer","description":"Number of concurrent application sessions.","format":"int32","example":5},"concurrent_collaborative_sessions":{"type":"integer","description":"Number of sessions where a session owner has invited one or more users for session collaboration.","format":"int32","example":9},"concurrent_full_vm_sessions":{"type":"integer","description":"Number of concurrent sessions for full clone virtual machines.","format":"int32","example":5},"concurrent_unmanaged_vm_sessions":{"type":"integer","description":"Number of concurrent sessions for unmanaged machines.","format":"int32","example":7},"total_collaborators":{"type":"integer","description":"Total number of users that are connected to a collaborative session, including the session owner and any collaborators.","format":"int32","example":3},"total_concurrent_connections":{"type":"integer","description":"Concurrent connection user count.","format":"int32","example":10},"total_concurrent_sessions":{"type":"integer","description":"Number of connected sessions.","format":"int32","example":2},"total_named_users":{"type":"integer","description":"Number of unique users that have accessed the Horizon environment since the Horizon deployment was first configured or since the last Named Users Count reset.","format":"int32","example":8}}},"UserOrGroupGlobalSummaryInfo":{"type":"object","properties":{"application_local_session_ids":{"type":"array","description":"Ids for local application sessions for this user. This will be unset if this is a group.","example":["bc6fc134-d197-3bbc-a6bf-24dc63123ae6"],"items":{"type":"string","description":"Ids for local application sessions for this user. This will be unset if this is a group.","example":"[\"bc6fc134-d197-3bbc-a6bf-24dc63123ae6\"]"}},"container":{"type":"string","description":"AD container for this user or group. \nThis property can be used for sorting.","example":"example.com/Users"},"description":{"type":"string","description":"Description of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'. \nThis property can be used for sorting.","example":"Test User account"},"desktop_local_session_ids":{"type":"array","description":"Ids for local desktop sessions for this user. This will be unset if this is a group.","example":["bc6fc134-d197-3bbc-a6bf-24dc63123ae6"],"items":{"type":"string","description":"Ids for local desktop sessions for this user. This will be unset if this is a group.","example":"[\"bc6fc134-d197-3bbc-a6bf-24dc63123ae6\"]"}},"display_name":{"type":"string","description":"Login name with domain of this user or group. \nThis property can be used for sorting.","example":"example.com\\\\testuser"},"distinguished_name":{"type":"string","description":"Active Directory distinguished name for this user or group. \nThis property can be used for sorting.","example":"CN=Test User,CN=Users,DC=example,DC=com"},"domain":{"type":"string","description":"DNS name of the domain in which this user or group belongs.\nSupported Filters : 'Equals'.\n Also, if 'Or' filter is used anywhere in filter string for this model class, then that 'Or' filter should nest only 'Equals' filter on 'domain' or 'id' field. \nThis property can be used for sorting.","example":"example.com"},"domain_net_bios_name":{"type":"string","description":"The domain netbios the user or group is in. This will be the netbios name of the domain.\nThis property can be used for sorting.","example":"example"},"email":{"type":"string","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'. \nThis property can be used for sorting.","example":"testuser@example.com"},"first_name":{"type":"string","description":"First name of this user or group. \nThis property can be used for sorting.","example":"Test"},"global_application_entitlements":{"uniqueItems":true,"type":"array","description":"Global application entitlements for this user.\nSupported Filters : 'Contains'.","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"items":{"type":"string","description":"Global application entitlements for this user.\nSupported Filters : 'Contains'.","example":"[\"0223796c-102b-4ed3-953f-3dfe3d23e1de\"]"}},"global_desktop_entitlements":{"uniqueItems":true,"type":"array","description":"Global desktop entitlements for this user.\nSupported Filters : 'Contains'.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe"],"items":{"type":"string","description":"Global desktop entitlements for this user.\nSupported Filters : 'Contains'.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\"]"}},"global_user_application_entitlements":{"uniqueItems":true,"type":"array","description":"Global application entitlement user entitlements for this user or group.","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"items":{"type":"string","description":"Global application entitlement user entitlements for this user or group.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\"]"}},"global_user_desktop_entitlements":{"uniqueItems":true,"type":"array","description":"Global desktop entitlement user entitlements for this user or group.","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"items":{"type":"string","description":"Global desktop entitlement user entitlements for this user or group.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\"]"}},"group":{"type":"boolean","description":"Indicates if this object represents a group.\n\nSupported Filters: 'Equals'.\nThis property can be used for sorting.","example":false},"id":{"type":"string","description":"Unique SID representing this AD User or Group.\n Supported Filters : 'Equals'. 'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"kiosk_user":{"type":"boolean","description":"Indicates if this user or group is a \"kiosk user\" that supports client authentication. Client authentication is the process of supporting client devices directly logging into resources. \nThis property can be used for sorting.","example":false},"last_name":{"type":"string","description":"Last name of this user or group. \nThis property can be used for sorting.","example":"User"},"login_name":{"type":"string","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'. \nThis property can be used for sorting.","example":"testuser"},"long_display_name":{"type":"string","description":"Login name, domain and name for this user or group, else display name. \nThis property can be used for sorting.","example":"testuser@example.com (Test User)"},"name":{"type":"string","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'. \nThis property can be used for sorting.","example":"Test User"},"phone":{"type":"string","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'. \nThis property can be used for sorting.","example":"1-877-486-9273"},"pod_assignments":{"type":"array","description":"Pod assignments per global entitlement, if any, for this user or group. If this is a group, this will be unset.","example":["58deeb70-97d5-409e-abb4-497196f1ee18"],"items":{"type":"string","description":"Pod assignments per global entitlement, if any, for this user or group. If this is a group, this will be unset.","example":"[\"58deeb70-97d5-409e-abb4-497196f1ee18\"]"}},"unauthenticated_access_user":{"type":"boolean","description":"Whether or not this is unauthenticated access user.\nSupported Filters : 'Equals'. \nThis property can be used for sorting.","example":false},"user_display_name":{"type":"string","description":"User or group's display name. This corresponds with displayName attribute in AD. \nThis property can be used for sorting.","example":"Test User"},"user_home_sites":{"type":"array","description":"Home sites for this user or group. There may be home site overrides for each global entitlement specified for this user or group and one default site for the user or group in general.","example":["32a5ea06-cd09-4609-b3e5-df8379e99c13"],"items":{"type":"string","description":"Home sites for this user or group. There may be home site overrides for each global entitlement specified for this user or group and one default site for the user or group in general.","example":"[\"32a5ea06-cd09-4609-b3e5-df8379e99c13\"]"}},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'. \nThis property can be used for sorting.","example":"testuser@example.com"}},"description":"Global Summary Information related to AD Users or Groups.<br>List API returning this summary information can use search filter query to filter on specific fields supported by filters.<br>Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'.<br>See the field description to know the filter types it supports."},"UserOrGroupLocalSummaryInfo":{"type":"object","properties":{"application_entitlements":{"uniqueItems":true,"type":"array","description":"Local application entitlements for this user or group.","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"items":{"type":"string","description":"Local application entitlements for this user or group.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\"]"}},"application_local_session_ids":{"type":"array","description":"Ids for local application sessions for this user.","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Ids for local application sessions for this user.","example":"[\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"application_pool_ids":{"uniqueItems":true,"type":"array","description":"Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"items":{"type":"string","description":"Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":"[\"0223796c-102b-4ed3-953f-3dfe3d23e1de\"]"}},"container":{"type":"string","description":"AD container for this user or group.\nThis property can be used for sorting.","example":"example.com/Users"},"description":{"type":"string","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test User account"},"desktop_entitlements":{"uniqueItems":true,"type":"array","description":"Local desktop entitlements for this user or group.","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"items":{"type":"string","description":"Local desktop entitlements for this user or group.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\"]"}},"desktop_local_session_ids":{"type":"array","description":"Ids for local desktop sessions for this user.","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Ids for local desktop sessions for this user.","example":"[\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"desktop_pool_ids":{"uniqueItems":true,"type":"array","description":"Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe"],"items":{"type":"string","description":"Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\"]"}},"display_name":{"type":"string","description":"Login name with domain of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"example.com\\\\testuser"},"distinguished_name":{"type":"string","description":"Active Directory distinguished name for this user or group.\nThis property can be used for sorting.","example":"CN=Test User,CN=Users,DC=example,DC=com"},"domain":{"type":"string","description":"DNS name of the domain in which this user or group belongs.\nSupported Filters : 'Equals', 'StartsWith'.\n Also, if 'Or' filter is used anywhere in filter string for this model class, then that 'Or' filter should nest only 'Equals' and 'StartsWith' filter on 'domain' or 'id' field.\nThis property can be used for sorting.","example":"example.com"},"email":{"type":"string","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"},"first_name":{"type":"string","description":"First name of this user or group.Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test"},"group":{"type":"boolean","description":"Indicates if this object represents a group.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"held_user":{"type":"boolean","description":"Indicates if this user is a \"held user\".\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"id":{"type":"string","description":"Unique SID representing this AD User or Group.\nSupported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"kiosk_user":{"type":"boolean","description":"Indicates if this user or group is a \"kiosk user\" that supports client authentication. Client authentication is the process of supporting client devices directly logging into resources.\nThis property can be used for sorting.","example":false},"last_name":{"type":"string","description":"Last name of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"User"},"login_name":{"type":"string","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser"},"long_display_name":{"type":"string","description":"Login name, domain and name for this user or group, else display name\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com (Test User)"},"machine_ids":{"type":"array","description":"Machines this user or group is assigned to.","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"items":{"type":"string","description":"Machines this user or group is assigned to.","example":"[\"0223796c-102b-4ed3-953f-3dfe3d23e1de\"]"}},"name":{"type":"string","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test User"},"phone":{"type":"string","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"1-877-486-9273"},"unauthenticated_access_user":{"type":"boolean","description":"Whether or not this is unauthenticated access user.Supported Filters : 'Equals'. \nThis property can be used for sorting.","example":false},"user_display_name":{"type":"string","description":"User or group's display name. This corresponds with displayName attribute in AD.\nThis property can be used for sorting.","example":"Test User"},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"}},"description":"Local Summary Information related to AD Users or Groups.\n List API returning this summary information can use search filter query to filter on specific fields supported by filters.\n Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'.\nSee the field description to know the filter types it supports."},"UserOrGroupLocalSummaryInfoV2":{"type":"object","properties":{"application_entitlements":{"uniqueItems":true,"type":"array","description":"Local application entitlements for this user or group.","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"items":{"type":"string","description":"Local application entitlements for this user or group.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\"]"}},"application_local_session_ids":{"type":"array","description":"Ids for local application sessions for this user.","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Ids for local application sessions for this user.","example":"[\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"application_pool_ids":{"uniqueItems":true,"type":"array","description":"Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"items":{"type":"string","description":"Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":"[\"0223796c-102b-4ed3-953f-3dfe3d23e1de\"]"}},"container":{"type":"string","description":"AD container for this user or group.\nThis property can be used for sorting.","example":"example.com/Users"},"description":{"type":"string","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test User account"},"desktop_entitlements":{"uniqueItems":true,"type":"array","description":"Local desktop entitlements for this user or group.","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"items":{"type":"string","description":"Local desktop entitlements for this user or group.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\"]"}},"desktop_local_session_ids":{"type":"array","description":"Ids for local desktop sessions for this user.","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Ids for local desktop sessions for this user.","example":"[\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"desktop_pool_ids":{"uniqueItems":true,"type":"array","description":"Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe"],"items":{"type":"string","description":"Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\"]"}},"display_name":{"type":"string","description":"Login name with domain of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"example.com\\\\testuser"},"distinguished_name":{"type":"string","description":"Active Directory distinguished name for this user or group.\nThis property can be used for sorting.","example":"CN=Test User,CN=Users,DC=example,DC=com"},"domain":{"type":"string","description":"DNS name of the domain in which this user or group belongs.\nSupported Filters : 'Equals', 'StartsWith'.\n Also, if 'Or' filter is used anywhere in filter string for this model class, then that 'Or' filter should nest only 'Equals' and 'StartsWith' filter on 'domain' or 'id' field.\nThis property can be used for sorting.","example":"example.com"},"email":{"type":"string","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"},"first_name":{"type":"string","description":"First name of this user or group.Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test"},"group":{"type":"boolean","description":"Indicates if this object represents a group.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"held_user":{"type":"boolean","description":"Indicates if this user is a \"held user\".\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"id":{"type":"string","description":"Unique SID representing this AD User or Group.\nSupported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"kiosk_user":{"type":"boolean","description":"Indicates if this user or group is a \"kiosk user\" that supports client authentication. Client authentication is the process of supporting client devices directly logging into resources.\nThis property can be used for sorting.","example":false},"last_name":{"type":"string","description":"Last name of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"User"},"login_name":{"type":"string","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser"},"long_display_name":{"type":"string","description":"Login name, domain and name for this user or group, else display name\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com (Test User)"},"machine_ids":{"type":"array","description":"Machines this user or group is assigned to.","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"items":{"type":"string","description":"Machines this user or group is assigned to.","example":"[\"0223796c-102b-4ed3-953f-3dfe3d23e1de\"]"}},"name":{"type":"string","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test User"},"persistent_disk_ids":{"uniqueItems":true,"type":"array","description":"The persistent disk(s) assigned to this user.","example":["c1d5aec7-2126-3c55-aefa-11949003c9c2"],"items":{"type":"string","description":"The persistent disk(s) assigned to this user.","example":"[\"c1d5aec7-2126-3c55-aefa-11949003c9c2\"]"}},"phone":{"type":"string","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"1-877-486-9273"},"unauthenticated_access_user":{"type":"boolean","description":"Whether or not this is unauthenticated access user.Supported Filters : 'Equals'. \nThis property can be used for sorting.","example":false},"user_display_name":{"type":"string","description":"User or group's display name. This corresponds with displayName attribute in AD.\nThis property can be used for sorting.","example":"Test User"},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"}},"description":"Local Summary Information related to AD Users or Groups.\n List API returning this summary information can use search filter query to filter on specific fields supported by filters.\n Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'.\nSee the field description to know the filter types it supports."},"UserOrGroupLocalSummaryInfoV3":{"type":"object","properties":{"application_entitlements":{"uniqueItems":true,"type":"array","description":"Local application entitlements for this user or group.","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"items":{"type":"string","description":"Local application entitlements for this user or group.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\"]"}},"application_local_session_ids":{"type":"array","description":"Ids for local application sessions for this user.","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Ids for local application sessions for this user.","example":"[\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"application_pool_ids":{"uniqueItems":true,"type":"array","description":"Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"items":{"type":"string","description":"Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":"[\"0223796c-102b-4ed3-953f-3dfe3d23e1de\"]"}},"container":{"type":"string","description":"AD container for this user or group.\nThis property can be used for sorting.","example":"example.com/Users"},"description":{"type":"string","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test User account"},"desktop_entitlements":{"uniqueItems":true,"type":"array","description":"Local desktop entitlements for this user or group.","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"items":{"type":"string","description":"Local desktop entitlements for this user or group.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\"]"}},"desktop_local_session_ids":{"type":"array","description":"Ids for local desktop sessions for this user.","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Ids for local desktop sessions for this user.","example":"[\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"desktop_pool_ids":{"uniqueItems":true,"type":"array","description":"Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe"],"items":{"type":"string","description":"Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\"]"}},"display_name":{"type":"string","description":"Login name with domain of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"example.com\\\\testuser"},"distinguished_name":{"type":"string","description":"Active Directory distinguished name for this user or group.\nThis property can be used for sorting.","example":"CN=Test User,CN=Users,DC=example,DC=com"},"domain":{"type":"string","description":"DNS name of the domain in which this user or group belongs.\nSupported Filters : 'Equals', 'StartsWith'.\n Also, if 'Or' filter is used anywhere in filter string for this model class, then that 'Or' filter should nest only 'Equals' and 'StartsWith' filter on 'domain' or 'id' field.\nThis property can be used for sorting.","example":"example.com"},"email":{"type":"string","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"},"first_name":{"type":"string","description":"First name of this user or group.Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test"},"gateway_access_user":{"type":"boolean","description":"Whether or not this is Gateway access user.Supported Filters : 'Equals'. \nThis property can be used for sorting.","example":false},"group":{"type":"boolean","description":"Indicates if this object represents a group.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"held_user":{"type":"boolean","description":"Indicates if this user is a \"held user\".\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"id":{"type":"string","description":"Unique SID representing this AD User or Group.\nSupported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"kiosk_user":{"type":"boolean","description":"Indicates if this user or group is a \"kiosk user\" that supports client authentication. Client authentication is the process of supporting client devices directly logging into resources.\nThis property can be used for sorting.","example":false},"last_name":{"type":"string","description":"Last name of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"User"},"login_name":{"type":"string","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser"},"long_display_name":{"type":"string","description":"Login name, domain and name for this user or group, else display name\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com (Test User)"},"machine_ids":{"type":"array","description":"Machines this user or group is assigned to.","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"items":{"type":"string","description":"Machines this user or group is assigned to.","example":"[\"0223796c-102b-4ed3-953f-3dfe3d23e1de\"]"}},"name":{"type":"string","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test User"},"persistent_disk_ids":{"uniqueItems":true,"type":"array","description":"The persistent disk(s) assigned to this user.","example":["c1d5aec7-2126-3c55-aefa-11949003c9c2"],"items":{"type":"string","description":"The persistent disk(s) assigned to this user.","example":"[\"c1d5aec7-2126-3c55-aefa-11949003c9c2\"]"}},"phone":{"type":"string","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"1-877-486-9273"},"unauthenticated_access_user":{"type":"boolean","description":"Whether or not this is unauthenticated access user.Supported Filters : 'Equals'. \nThis property can be used for sorting.","example":false},"user_display_name":{"type":"string","description":"User or group's display name. This corresponds with displayName attribute in AD.\nThis property can be used for sorting.","example":"Test User"},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"}}},"UserOrGroupLocalSummaryInfoV4":{"type":"object","properties":{"application_entitlements":{"uniqueItems":true,"type":"array","description":"Local application entitlements for this user or group.","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"items":{"type":"string","description":"Local application entitlements for this user or group.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\"]"}},"application_local_session_ids":{"type":"array","description":"Ids for local application sessions for this user.","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Ids for local application sessions for this user.","example":"[\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"application_pool_ids":{"uniqueItems":true,"type":"array","description":"Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"items":{"type":"string","description":"Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":"[\"0223796c-102b-4ed3-953f-3dfe3d23e1de\"]"}},"cloud_entitlement":{"type":"boolean","description":"Indicates if the user or group is part of cloud entitlements.Supported Filters : 'Equals'. \nThis property can be used for sorting.","example":false},"container":{"type":"string","description":"AD container for this user or group.\nThis property can be used for sorting.","example":"example.com/Users"},"description":{"type":"string","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test User account"},"desktop_entitlements":{"uniqueItems":true,"type":"array","description":"Local desktop entitlements for this user or group.","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"items":{"type":"string","description":"Local desktop entitlements for this user or group.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\"]"}},"desktop_local_session_ids":{"type":"array","description":"Ids for local desktop sessions for this user.","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Ids for local desktop sessions for this user.","example":"[\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"desktop_pool_ids":{"uniqueItems":true,"type":"array","description":"Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe"],"items":{"type":"string","description":"Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\"]"}},"display_name":{"type":"string","description":"Login name with domain of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"example.com\\\\testuser"},"distinguished_name":{"type":"string","description":"Active Directory distinguished name for this user or group.\nThis property can be used for sorting.","example":"CN=Test User,CN=Users,DC=example,DC=com"},"domain":{"type":"string","description":"DNS name of the domain in which this user or group belongs.\nSupported Filters : 'Equals', 'StartsWith'.\n Also, if 'Or' filter is used anywhere in filter string for this model class, then that 'Or' filter should nest only 'Equals' and 'StartsWith' filter on 'domain' or 'id' field.\nThis property can be used for sorting.","example":"example.com"},"email":{"type":"string","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"},"first_name":{"type":"string","description":"First name of this user or group.Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test"},"gateway_access_user":{"type":"boolean","description":"Whether or not this is Gateway access user.Supported Filters : 'Equals'. \nThis property can be used for sorting.","example":false},"group":{"type":"boolean","description":"Indicates if this object represents a group.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"held_user":{"type":"boolean","description":"Indicates if this user is a \"held user\".\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"id":{"type":"string","description":"Unique SID representing this AD User or Group.\nSupported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"kiosk_user":{"type":"boolean","description":"Indicates if this user or group is a \"kiosk user\" that supports client authentication. Client authentication is the process of supporting client devices directly logging into resources.\nThis property can be used for sorting.","example":false},"last_name":{"type":"string","description":"Last name of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"User"},"login_name":{"type":"string","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser"},"long_display_name":{"type":"string","description":"Login name, domain and name for this user or group, else display name\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com (Test User)"},"machine_ids":{"type":"array","description":"Machines this user or group is assigned to.","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"items":{"type":"string","description":"Machines this user or group is assigned to.","example":"[\"0223796c-102b-4ed3-953f-3dfe3d23e1de\"]"}},"name":{"type":"string","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test User"},"persistent_disk_ids":{"uniqueItems":true,"type":"array","description":"The persistent disk(s) assigned to this user.","example":["c1d5aec7-2126-3c55-aefa-11949003c9c2"],"items":{"type":"string","description":"The persistent disk(s) assigned to this user.","example":"[\"c1d5aec7-2126-3c55-aefa-11949003c9c2\"]"}},"phone":{"type":"string","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"1-877-486-9273"},"unauthenticated_access_user":{"type":"boolean","description":"Whether or not this is unauthenticated access user.Supported Filters : 'Equals'. \nThis property can be used for sorting.","example":false},"user_display_name":{"type":"string","description":"User or group's display name. This corresponds with displayName attribute in AD.\nThis property can be used for sorting.","example":"Test User"},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"}}},"UserOrGroupLocalSummaryInfoV5":{"type":"object","properties":{"application_entitlements":{"uniqueItems":true,"type":"array","description":"Local application entitlements for this user or group.","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"items":{"type":"string","description":"Local application entitlements for this user or group.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\"]"}},"application_local_session_count":{"type":"integer","description":"Count for local application sessions for this user.\nThis property can be used for sorting.","format":"int32","example":3},"application_local_session_ids":{"type":"array","description":"Ids for local application sessions for this user.","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Ids for local application sessions for this user.","example":"[\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"application_pool_count":{"type":"integer","description":"Count of application pools this user or group is assigned to.\nThis property can be used for sorting.","format":"int32","example":3},"application_pool_ids":{"uniqueItems":true,"type":"array","description":"Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"items":{"type":"string","description":"Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":"[\"0223796c-102b-4ed3-953f-3dfe3d23e1de\"]"}},"cloud_entitlement":{"type":"boolean","description":"Indicates if the user or group is part of cloud entitlements.Supported Filters : 'Equals'. \nThis property can be used for sorting.","example":false},"container":{"type":"string","description":"AD container for this user or group.\nThis property can be used for sorting.","example":"example.com/Users"},"description":{"type":"string","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test User account"},"desktop_entitlements":{"uniqueItems":true,"type":"array","description":"Local desktop entitlements for this user or group.","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"items":{"type":"string","description":"Local desktop entitlements for this user or group.","example":"[\"S-1-1-1-3965912346-1012345398-3123456564-123\"]"}},"desktop_local_session_count":{"type":"integer","description":"Count for local desktop sessions for this user.\nThis property can be used for sorting.","format":"int32","example":2},"desktop_local_session_ids":{"type":"array","description":"Ids for local desktop sessions for this user.","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"items":{"type":"string","description":"Ids for local desktop sessions for this user.","example":"[\"7cdd624f-37d1-46c1-ab96-695a5d13956f\"]"}},"desktop_pool_count":{"type":"integer","description":"Count of desktop pools this user or group is assigned to.\nThis property can be used for sorting.","format":"int32","example":2},"desktop_pool_ids":{"uniqueItems":true,"type":"array","description":"Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe"],"items":{"type":"string","description":"Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.","example":"[\"0103796c-102b-4ed3-953f-3dfe3d23e0fe\"]"}},"display_name":{"type":"string","description":"Login name with domain of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"example.com\\\\testuser"},"distinguished_name":{"type":"string","description":"Active Directory distinguished name for this user or group.\nThis property can be used for sorting.","example":"CN=Test User,CN=Users,DC=example,DC=com"},"domain":{"type":"string","description":"DNS name of the domain in which this user or group belongs.\nSupported Filters : 'Equals', 'StartsWith'.\n Also, if 'Or' filter is used anywhere in filter string for this model class, then that 'Or' filter should nest only 'Equals' and 'StartsWith' filter on 'domain' or 'id' field.\nThis property can be used for sorting.","example":"example.com"},"email":{"type":"string","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"},"first_name":{"type":"string","description":"First name of this user or group.Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test"},"gateway_access_user":{"type":"boolean","description":"Whether or not this is Gateway access user.Supported Filters : 'Equals'. \nThis property can be used for sorting.","example":false},"group":{"type":"boolean","description":"Indicates if this object represents a group.\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"held_user":{"type":"boolean","description":"Indicates if this user is a \"held user\".\nSupported Filters : 'Equals'.\nThis property can be used for sorting.","example":false},"id":{"type":"string","description":"Unique SID representing this AD User or Group.\nSupported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"kiosk_user":{"type":"boolean","description":"Indicates if this user or group is a \"kiosk user\" that supports client authentication. Client authentication is the process of supporting client devices directly logging into resources.\nThis property can be used for sorting.","example":false},"last_name":{"type":"string","description":"Last name of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"User"},"login_name":{"type":"string","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser"},"long_display_name":{"type":"string","description":"Login name, domain and name for this user or group, else display name\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com (Test User)"},"machine_ids":{"type":"array","description":"Machines this user or group is assigned to.","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"items":{"type":"string","description":"Machines this user or group is assigned to.","example":"[\"0223796c-102b-4ed3-953f-3dfe3d23e1de\"]"}},"name":{"type":"string","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"Test User"},"persistent_disk_ids":{"uniqueItems":true,"type":"array","description":"The persistent disk(s) assigned to this user.","example":["c1d5aec7-2126-3c55-aefa-11949003c9c2"],"items":{"type":"string","description":"The persistent disk(s) assigned to this user.","example":"[\"c1d5aec7-2126-3c55-aefa-11949003c9c2\"]"}},"phone":{"type":"string","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"1-877-486-9273"},"total_local_session_count":{"type":"integer","description":"Total Count for local application and desktop sessions for this user.\nThis property can be used for sorting.","format":"int32","example":3},"unauthenticated_access_user":{"type":"boolean","description":"Whether or not this is unauthenticated access user.Supported Filters : 'Equals'. \nThis property can be used for sorting.","example":false},"user_display_name":{"type":"string","description":"User or group's display name. This corresponds with displayName attribute in AD.\nThis property can be used for sorting.","example":"Test User"},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"}}},"UserPoliciesInfo":{"type":"object","properties":{"desktop_pool_id":{"type":"string","description":"ID of the desktop pool associated with the user override.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_name":{"type":"string","description":"Display name of the Desktop Pool.Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"pool"},"effective_policies":{"$ref":"#/components/schemas/PoliciesSettings"},"user_display_name":{"type":"string","description":"User or group's display name of the user for whom unentitled policy override is configured. This corresponds with displayName attribute in AD. Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"test.local\\user1"},"user_id":{"type":"string","description":"SID of the user.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"user_policies":{"$ref":"#/components/schemas/PoliciesSettings"},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of the user for whom policy override is configured.Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"}},"description":"Information related to user policies overrides. Supported Filters : 'Equals', 'StartsWith', 'Contains'.\\n\" +\nSee the field description to know the filter types it supports."},"UserPoliciesInfoV2":{"type":"object","properties":{"desktop_pool_id":{"type":"string","description":"ID of the desktop pool associated with the user override.","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"},"desktop_pool_name":{"type":"string","description":"Display name of the Desktop Pool.Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"pool"},"effective_policies":{"$ref":"#/components/schemas/PoliciesSettings"},"user_display_name":{"type":"string","description":"User or group's display name of the user for whom unentitled policy override is configured. This corresponds with displayName attribute in AD. Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"test.local\\user1"},"user_id":{"type":"string","description":"SID of the user.","example":"S-1-5-21-1111111111-2222222222-3333333333-500"},"user_long_display_name":{"type":"string","description":"User Long Display name(ULN) of the user for whom policy override is configured.Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"},"user_policies":{"$ref":"#/components/schemas/PoliciesSettings"},"user_principal_name":{"type":"string","description":"User Principal name(UPN) of the user for whom policy override is configured.Supported Filters : 'Equals', 'StartsWith', 'Contains'.\nThis property can be used for sorting.","example":"testuser@example.com"}},"description":"Information related to user policies overrides. Supported Filters : 'Equals', 'StartsWith', 'Contains'.\\n\" +\nSee the field description to know the filter types it supports."},"UserPoliciesSpec":{"required":["user_id","user_policies"],"type":"object","properties":{"user_id":{"type":"string","description":"User SID."},"user_policies":{"$ref":"#/components/schemas/PoliciesSettings"}},"description":"Information related to policy overrides for a user."},"UserPoliciesUpdateSpec":{"required":["user_id","user_policies"],"type":"object","properties":{"user_id":{"type":"string","description":"User SID."},"user_policies":{"$ref":"#/components/schemas/PoliciesSettingsUpdateSpec"}},"description":"Information related to policy overrides for a user."},"VCLimits":{"type":"object","properties":{"instant_clone_engine_provisioning_limit":{"type":"integer","description":"Maximum concurrent instant clone engine provisioning operations. This property has a default value of 20. This property has a minimum value of 1.","format":"int32","example":20},"power_operations_limit":{"type":"integer","description":"Maximum concurrent virtual center power operations. This property has a default value of 50. This property has a minimum value of 1.","format":"int32","example":50},"provisioning_limit":{"type":"integer","description":"Maximum concurrent virtual center provisioning operations. This property has a default value of 20. This property has a minimum value of 1.","format":"int32","example":20}},"description":"Information about the limits configured for Virtual Center"},"VCLimitsCreateSpec":{"type":"object","properties":{"instant_clone_engine_provisioning_limit":{"minimum":1,"type":"integer","description":"Maximum concurrent instant clone engine provisioning operations. This property has a default value of 20. This property has a minimum value of 1.","format":"int32","example":20},"instant_clone_maintenance_limit":{"minimum":1,"type":"integer","description":"Maximum concurrent view composer refit operations.  This property has a default value of 12. This property has a minimum value of 1.","format":"int32","example":12},"power_operations_limit":{"minimum":1,"type":"integer","description":"Maximum concurrent virtual center power operations. This property has a default value of 50. This property has a minimum value of 1.","format":"int32","example":50},"provisioning_limit":{"minimum":1,"type":"integer","description":"Maximum concurrent virtual center provisioning operations. This property has a default value of 20. This property has a minimum value of 1.","format":"int32","example":20}},"description":"Information about the limits configured for Virtual Center"},"VCLimitsUpdateSpec":{"required":["instant_clone_engine_provisioning_limit","instant_clone_maintenance_limit","power_operations_limit","provisioning_limit"],"type":"object","properties":{"instant_clone_engine_provisioning_limit":{"minimum":1,"type":"integer","description":"Maximum concurrent instant clone engine provisioning operations. This property has a default value of 20. This property has a minimum value of 1.","format":"int32","example":20},"instant_clone_maintenance_limit":{"minimum":1,"type":"integer","description":"Maximum concurrent view composer refit operations.  This property has a default value of 12. This property has a minimum value of 1.","format":"int32","example":12},"power_operations_limit":{"minimum":1,"type":"integer","description":"Maximum concurrent virtual center power operations. This property has a default value of 50. This property has a minimum value of 1.","format":"int32","example":50},"provisioning_limit":{"minimum":1,"type":"integer","description":"Maximum concurrent virtual center provisioning operations. This property has a default value of 20. This property has a minimum value of 1.","format":"int32","example":20}},"description":"Information about the limits configured for Virtual Center"},"VCLimitsV2":{"type":"object","properties":{"instant_clone_engine_provisioning_limit":{"type":"integer","description":"Maximum concurrent instant clone engine provisioning operations. This property has a default value of 20. This property has a minimum value of 1.","format":"int32","example":20},"instant_clone_maintenance_limit":{"type":"integer","description":"Maximum concurrent view composer refit operations.  This property has a default value of 12. This property has a minimum value of 1.","format":"int32","example":12},"power_operations_limit":{"type":"integer","description":"Maximum concurrent virtual center power operations. This property has a default value of 50. This property has a minimum value of 1.","format":"int32","example":50},"provisioning_limit":{"type":"integer","description":"Maximum concurrent virtual center provisioning operations. This property has a default value of 20. This property has a minimum value of 1.","format":"int32","example":20}},"description":"Information about the limits configured for Virtual Center"},"VCMonitorConnectionServer":{"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/CertificateMonitorInfo"},"id":{"type":"string","description":"Unique ID of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the Virtual Center Connection with respect to this Connection Server.\n* OK: The connection to Virtual Center server is working properly.\n* DOWN: The connection to Virtual Center server is down.\n* RECONNECTING: The connection to Virtual Center server was lost and is being reconnected to.\n* UNKNOWN: Connection state to Virtual Center server is unknown.\n* INVALID_CREDENTIALS: The supplied credentials cannot be used to authenticate to the Virtual Center server.\n* CANNOT_LOGIN: The connection server cannot login to the Virtual Center server.\n* NOT_YET_CONNECTED: Connection server has not yet connected to Virtual Center server.","example":"OK","enum":["OK","DOWN","RECONNECTING","UNKNOWN","INVALID_CREDENTIALS","CANNOT_LOGIN","NOT_YET_CONNECTED"]},"thumbprint_accepted":{"type":"boolean","description":"Indicates if the thumbprints of the Virtual Center was accepted.","example":true}},"description":"Information about connection to Virtual Center from Connection Server."},"VCMonitorConnectionServerV2":{"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/CertificateMonitorInfo"},"id":{"type":"string","description":"Unique ID of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the Virtual Center Connection with respect to this Connection Server.\n* OK: The connection to Virtual Center server is working properly.\n* DOWN: The connection to Virtual Center server is down.\n* RECONNECTING: The connection to Virtual Center server was lost and is being reconnected to.\n* UNKNOWN: Connection state to Virtual Center server is unknown.\n* INVALID_CREDENTIALS: The supplied credentials cannot be used to authenticate to the Virtual Center server.\n* CANNOT_LOGIN: The connection server cannot login to the Virtual Center server.\n* NOT_YET_CONNECTED: Connection server has not yet connected to Virtual Center server.","example":"OK","enum":["OK","DOWN","RECONNECTING","UNKNOWN","INVALID_CREDENTIALS","CANNOT_LOGIN","NOT_YET_CONNECTED"]},"thumbprint_accepted":{"type":"boolean","description":"Indicates if the thumbprints of the Virtual Center was accepted.","example":true}},"description":"Information about connection to Virtual Center from Connection Server."},"VCMonitorConnectionServerV3":{"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/CertificateMonitorInfoV2"},"id":{"type":"string","description":"Unique ID of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the Virtual Center Connection with respect to this Connection Server.\n* OK: The connection to Virtual Center server is working properly.\n* DOWN: The connection to Virtual Center server is down.\n* RECONNECTING: The connection to Virtual Center server was lost and is being reconnected to.\n* UNKNOWN: Connection state to Virtual Center server is unknown.\n* INVALID_CREDENTIALS: The supplied credentials cannot be used to authenticate to the Virtual Center server.\n* CANNOT_LOGIN: The connection server cannot login to the Virtual Center server.\n* NOT_YET_CONNECTED: Connection server has not yet connected to Virtual Center server.","example":"OK","enum":["OK","DOWN","RECONNECTING","UNKNOWN","INVALID_CREDENTIALS","CANNOT_LOGIN","NOT_YET_CONNECTED"]},"thumbprint_accepted":{"type":"boolean","description":"Indicates if the thumbprints of the Virtual Center was accepted.","example":true}},"description":"Information about connection to Virtual Center from Connection Server."},"VCMonitorDatastore":{"type":"object","properties":{"capacity_mb":{"type":"integer","description":"The capacity of the datastore in megabytes.","format":"int64","example":12345},"details":{"$ref":"#/components/schemas/VCMonitorDatastoreDetails"},"free_space_mb":{"type":"integer","description":"The free space on the datastore in megabytes.","format":"int64","example":12345},"status":{"type":"string","description":"Status of the datastore.\n* ACCESSIBLE: The datastore is accessible.\n* NOT_ACCESSIBLE: The datastore is not accessible.","example":"ACCESSIBLE","enum":["ACCESSIBLE","NOT_ACCESSIBLE"]},"type":{"type":"string","description":"Type of the datastore.\n* VMFS: VMFS datastore.\n* VSAN: VSAN datastore.\n* VVOL: VVOL datastore.","example":"VSAN","enum":["VMFS","VSAN","VVOL"]}},"description":"Information about the datastore of the host(s) connected to the given Virtual Center."},"VCMonitorDatastoreDetails":{"type":"object","properties":{"name":{"type":"string","description":"Datastore name.","example":"vsandatastore"},"path":{"type":"string","description":"Path to the datastore.","example":"/datacenter1/vsandatastore"},"url":{"type":"string","description":"Unique locator for datastore.","example":"ds:///vmfs/volumes/vsan:52654c2aa8e79416-8ea7a3309e82c7b7/"}},"description":"Details about the datastore."},"VCMonitorDatastoreV2":{"type":"object","properties":{"capacity_mb":{"type":"integer","description":"The capacity of the datastore in megabytes.","format":"int64","example":12345},"details":{"$ref":"#/components/schemas/VCMonitorDatastoreDetails"},"free_space_mb":{"type":"integer","description":"The free space on the datastore in megabytes.","format":"int64","example":12345},"host_or_cluster_id":{"type":"string","description":"host or cluster id for the datastore.","example":"domain-c123"},"id":{"type":"string","description":"Datastore id.","example":"datastore-1234"},"status":{"type":"string","description":"Status of the datastore.\n* ACCESSIBLE: The datastore is accessible.\n* NOT_ACCESSIBLE: The datastore is not accessible.","example":"ACCESSIBLE","enum":["ACCESSIBLE","NOT_ACCESSIBLE"]},"type":{"type":"string","description":"Type of the datastore.\n* VMFS: VMFS datastore.\n* VSAN: VSAN datastore.\n* VVOL: VVOL datastore.","example":"VSAN","enum":["VMFS","VSAN","VVOL"]}},"description":"Information about the datastore of the host(s) connected to the given Virtual Center."},"VCMonitorDetails":{"type":"object","properties":{"api_version":{"type":"string","description":"API Version of the Virtual Center.","example":"6.5"},"build":{"type":"string","description":"Build number of the Virtual Center.","example":"12345678.0.1"},"version":{"type":"string","description":"Version of the Virtual Center.","example":"6.5.0"}},"description":"Details about the Virtual Center."},"VCMonitorDetailsV2":{"type":"object","properties":{"api_version":{"type":"string","description":"API Version of the Virtual Center.","example":"6.5"},"build":{"type":"string","description":"Build number of the Virtual Center.","example":"12345678.0.1"},"instance_uuid":{"type":"string","description":"Virtual center instanceUuid.","example":"3"},"num_desktops":{"type":"integer","description":"Number of Desktops managed by the virtual center.","format":"int32","example":3},"num_machines":{"type":"integer","description":"Number of Machines managed by the virtual center.","format":"int32"},"version":{"type":"string","description":"Version of the Virtual Center.","example":"6.5.0"}},"description":"Details about the Virtual Center."},"VCMonitorHost":{"type":"object","properties":{"cpu_core_count":{"type":"integer","description":"Number of physical CPU cores on the host.","format":"int32","example":16},"cpu_mhz":{"type":"integer","description":"CPU speed per core in Mhz. This might be an averaged value if the speed is not uniform across all cores.","format":"int32","example":2194},"details":{"$ref":"#/components/schemas/VCMonitorHostDetails"},"memory_size_mb":{"type":"integer","description":"The physical memory size in mega bytes.","format":"int32","example":12345},"status":{"type":"string","description":"Status of the host connection.\n* CONNECTED: The host is successfully connected to Virtual Center server.\n* DISCONNECTED: The host is disconnected from Virtual Center server.\n* NOT_RESPONDING: The host is not responding.","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","NOT_RESPONDING"]}},"description":"Information about the host connected to a Virtual Center."},"VCMonitorHostDetails":{"type":"object","properties":{"api_version":{"type":"string","description":"API Version of the ESX Host.","example":"6.5"},"cluster_name":{"type":"string","description":"Name of the cluster of the ESX Host in the Virtual Center.","example":"cluster-1"},"name":{"type":"string","description":"ESX Host name or IP address.","example":"host1.example.com"},"version":{"type":"string","description":"ESX Host version.","example":"6.5.0"},"vgpu_types":{"type":"array","description":"Types of vGPUs supported by this host.","items":{"type":"string","description":"Types of vGPUs supported by this host."}}},"description":"Details of the ESX host of the Virtual Center."},"VCMonitorHostV2":{"type":"object","properties":{"cpu_core_count":{"type":"integer","description":"Number of physical CPU cores on the host.","format":"int32","example":16},"cpu_mhz":{"type":"integer","description":"CPU speed per core in Mhz. This might be an averaged value if the speed is not uniform across all cores.","format":"int32","example":2194},"details":{"$ref":"#/components/schemas/VCMonitorHostDetails"},"memory_size_mb":{"type":"integer","description":"The physical memory size in mega bytes.","format":"int32","example":12345},"overall_cpu_usage_mhz":{"type":"integer","description":"Aggregated CPU usage across all cores on the host, in MHz.","format":"int32","example":1209},"overall_memory_usage_mb":{"type":"integer","description":"Physical memory usage on the host, in MBs.","format":"int32","example":66569},"status":{"type":"string","description":"Status of the host connection.\n* CONNECTED: The host is successfully connected to Virtual Center server.\n* DISCONNECTED: The host is disconnected from Virtual Center server.\n* NOT_RESPONDING: The host is not responding.","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","NOT_RESPONDING"]}},"description":"Information about the host connected to a Virtual Center."},"VCMonitorHostV3":{"type":"object","properties":{"cpu_core_count":{"type":"integer","description":"Number of physical CPU cores on the host.","format":"int32","example":16},"cpu_mhz":{"type":"integer","description":"CPU speed per core in Mhz. This might be an averaged value if the speed is not uniform across all cores.","format":"int32","example":2194},"details":{"$ref":"#/components/schemas/VCMonitorHostDetails"},"memory_size_mb":{"type":"integer","description":"The physical memory size in mega bytes.","format":"int32","example":12345},"num_machines":{"type":"integer","description":"Number of machines provisioned on the host. ","format":"int32","example":1},"overall_cpu_usage_mhz":{"type":"integer","description":"Aggregated CPU usage across all cores on the host, in MHz.","format":"int32","example":1209},"overall_memory_usage_mb":{"type":"integer","description":"Physical memory usage on the host, in MBs.","format":"int32","example":66569},"status":{"type":"string","description":"Status of the host connection.\n* CONNECTED: The host is successfully connected to Virtual Center server.\n* DISCONNECTED: The host is disconnected from Virtual Center server.\n* NOT_RESPONDING: The host is not responding.","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","NOT_RESPONDING"]}},"description":"Information about the host connected to a Virtual Center."},"VCMonitorHostV4":{"type":"object","properties":{"cpu_core_count":{"type":"integer","description":"Number of physical CPU cores on the host.","format":"int32","example":16},"cpu_mhz":{"type":"integer","description":"CPU speed per core in Mhz. This might be an averaged value if the speed is not uniform across all cores.","format":"int32","example":2194},"details":{"$ref":"#/components/schemas/VCMonitorHostDetails"},"id":{"type":"string","description":"ESX Host or cluster id in the vcenter","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"memory_size_mb":{"type":"integer","description":"The physical memory size in mega bytes.","format":"int32","example":12345},"num_machines":{"type":"integer","description":"Number of machines provisioned on the host. ","format":"int32","example":1},"overall_cpu_usage_mhz":{"type":"integer","description":"Aggregated CPU usage across all cores on the host, in MHz.","format":"int32","example":1209},"overall_memory_usage_mb":{"type":"integer","description":"Physical memory usage on the host, in MBs.","format":"int32","example":66569},"status":{"type":"string","description":"Status of the host connection.\n* CONNECTED: The host is successfully connected to Virtual Center server.\n* DISCONNECTED: The host is disconnected from Virtual Center server.\n* NOT_RESPONDING: The host is not responding.","example":"CONNECTED","enum":["CONNECTED","DISCONNECTED","NOT_RESPONDING"]}},"description":"Information about the host connected to a Virtual Center."},"VMFolderInfo":{"type":"object","properties":{"children":{"type":"array","description":"Child nodes of the VM folder.","example":[],"items":{"$ref":"#/components/schemas/VMFolderInfo"}},"datacenter_id":{"type":"string","description":"Datacenter id for this VM folder.","example":"datacenter-1"},"id":{"type":"string","description":"Unique ID representing the VM folder.","example":"group-v1"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this VM folder from being used in desktop pool or farm.","items":{"type":"string","description":"* IN_USE: When the VM folder is in use by another desktop/farm, this cannot be used in desktop pool/farm.\n* REPLICA_FOLDER: When the VM folder currently holds View Composer or Instant Clone Engine replicas this VM folder cannot be used in linked or instant clone desktop pool/farm.","enum":["IN_USE","REPLICA_FOLDER"]}},"name":{"type":"string","description":"VM folder name.","example":"Discovered virtual machine"},"path":{"type":"string","description":"VM folder path.","example":"/Datacenter/vm/Discovered virtual machine"},"type":{"type":"string","description":"VM folder type.\n* DATACENTER: A datacenter that serves as a folder suitable for use in desktop pool/farm.\n* FOLDER: A regular folder suitable for use in desktop pool/farm.\n* OTHER: Other folder type that cannot be used in desktop pool/farm.","example":"FOLDER","enum":["DATACENTER","FOLDER","OTHER"]},"vcenter_id":{"type":"string","description":"Virtual Center id for this VM folder.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}},"description":"Information related to VM folder."},"VMTemplateInfo":{"type":"object","properties":{"datacenter_id":{"type":"string","description":"Datacenter id for this VM template.\nSupported Filters : 'Equals'.","example":"datacenter-1"},"disk_size_in_bytes":{"type":"integer","description":"Sum of capacities of all the virtual disks in the template, in bytes.\nSupported Filters : 'Equals','Between'.","format":"int64","example":42949672960},"id":{"type":"string","description":"Unique ID representing a VM template.\nSupported Filters : 'Equals'.","example":"vm-1"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this VM template from being used in full clone desktop pool creation.\nSupported Filters : 'Equals', 'NotEquals'.","items":{"type":"string","description":"* UNSUPPORTED_OS: This VMTemplate has an unsupported operating system. Certain server operating systems are only supported when SettingsInfo.GeneralSettings.enableServerInSingleUserMode is true.","enum":["UNSUPPORTED_OS"]}},"memory_mb":{"type":"integer","description":"Memory size of the VM template, in MB\nSupported Filters : 'Equals','Between'.","format":"int32","example":4096},"name":{"type":"string","description":"VM template name.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting.","example":"Win10Template"},"operating_system":{"type":"string","description":"Operating system.\nSupported Filters : 'Equals'.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_10","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_display_name":{"type":"string","description":"Operating system display name from Virtual Center.\nSupported Filters : 'Equals'.","example":"Microsoft Windows 10 (64-bit)"},"path":{"type":"string","description":"VM template path.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting.","example":"/Datacenter/vm/Templates/Win10Template"},"vcenter_id":{"type":"string","description":"ID of the vCenter to which this VM template belongs to.\nSupported Filters : 'Equals'.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"vgpu_type":{"type":"string","description":"NVIDIA GRID vGPU type configured on this VM template.\nSupported Filters : 'Equals'."}},"description":"Information related to VM template.\nSupported Filters : 'Equals'."},"VMTemplateInfoV2":{"type":"object","properties":{"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the VM-template was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"datacenter_id":{"type":"string","description":"Datacenter id for this VM template.\nSupported Filters : 'Equals'.","example":"datacenter-1"},"disk_size_in_bytes":{"type":"integer","description":"Sum of capacities of all the virtual disks in the template, in bytes.\nSupported Filters : 'Equals','Between'.","format":"int64","example":42949672960},"id":{"type":"string","description":"Unique ID representing a VM template.\nSupported Filters : 'Equals'.","example":"vm-1"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this VM template from being used in full clone desktop pool creation.\nSupported Filters : 'Equals', 'NotEquals'.","items":{"type":"string","description":"* UNSUPPORTED_OS: This VMTemplate has an unsupported operating system. Certain server operating systems are only supported when SettingsInfo.GeneralSettings.enableServerInSingleUserMode is true.","enum":["UNSUPPORTED_OS"]}},"memory_mb":{"type":"integer","description":"Memory size of the VM template, in MB\nSupported Filters : 'Equals','Between'.","format":"int32","example":4096},"name":{"type":"string","description":"VM template name.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting.","example":"Win10Template"},"operating_system":{"type":"string","description":"Operating system.\nSupported Filters : 'Equals'.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_10","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_display_name":{"type":"string","description":"Operating system display name from Virtual Center.\nSupported Filters : 'Equals'.","example":"Microsoft Windows 10 (64-bit)"},"path":{"type":"string","description":"VM template path.\nSupported Filters : 'Equals','StartsWith','Contains'.\nThis property can be used for sorting.","example":"/Datacenter/vm/Templates/Win10Template"},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the VM-template was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"vcenter_id":{"type":"string","description":"ID of the vCenter to which this VM template belongs to.\nSupported Filters : 'Equals'.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"vgpu_type":{"type":"string","description":"NVIDIA GRID vGPU type configured on this VM template.\nSupported Filters : 'Equals'."}},"description":"Information related to VM template."},"VMToolsInfo":{"type":"object","properties":{"tools_status":{"type":"string","description":"VMware tools status.\n* GUEST_TOOLS_RUNNING: Indicates that VMware guest tools is running.\n* GUEST_TOOLS_STOPPED: Indicates that VMware guest tools is not running.\n* GUEST_TOOLS_STOP_PENDING: Indicates that VMware guest tools is stopping.\n* GUEST_TOOLS_START_PENDING: Indicates that VMware guest tools is starting.\n* GUEST_TOOLS_PAUSE_PENDING: Indicates that VMware guest tools is pausing.\n* GUEST_TOOLS_PAUSED: Indicates that VMware guest tools has paused.\n* GUEST_TOOLS_CONTINUING: Indicates that VMware guest tools is continuing.\n* GUEST_TOOLS_UNKNOWN: Indicates that VMware guest tools is unknown.","example":"GUEST_TOOLS_RUNNING","enum":["GUEST_TOOLS_RUNNING","GUEST_TOOLS_STOPPED","GUEST_TOOLS_STOP_PENDING","GUEST_TOOLS_START_PENDING","GUEST_TOOLS_PAUSE_PENDING","GUEST_TOOLS_PAUSED","GUEST_TOOLS_CONTINUING","GUEST_TOOLS_UNKNOWN"]},"tools_version":{"type":"string","description":"VMware Tools version.","example":"11.2.5","deprecated":true}},"description":"Monitoring information related to VMware Tools."},"ViewClientInfo":{"type":"object","properties":{"broker_dns_name":{"type":"string","description":"The DNS name of the connected connection server.","example":"vm1.test.local"},"display_topology_list":{"type":"array","description":"The Display Topology.","items":{"$ref":"#/components/schemas/DisplayTopology"}},"domain_name":{"type":"string","description":"The domain name of the endpoint machine.","example":"test"},"ip_address":{"type":"string","description":"The local IP address detected by View client.","example":"196.168.1.1"},"logged_on_domain_name":{"type":"string","description":"The domain name of the user logged on the endpoint machine.","example":"test"},"logged_on_user_name":{"type":"string","description":" The user name of the user logged on the endpoint machine.","example":"User1"},"mac_address":{"type":"string","description":"The MAC address of the endpoint machine.","example":"00-50-56-88-13-09"},"machine_name":{"type":"string","description":"The machine name of the endpoint machine.","example":"vm1"},"remote_ip_address":{"type":"string","description":"The uplink IP address of View client. It might be a public IP after NAT.","example":"196.168.1.1"},"type":{"type":"string","description":"The type of the client installed on endpoint machine.","example":"Windows"},"version":{"type":"string","description":"The version of horizon client.","example":"8.13.0"}},"description":"Information about display protocol performance."},"ViewComposerMonitorConnectionServer":{"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/CertificateMonitorInfo"},"id":{"type":"string","description":"Unique ID of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the View Composer with respect to this Connection Server.\n* OK: The connection to View Composer server is working properly.\n* MALFORMED_URL: The connection to View Composer server was not possible due to a malformed URL.\n* ERROR: Error occurred when connecting to View Composer server.\n* CERT_ERROR: Certificate validation error when connecting to the View Composer server.","example":"OK","enum":["OK","MALFORMED_URL","ERROR","CERT_ERROR"]},"thumbprint_accepted":{"type":"boolean","description":"Indicates if the thumbprint of the View Composer was accepted.","example":false}},"description":"Information about the View Composer connection from connection server."},"ViewComposerMonitorConnectionServerV2":{"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/CertificateMonitorInfo"},"id":{"type":"string","description":"Unique ID of the Connection Server.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"last_updated_timestamp":{"type":"integer","description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time.","format":"int64","example":1582029025748},"name":{"type":"string","description":"Connection server host name or IP address.","example":"cs1.example.com"},"status":{"type":"string","description":"Status of the View Composer with respect to this Connection Server.\n* OK: The connection to View Composer server is working properly.\n* MALFORMED_URL: The connection to View Composer server was not possible due to a malformed URL.\n* ERROR: Error occurred when connecting to View Composer server.\n* CERT_ERROR: Certificate validation error when connecting to the View Composer server.","example":"OK","enum":["OK","MALFORMED_URL","ERROR","CERT_ERROR"]},"thumbprint_accepted":{"type":"boolean","description":"Indicates if the thumbprint of the View Composer was accepted.","example":false}},"description":"Information about the View Composer connection from connection server."},"ViewComposerMonitorDetails":{"type":"object","properties":{"api_verion":{"type":"string","description":"The version of the View Composer API used to communicate with the View Composer server.","example":"3.5"},"build":{"type":"string","description":"The build of the View Composer server.","example":"1234567"},"min_esx_version":{"type":"string","description":"The minimum ESX version required for compatibility with this View Composer server.","example":"5.5"},"min_vc_version":{"type":"string","description":"The minimum Virtual Center version required for compatibility with this View Composer server.","example":"5.5"},"referenced_vcs":{"type":"array","description":"The Virtual Center servers referencing to this View Composer.","items":{"type":"string","description":"The Virtual Center servers referencing to this View Composer."}},"version":{"type":"string","description":"The version of the View Composer server.","example":"7.9.0.12345"}},"description":"Details of the View Composer."},"ViewComposerMonitorInfo":{"required":["name"],"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the View Composer connections from each of the connection servers.","items":{"$ref":"#/components/schemas/ViewComposerMonitorConnectionServer"}},"details":{"$ref":"#/components/schemas/ViewComposerMonitorDetails"},"name":{"type":"string","description":"View Composer server host name or IP address.","example":"composer1.example.com"},"port":{"maximum":65535,"minimum":0,"type":"integer","description":"View Composer server port number.","format":"int32","example":18443}},"description":"Monitoring information related to View Composer."},"ViewComposerMonitorInfoV2":{"required":["name"],"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the View Composer connections from each of the connection servers.","items":{"$ref":"#/components/schemas/ViewComposerMonitorConnectionServerV2"}},"details":{"$ref":"#/components/schemas/ViewComposerMonitorDetails"},"name":{"type":"string","description":"View Composer server host name or IP address.","example":"composer1.example.com"},"port":{"maximum":65535,"minimum":0,"type":"integer","description":"View Composer server port number.","format":"int32","example":18443}},"description":"Monitoring information related to View Composer."},"ViewStorageAcceleratorBlackoutTimeSettings":{"type":"object","properties":{"days":{"type":"array","description":"List of days for a given range of time.","example":["MONDAY","TUESDAY"],"items":{"type":"string","description":"* ALL: All seven days of the week.","example":"[\"MONDAY\",\"TUESDAY\"]","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY","ALL"]}},"end_time":{"type":"string","description":"Ending time for the blackout in 24-hour format.","example":"22:00"},"start_time":{"type":"string","description":"Starting time for the blackout in 24-hour format.","example":"10:00"}},"description":"Fields for specifying blackout time for View Storage Accelerator. Storage accelerator regeneration and VM disk space reclamation do not occur during blackout times. The same blackout policy applies to both operations."},"ViewStorageAcceleratorBlackoutTimeSettingsCreateSpec":{"required":["days","end_time","start_time"],"type":"object","properties":{"days":{"type":"array","description":"List of days for a given range of time.","example":["MONDAY","TUESDAY"],"items":{"type":"string","description":"* ALL: All seven days of the week.","example":"[\"MONDAY\",\"TUESDAY\"]","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY","ALL"]}},"end_time":{"type":"string","description":"Ending time for the blackout in 24-hour format.","example":"22:00"},"start_time":{"type":"string","description":"Starting time for the blackout in 24-hour format.","example":"10:00"}},"description":"Fields for specifying blackout time for View Storage Accelerator. Storage accelerator regeneration and VM disk space reclamation do not occur during blackout times. The same blackout policy applies to both operations."},"ViewStorageAcceleratorBlackoutTimeSettingsUpdateSpec":{"required":["days","end_time","start_time"],"type":"object","properties":{"days":{"type":"array","description":"List of days for a given range of time.","example":["MONDAY","TUESDAY"],"items":{"type":"string","description":"* ALL: All seven days of the week.","example":"[\"MONDAY\",\"TUESDAY\"]","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY","ALL"]}},"end_time":{"type":"string","description":"Ending time for the blackout in 24-hour format.","example":"22:00"},"start_time":{"type":"string","description":"Starting time for the blackout in 24-hour format.","example":"10:00"}},"description":"Fields for specifying blackout time for View Storage Accelerator. Storage accelerator regeneration and VM disk space reclamation do not occur during blackout times. The same blackout policy applies to both operations."},"VirtualCenterCreateSpecV3":{"required":["password","port","server_name","user_name"],"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/CertificateOverrideDataCreateSpec"},"deployment_type":{"type":"string","description":"Indicates different environments that Horizon can be deployed into.\n* GENERAL: Horizon is deployed on On-premises.\n* AZURE: Horizon is deployed on Azure.\n* AWS: Horizon is deployed on AWS.\n* DELL_EMC: Horizon is deployed on Dell EMC.\n* GOOGLE: Horizon is deployed on Google Cloud.\n* ORACLE: Horizon is deployed on Oracle Cloud.","example":"GENERAL","enum":["GENERAL","AZURE","AWS","DELL_EMC","GOOGLE","ORACLE"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Human readable description of the Virtual Center instance.","example":"Virtual Center Server"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Human readable display name of the virtual center instance.","example":"vc1.example.com"},"limits":{"$ref":"#/components/schemas/VCLimitsCreateSpec"},"password":{"type":"array","description":"Password to use for the connection","example":"<password>","items":{"type":"string","description":"Password to use for the connection","example":"<password>"}},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port of the virtual center to connect to.","format":"int32","example":443},"se_sparse_reclamation_enabled":{"type":"boolean","description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.","example":true},"server_name":{"type":"string","description":"Virtual Center’s server name or IP address","example":"vc1.example.com"},"storage_accelerator_data":{"$ref":"#/components/schemas/StorageAcceleratorDataCreateSpec"},"user_name":{"type":"string","description":"User name to use for the connection.","example":"administrator@vsphere.local"}},"description":"Virtual Center object to be created."},"VirtualCenterCreateSpecV4":{"required":["password","port","server_name","user_name"],"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/CertificateOverrideDataCreateSpec"},"deployment_type":{"type":"string","description":"Indicates different environments that Horizon can be deployed into.\n* GENERAL: Horizon is deployed on On-premises.\n* AZURE: Horizon is deployed on Azure.\n* AWS: Horizon is deployed on AWS.\n* DELL_EMC: Horizon is deployed on Dell EMC.\n* GOOGLE: Horizon is deployed on Google Cloud.\n* ORACLE: Horizon is deployed on Oracle Cloud.","example":"GENERAL","enum":["GENERAL","AZURE","AWS","DELL_EMC","GOOGLE","ORACLE"]},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Human readable description of the Virtual Center instance.","example":"Virtual Center Server"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Human readable display name of the virtual center instance.","example":"vc1.example.com"},"instant_clone_debug_enabled":{"type":"boolean","description":"Indicates if instant clone debug mode is enabled","example":false},"limits":{"$ref":"#/components/schemas/VCLimitsCreateSpec"},"password":{"type":"array","description":"Password to use for the connection","example":"<password>","items":{"type":"string","description":"Password to use for the connection","example":"<password>"}},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port of the virtual center to connect to.","format":"int32","example":443},"se_sparse_reclamation_enabled":{"type":"boolean","description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.","example":true},"server_name":{"type":"string","description":"Virtual Center’s server name or IP address","example":"vc1.example.com"},"storage_accelerator_data":{"$ref":"#/components/schemas/StorageAcceleratorDataCreateSpec"},"user_name":{"type":"string","description":"User name to use for the connection.","example":"administrator@vsphere.local"}},"description":"Virtual Center object to be created."},"VirtualCenterInfo":{"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/CertificateOverrideData"},"description":{"type":"string","description":"Human readable description of the Virtual Center instance.","example":"Virtual Center Server"},"display_name":{"type":"string","description":"Human readable name of the Virtual Center instance.","example":"vc1.example.com"},"enabled":{"type":"boolean","description":"Indicates if the virtual center is enabled.","example":true},"id":{"type":"string","description":"Unique ID of the Virtual Center.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"instance_uuid":{"type":"string","description":"Virtual center's instanceUuid.","example":"6605d116-d1b5-4810-8e3a-b710b30993da"},"limits":{"$ref":"#/components/schemas/VCLimits"},"port":{"type":"integer","description":"Port of the virtual center to connect to.","format":"int32","example":443},"se_sparse_reclamation_enabled":{"type":"boolean","description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.","example":true},"server_name":{"type":"string","description":"Virtual Center's server name or IP address.","example":"vc1.example.com"},"storage_accelerator_data":{"$ref":"#/components/schemas/StorageAcceleratorData"},"use_ssl":{"type":"boolean","description":"Indicates if SSL should be used when connecting to the server.","example":true},"user_name":{"type":"string","description":"User name to use for the connection.","example":"administrator@vsphere.local"},"version":{"type":"string","description":"Version of the Virtual Center.","example":"6.5.0"},"vmc_deployment":{"type":"boolean","description":"Indicates if virtual center is deployed in VMC.","example":false}},"description":"Information related to Virtual Center."},"VirtualCenterInfoV2":{"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/CertificateOverrideData"},"deployment_type":{"type":"string","description":"Indicates different environments that Horizon can be deployed into.\n* GENERAL: Horizon is deployed on On-premises.\n* AZURE: Horizon is deployed on Azure.\n* AWS: Horizon is deployed on AWS.\n* DELL_EMC: Horizon is deployed on Dell EMC.\n* GOOGLE: Horizon is deployed on Google Cloud.\n* ORACLE: Horizon is deployed on Oracle Cloud.","enum":["GENERAL","AZURE","AWS","DELL_EMC","GOOGLE","ORACLE"]},"description":{"type":"string","description":"Human readable description of the Virtual Center instance.","example":"Virtual Center Server"},"display_name":{"type":"string","description":"Human readable name of the Virtual Center instance.","example":"vc1.example.com"},"enabled":{"type":"boolean","description":"Indicates if the virtual center is enabled.","example":true},"has_virtual_tpm_pools":{"type":"boolean","description":"Indicates if there is any instant clone Desktop pool associated with this Virtual Center which has addVirtualTPM set"},"id":{"type":"string","description":"Unique ID of the Virtual Center.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"instance_uuid":{"type":"string","description":"Virtual center's instanceUuid.","example":"6605d116-d1b5-4810-8e3a-b710b30993da"},"limits":{"$ref":"#/components/schemas/VCLimits"},"maintenance_mode":{"type":"boolean","description":"Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts"},"port":{"type":"integer","description":"Port of the virtual center to connect to.","format":"int32","example":443},"se_sparse_reclamation_enabled":{"type":"boolean","description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.","example":true},"server_name":{"type":"string","description":"Virtual Center's server name or IP address.","example":"vc1.example.com"},"storage_accelerator_data":{"$ref":"#/components/schemas/StorageAcceleratorData"},"use_ssl":{"type":"boolean","description":"Indicates if SSL should be used when connecting to the server.","example":true},"user_name":{"type":"string","description":"User name to use for the connection.","example":"administrator@vsphere.local"},"version":{"type":"string","description":"Version of the Virtual Center.","example":"6.5.0"},"virtualTPMPools":{"type":"boolean","writeOnly":true}},"description":"Information related to Virtual Center."},"VirtualCenterInfoV3":{"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/CertificateOverrideData"},"deployment_type":{"type":"string","description":"Indicates different environments that Horizon can be deployed into.\n* GENERAL: Horizon is deployed on On-premises.\n* AZURE: Horizon is deployed on Azure.\n* AWS: Horizon is deployed on AWS.\n* DELL_EMC: Horizon is deployed on Dell EMC.\n* GOOGLE: Horizon is deployed on Google Cloud.\n* ORACLE: Horizon is deployed on Oracle Cloud.","enum":["GENERAL","AZURE","AWS","DELL_EMC","GOOGLE","ORACLE"]},"description":{"type":"string","description":"Human readable description of the Virtual Center instance.","example":"Virtual Center Server"},"display_name":{"type":"string","description":"Human readable name of the Virtual Center instance.","example":"vc1.example.com"},"enabled":{"type":"boolean","description":"Indicates if the virtual center is enabled.","example":true},"has_virtual_tpm_pools":{"type":"boolean","description":"Indicates if there is any instant clone Desktop pool associated with this Virtual Center which has addVirtualTPM set"},"id":{"type":"string","description":"Unique ID of the Virtual Center.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"instance_uuid":{"type":"string","description":"Virtual center's instanceUuid.","example":"6605d116-d1b5-4810-8e3a-b710b30993da"},"limits":{"$ref":"#/components/schemas/VCLimitsV2"},"maintenance_mode":{"type":"boolean","description":"Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts"},"port":{"type":"integer","description":"Port of the virtual center to connect to.","format":"int32","example":443},"se_sparse_reclamation_enabled":{"type":"boolean","description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.","example":true},"server_name":{"type":"string","description":"Virtual Center's server name or IP address.","example":"vc1.example.com"},"storage_accelerator_data":{"$ref":"#/components/schemas/StorageAcceleratorData"},"use_ssl":{"type":"boolean","description":"Indicates if SSL should be used when connecting to the server.","example":true},"user_name":{"type":"string","description":"User name to use for the connection.","example":"administrator@vsphere.local"},"version":{"type":"string","description":"Version of the Virtual Center.","example":"6.5.0"},"virtualTPMPools":{"type":"boolean","writeOnly":true}},"description":"Information related to Virtual Center."},"VirtualCenterInfoV4":{"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/CertificateOverrideData"},"deployment_type":{"type":"string","description":"Indicates different environments that Horizon can be deployed into.\n* GENERAL: Horizon is deployed on On-premises.\n* AZURE: Horizon is deployed on Azure.\n* AWS: Horizon is deployed on AWS.\n* DELL_EMC: Horizon is deployed on Dell EMC.\n* GOOGLE: Horizon is deployed on Google Cloud.\n* ORACLE: Horizon is deployed on Oracle Cloud.","enum":["GENERAL","AZURE","AWS","DELL_EMC","GOOGLE","ORACLE"]},"description":{"type":"string","description":"Human readable description of the Virtual Center instance.","example":"Virtual Center Server"},"display_name":{"type":"string","description":"Human readable name of the Virtual Center instance.","example":"vc1.example.com"},"enabled":{"type":"boolean","description":"Indicates if the virtual center is enabled.","example":true},"has_virtual_tpm_pools":{"type":"boolean","description":"Indicates if there is any instant clone Desktop pool associated with this Virtual Center which has addVirtualTPM set"},"id":{"type":"string","description":"Unique ID of the Virtual Center.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"instance_uuid":{"type":"string","description":"Virtual center's instanceUuid.","example":"6605d116-d1b5-4810-8e3a-b710b30993da"},"instant_clone_debug_enabled":{"type":"boolean","description":"Indicates if instant clone debug mode is enabled","example":false},"limits":{"$ref":"#/components/schemas/VCLimitsV2"},"maintenance_mode":{"type":"boolean","description":"Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts"},"port":{"type":"integer","description":"Port of the virtual center to connect to.","format":"int32","example":443},"se_sparse_reclamation_enabled":{"type":"boolean","description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.","example":true},"server_name":{"type":"string","description":"Virtual Center's server name or IP address.","example":"vc1.example.com"},"storage_accelerator_data":{"$ref":"#/components/schemas/StorageAcceleratorData"},"use_ssl":{"type":"boolean","description":"Indicates if SSL should be used when connecting to the server.","example":true},"user_name":{"type":"string","description":"User name to use for the connection.","example":"administrator@vsphere.local"},"version":{"type":"string","description":"Version of the Virtual Center.","example":"6.5.0"},"virtualTPMPools":{"type":"boolean","writeOnly":true}},"description":"Information related to Virtual Center."},"VirtualCenterInfoV5":{"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/CertificateOverrideData"},"deployment_type":{"type":"string","description":"Indicates different environments that Horizon can be deployed into.\n* GENERAL: Horizon is deployed on On-premises.\n* AZURE: Horizon is deployed on Azure.\n* AWS: Horizon is deployed on AWS.\n* DELL_EMC: Horizon is deployed on Dell EMC.\n* GOOGLE: Horizon is deployed on Google Cloud.\n* ORACLE: Horizon is deployed on Oracle Cloud.","enum":["GENERAL","AZURE","AWS","DELL_EMC","GOOGLE","ORACLE"]},"description":{"type":"string","description":"Human readable description of the Virtual Center instance.","example":"Virtual Center Server"},"display_name":{"type":"string","description":"Human readable name of the Virtual Center instance.","example":"vc1.example.com"},"enabled":{"type":"boolean","description":"Indicates if the virtual center is enabled.","example":true},"has_virtual_tpm_pools":{"type":"boolean","description":"Indicates if there is any instant clone Desktop pool associated with this Virtual Center which has addVirtualTPM set"},"id":{"type":"string","description":"Unique ID of the Virtual Center.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"instance_uuid":{"type":"string","description":"Virtual center's instanceUuid.","example":"6605d116-d1b5-4810-8e3a-b710b30993da"},"instant_clone_debug_enabled":{"type":"boolean","description":"Indicates if instant clone debug mode is enabled","example":false},"limits":{"$ref":"#/components/schemas/VCLimitsV2"},"maintenance_mode":{"type":"boolean","description":"Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts"},"port":{"type":"integer","description":"Port of the virtual center to connect to.","format":"int32","example":443},"se_sparse_reclamation_enabled":{"type":"boolean","description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.","example":true},"server_name":{"type":"string","description":"Virtual Center's server name or IP address.","example":"vc1.example.com"},"storage_accelerator_data":{"$ref":"#/components/schemas/StorageAcceleratorData"},"use_ssl":{"type":"boolean","description":"Indicates if SSL should be used when connecting to the server.","example":true},"user_name":{"type":"string","description":"User name to use for the connection.","example":"administrator@vsphere.local"},"version":{"type":"string","description":"Version of the Virtual Center.","example":"6.5.0"},"virtualTPMPools":{"type":"boolean","writeOnly":true},"vsan_validation_status":{"type":"string","description":"Indicates if instant clone debug mode is enabled\n* OK: vSAN is compatible with the virtual center.\n* UNSUPPORTED_VC: vSAN is not supported on the virtual center.\n* UNSUPPORTED_HOST_OR_CLUSTER: vSAN is not supported on the host or cluster.\n* NOT_CONFIGURED: vSAN is not configured on the virtual center.","example":"false","enum":["OK","UNSUPPORTED_VC","UNSUPPORTED_HOST_OR_CLUSTER","NOT_CONFIGURED"]}},"description":"Information related to Virtual Center."},"VirtualCenterInfoV6":{"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/CertificateOverrideData"},"created_at":{"type":"integer","description":"Epoch time in milli seconds, when the Virtual-Center was created.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"deployment_type":{"type":"string","description":"Indicates different environments that Horizon can be deployed into.\n* GENERAL: Horizon is deployed on On-premises.\n* AZURE: Horizon is deployed on Azure.\n* AWS: Horizon is deployed on AWS.\n* DELL_EMC: Horizon is deployed on Dell EMC.\n* GOOGLE: Horizon is deployed on Google Cloud.\n* ORACLE: Horizon is deployed on Oracle Cloud.","enum":["GENERAL","AZURE","AWS","DELL_EMC","GOOGLE","ORACLE"]},"description":{"type":"string","description":"Human readable description of the Virtual Center instance.","example":"Virtual Center Server"},"display_name":{"type":"string","description":"Human readable name of the Virtual Center instance.","example":"vc1.example.com"},"enabled":{"type":"boolean","description":"Indicates if the virtual center is enabled.","example":true},"has_virtual_tpm_pools":{"type":"boolean","description":"Indicates if there is any instant clone Desktop pool associated with this Virtual Center which has addVirtualTPM set"},"id":{"type":"string","description":"Unique ID of the Virtual Center.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"instance_uuid":{"type":"string","description":"Virtual center's instanceUuid.","example":"6605d116-d1b5-4810-8e3a-b710b30993da"},"instant_clone_debug_enabled":{"type":"boolean","description":"Indicates if instant clone debug mode is enabled","example":false},"limits":{"$ref":"#/components/schemas/VCLimitsV2"},"maintenance_mode":{"type":"boolean","description":"Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts"},"port":{"type":"integer","description":"Port of the virtual center to connect to.","format":"int32","example":443},"se_sparse_reclamation_enabled":{"type":"boolean","description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.","example":true},"server_name":{"type":"string","description":"Virtual Center's server name or IP address.","example":"vc1.example.com"},"storage_accelerator_data":{"$ref":"#/components/schemas/StorageAcceleratorData"},"updated_at":{"type":"integer","description":"Epoch time in milli seconds, when the Virtual-Center was updated.\nSupported Filters : 'Between', 'Equals'.","format":"int64","example":1582181947320},"use_ssl":{"type":"boolean","description":"Indicates if SSL should be used when connecting to the server.","example":true},"user_name":{"type":"string","description":"User name to use for the connection.","example":"administrator@vsphere.local"},"version":{"type":"string","description":"Version of the Virtual Center.","example":"6.5.0"},"virtualTPMPools":{"type":"boolean","writeOnly":true},"vsan_validation_status":{"type":"string","description":"Indicates if instant clone debug mode is enabled\n* OK: vSAN is compatible with the virtual center.\n* UNSUPPORTED_VC: vSAN is not supported on the virtual center.\n* UNSUPPORTED_HOST_OR_CLUSTER: vSAN is not supported on the host or cluster.\n* NOT_CONFIGURED: vSAN is not configured on the virtual center.","example":"false","enum":["OK","UNSUPPORTED_VC","UNSUPPORTED_HOST_OR_CLUSTER","NOT_CONFIGURED"]}},"description":"Information related to Virtual Center."},"VirtualCenterMonitorInfo":{"required":["id","name"],"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the Virtual Center connections from each of the connection servers.","items":{"$ref":"#/components/schemas/VCMonitorConnectionServer"}},"datastores":{"type":"array","description":"Information about the datastores of the Virtual Center.","items":{"$ref":"#/components/schemas/VCMonitorDatastore"}},"desktops_count":{"type":"integer","description":"Number of Desktop Pools And Farms managed by the virtual center.","format":"int32"},"details":{"$ref":"#/components/schemas/VCMonitorDetails"},"hosts":{"type":"array","description":"Information about the ESX hosts added in the Virtual Center.","items":{"$ref":"#/components/schemas/VCMonitorHost"}},"id":{"type":"string","description":"Unique ID of the Virtual Center.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"name":{"type":"string","description":"Virtual Center server name or IP address.","example":"vc1.example.com"}},"description":"Monitoring information related to a Virtual Center"},"VirtualCenterMonitorInfoV2":{"required":["id","name"],"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the Virtual Center connections from each of the connection servers.","items":{"$ref":"#/components/schemas/VCMonitorConnectionServerV2"}},"datastores":{"type":"array","description":"Information about the datastores of the Virtual Center.","items":{"$ref":"#/components/schemas/VCMonitorDatastore"}},"desktop_pools_and_farms_count":{"type":"integer","description":"Number of Desktop Pools And Farms managed by the virtual center","format":"int32"},"details":{"$ref":"#/components/schemas/VCMonitorDetails"},"hosts":{"type":"array","description":"Information about the ESX hosts added in the Virtual Center.","items":{"$ref":"#/components/schemas/VCMonitorHost"}},"id":{"type":"string","description":"Unique ID of the Virtual Center.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"name":{"type":"string","description":"Virtual Center server name or IP address.","example":"vc1.example.com"}},"description":"Monitoring information related to a Virtual Center"},"VirtualCenterMonitorInfoV3":{"required":["id","name"],"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the Virtual Center connections from each of the connection servers.","items":{"$ref":"#/components/schemas/VCMonitorConnectionServerV2"}},"datastores":{"type":"array","description":"Information about the datastores of the Virtual Center.","items":{"$ref":"#/components/schemas/VCMonitorDatastore"}},"desktop_pools_and_farms_count":{"type":"integer","description":"Number of Desktop Pools And Farms managed by the virtual center","format":"int32"},"details":{"$ref":"#/components/schemas/VCMonitorDetails"},"hosts_v2":{"type":"array","description":"Information about the ESX hosts added in the Virtual Center.","items":{"$ref":"#/components/schemas/VCMonitorHostV2"}},"id":{"type":"string","description":"Unique ID of the Virtual Center.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"name":{"type":"string","description":"Virtual Center server name or IP address.","example":"vc1.example.com"}},"description":"Monitoring information related to a Virtual Center"},"VirtualCenterMonitorInfoV4":{"required":["id","name"],"type":"object","properties":{"connection_servers_v3":{"type":"array","description":"Information about the Virtual Center connections from each of the connection servers.","items":{"$ref":"#/components/schemas/VCMonitorConnectionServerV3"}},"datastores":{"type":"array","description":"Information about the datastores of the Virtual Center.","items":{"$ref":"#/components/schemas/VCMonitorDatastore"}},"desktop_pools_and_farms_count":{"type":"integer","description":"Number of Desktop Pools And Farms managed by the virtual center","format":"int32"},"details":{"$ref":"#/components/schemas/VCMonitorDetailsV2"},"hosts_v3":{"type":"array","description":"Information about the ESX hosts added in the Virtual Center.","items":{"$ref":"#/components/schemas/VCMonitorHostV3"}},"id":{"type":"string","description":"Unique ID of the Virtual Center.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"name":{"type":"string","description":"Virtual Center server name or IP address.","example":"vc1.example.com"}},"description":"Monitoring information related to a Virtual Center"},"VirtualCenterMonitorInfoV5":{"required":["id","name"],"type":"object","properties":{"connection_servers_v3":{"type":"array","description":"Information about the Virtual Center connections from each of the connection servers.","items":{"$ref":"#/components/schemas/VCMonitorConnectionServerV3"}},"datastores_v2":{"type":"array","description":"Information about the datastores of the Virtual Center.","items":{"$ref":"#/components/schemas/VCMonitorDatastoreV2"}},"desktop_pools_and_farms_count":{"type":"integer","description":"Number of Desktop Pools And Farms managed by the virtual center","format":"int32"},"details":{"$ref":"#/components/schemas/VCMonitorDetailsV2"},"hosts_v4":{"type":"array","description":"Information about the ESX hosts added in the Virtual Center.","items":{"$ref":"#/components/schemas/VCMonitorHostV4"}},"id":{"type":"string","description":"Unique ID of the Virtual Center.","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"},"name":{"type":"string","description":"Virtual Center server name or IP address.","example":"vc1.example.com"}},"description":"Monitoring information related to a Virtual Center"},"VirtualCenterUpdateSpecV3":{"required":["enabled","limits","port","server_name","storage_accelerator_data","user_name"],"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/CertificateOverrideDataUpdateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Human readable description of the Virtual Center instance.","example":"Virtual Center Server"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Human readable display name of the virtual center instance.","example":"vc1.example.com"},"enabled":{"type":"boolean","description":"Indicates if the virtual center is enabled.","example":true},"limits":{"$ref":"#/components/schemas/VCLimitsUpdateSpec"},"maintenance_mode":{"type":"boolean","description":"Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts","example":false},"password":{"type":"array","description":"Password to use for the connection","example":"<password>","items":{"type":"string","description":"Password to use for the connection","example":"<password>"}},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port of the virtual center to connect to.","format":"int32","example":443},"se_sparse_reclamation_enabled":{"type":"boolean","description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.","example":true},"server_name":{"type":"string","description":"Virtual Center’s server name or IP address","example":"vc1.example.com"},"storage_accelerator_data":{"$ref":"#/components/schemas/StorageAcceleratorDataUpdateSpec"},"user_name":{"type":"string","description":"User name to use for the connection.","example":"administrator@vsphere.local"}},"description":"Virtual Center object to be updated."},"VirtualCenterUpdateSpecV4":{"required":["enabled","limits","port","server_name","storage_accelerator_data","user_name"],"type":"object","properties":{"certificate_override":{"$ref":"#/components/schemas/CertificateOverrideDataUpdateSpec"},"description":{"maxLength":1024,"minLength":0,"type":"string","description":"Human readable description of the Virtual Center instance.","example":"Virtual Center Server"},"display_name":{"maxLength":256,"minLength":0,"type":"string","description":"Human readable display name of the virtual center instance.","example":"vc1.example.com"},"enabled":{"type":"boolean","description":"Indicates if the virtual center is enabled.","example":true},"instant_clone_debug_enabled":{"type":"boolean","description":"Indicates if instant clone debug mode is enabled","example":false},"limits":{"$ref":"#/components/schemas/VCLimitsUpdateSpec"},"maintenance_mode":{"type":"boolean","description":"Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts","example":false},"password":{"type":"array","description":"Password to use for the connection","example":"<password>","items":{"type":"string","description":"Password to use for the connection","example":"<password>"}},"port":{"maximum":65535,"minimum":1,"type":"integer","description":"Port of the virtual center to connect to.","format":"int32","example":443},"se_sparse_reclamation_enabled":{"type":"boolean","description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.","example":true},"server_name":{"type":"string","description":"Virtual Center’s server name or IP address","example":"vc1.example.com"},"storage_accelerator_data":{"$ref":"#/components/schemas/StorageAcceleratorDataUpdateSpec"},"user_name":{"type":"string","description":"User name to use for the connection.","example":"administrator@vsphere.local"}},"description":"Virtual Center object to be updated."},"VirtualDiskData":{"type":"object","properties":{"capacity_mb":{"type":"integer","description":"The disk capacity in MB.","format":"int64","example":102400},"datastore_path":{"type":"string","description":"The virtual disk's datastore.","example":"datastore1"},"path":{"type":"string","description":"The virtual disk path.","example":"/path/host"}},"description":"Information related to a virtual disk."},"VirtualDiskInfo":{"type":"object","properties":{"attached":{"type":"boolean","description":"Indicates the virtual disk is attached to a VM.","example":false},"datastore_id":{"type":"string","description":"Datastore id for this virtual disk.","example":"datastore-29"},"id":{"type":"string","description":"Unique ID representing the virtual disk.","example":"a219420d-4799-4517-8f78-39c74c7c4efc"},"incompatible_reason":{"type":"string","description":"Incompatible reasons for the virtual disk.\n* REPLICA_DISK: Replica Disks are not compatible to be used as Persistent disk.\n* INTERNAL_DISK: Internal disk are not compatible to be used as Persistent disk.\n* DISPOSABLE_DISK: Disposable disk are not compatible to be used as Persistent disk.\n* DISK_ALREADY_IN_USE: Disk already imported as persistent disk.\n* INSTANT_CLONE_INTERNAL_DISK: Instant clone internal disk is not compatible to be a Persistent disk.","enum":["REPLICA_DISK","INTERNAL_DISK","DISPOSABLE_DISK","DISK_ALREADY_IN_USE","INSTANT_CLONE_INTERNAL_DISK"]},"name":{"type":"string","description":"Name of the virtual disk.","example":"virtual-disk.vmdk"},"path":{"type":"string","description":"Full path of the virtual disk.","example":"[datastore] vm/virtual-disk.vmdk"}},"description":"Information related to virtual disk."},"VirtualMachineInfo":{"type":"object","properties":{"hardware_version":{"type":"integer","description":"Hardware version for this VM.","format":"int32"},"id":{"type":"string","description":"Unique ID representing a VM.Supported Filters : 'Equals'.","example":"vm-416"},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this Virtual Machine from having its snapshots used in linked or instant clone desktop or farm. Supported Filters : 'Equals', 'NotEquals', 'Contains', 'NotContains'.","items":{"type":"string","description":"* IN_USE_BY_LOCAL_DESKTOP_POOL: When this base VM is already a machine that belongs to a local manual or automatic desktop pool or farm.\n* IN_USE_BY_NON_LOCAL_DESKTOP_POOL: When this base VM is already a machine that belongs to a non-local manual or automatic desktop pool or farm.\n* VIEW_COMPOSER_REPLICA: When this VM is a View Composer replica.\n* VIEW_COMPOSER_BASE_IMAGE: When this VM is a View Composer base image.\n* UNSUPPORTED_OS: When this VM has an unsupported machine operating system. Certain desktop server operating systems are only supported when SettingsInfo.GeneralSettings.enableServerInSingleUserMode is true.\n* INCOMPATIBLE_GRID_VGPUS: When this VM has an unsupported GRID virtual GPU.\n* INSTANT_INTERNAL: When this VM is a Instant Clone Engine internal virtual machine.\n* INSTANT_CLONE_BASE_IMAGE: When this VM is an Instant Clone base image.","enum":["IN_USE_BY_LOCAL_DESKTOP_POOL","IN_USE_BY_NON_LOCAL_DESKTOP_POOL","VIEW_COMPOSER_REPLICA","VIEW_COMPOSER_BASE_IMAGE","UNSUPPORTED_OS","INCOMPATIBLE_GRID_VGPUS","INSTANT_INTERNAL","INSTANT_CLONE_BASE_IMAGE"]}},"name":{"type":"string","description":"VM name.Supported Filters : 'Equals', 'Contains', 'StartsWith'.\nThis property can be used for sorting.","example":"Win10"},"operating_system":{"type":"string","description":"Operating system.\n* LINUX_CENTOS: Linux (CentOS)\n* LINUX_OTHER: Linux (other)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* UNKNOWN: Unknown\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_XP: Windows XP\n* MACOS_15: macOS 15 (Applicable only for Limited Availability (LA) Mac Agent)\n* MACOS: macOS (Applicable only for Limited Availability (LA) Mac Agent)","example":"WINDOWS_10","enum":["LINUX_CENTOS","LINUX_OTHER","LINUX_RHEL","LINUX_SERVER_OTHER","LINUX_SUSE","LINUX_UBUNTU","UNKNOWN","WINDOWS_10","WINDOWS_11","WINDOWS_7","WINDOWS_8","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","WINDOWS_VISTA","WINDOWS_XP","MACOS_15","MACOS"]},"operating_system_display_name":{"type":"string","description":"Operating system display name from Virtual Center.Supported Filters : 'Equals', 'Contains', 'StartsWith'.\nThis property can be used for sorting.","example":"Microsoft Windows 10 (64-bit)"},"path":{"type":"string","description":"VM path.Supported Filters : 'Equals', 'Contains', 'StartsWith'.\nThis property can be used for sorting.","example":"/Datacenter/vm/VMs/Win10"},"v_gputype":{"type":"string","description":"Virtual GPU type. Supported Filters : 'Equals', 'NotEquals'.","example":"datacenter-1"}},"description":"Information related to a Virtual Machine."},"VsanDatastoreCostInfo":{"type":"object","properties":{"full_clone_factor":{"type":"integer","description":"Multiplicative factor for full clone disk that is needed to account for the extra copies that are created for VSAN.","format":"int32","example":1},"os_factor":{"type":"integer","description":"Multiplicative factor for OS disk that is needed to account for the extra copies that are created for VSAN.","format":"int32","example":1},"replica_factor":{"type":"integer","description":"Multiplicative factor for replica disk that is needed to account for the extra copies that are created for VSAN.","format":"int32","example":1},"user_data_factor":{"type":"integer","description":"Multiplicative factor for user data disk that is needed to account for the extra copies that are created for VSAN.","format":"int32","example":1}},"description":"Virtual SAN datastore cost Info."},"Ws1AssistInfo":{"type":"object","properties":{"agent_id":{"type":"string","description":"The agent id for workspace one assist.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"error_code":{"type":"integer","description":"The error code for failing to get agent id.","format":"int32","example":20021},"error_text":{"type":"string","description":"The error text for failing to get agent id.","example":"Bad session id."},"status_code":{"type":"integer","description":"The status code of workspace one assist.","format":"int32","example":20031},"status_message":{"type":"string","description":"The status message of workspace one assist.","example":"Successfully retrieved agent id."}}},"Ws1AssistSpec":{"required":["agent_id","assist_spec","session_id"],"type":"object","properties":{"agent_id":{"type":"string","description":"The agent ID of the machine.","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c"},"assist_spec":{"type":"string","description":"The base 64 encoded Workspace ONE Assist spec JWT.","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"},"pod_id":{"type":"string","description":"ID of the pod that hosted the session, Applicable for global sessions only.","example":"105717a7-eb8c-490e-90c4-8bfeb0e43d7e"},"session_id":{"type":"string","description":"ID of the session.","example":"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b"}},"description":"The specification object to retrieve the ws1 assist agent Id status."}},"securitySchemes":{"Bearer":{"bearerFormat":"JWT","name":"Bearer","scheme":"bearer","type":"http"}}}}