{"swagger":"2.0","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.
Choose Latest spec from dropdown to view API reference on latest version available.","version":"2212","title":"Horizon Server API","license":{"name":"Copyright © 1998 - 2023 VMware, Inc. All rights reserved."}},"host":"localhost","basePath":"/rest","tags":[{"name":"Auth","description":"APIs for Authentication and Authorization"},{"name":"Config","description":"APIs for configuration"},{"name":"Entitlements","description":"APIs for entitlement of resources"},{"name":"External","description":"APIs for resources that are external to Horizon environment. These APIs make live calls to the external systems"},{"name":"Federation","description":"APIs for federation resources. CPA must be initialized for the pod for invoking these APIs"},{"name":"Inventory","description":"APIs for inventory resources"},{"name":"Monitor","description":"APIs for monitoring services"}],"paths":{"/config/v1/admin-users-or-groups/permissions":{"get":{"tags":["Config"],"summary":"Gets permission information for logged in admin user or group.","operationId":"getAdminUsersOrGroupsPermissions","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdminUserOrGroupPermissionsInfo"}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/admin-users-or-groups/preferences":{"get":{"tags":["Config"],"summary":"Gets Horizon Console preferences for the logged in administrator.","operationId":"getPreferences","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdminUserOrGroupPreferencesInfo"}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the Horizon Console preferences for the logged in administrator.","operationId":"updatePreferences","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"updateSpec","description":"updateSpec","required":true,"schema":{"$ref":"#/definitions/AdminUserOrGroupPreferencesUpdateSpec"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/app-volumes-manager":{"get":{"tags":["Config"],"summary":"Lists the configured app volumes managers.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AppVolumesManagerInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Add the app volumes manager","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"App volumes manager object to be added.","required":true,"schema":{"$ref":"#/definitions/AppVolumesManagerCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/app-volumes-manager/action/unassign-farms":{"post":{"tags":["Config"],"summary":"Unassign Farms to App Volumes Manager","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":"unassignFarms","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"farmIds","description":"List of farm Ids to be unassigned with App Volumes manager","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/app-volumes-manager/{id}":{"get":{"tags":["Config"],"summary":"Retrieves information about an app volumes manager.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AppVolumesManagerInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the given app volumes manager.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"App volumes manager object to be updated.","required":true,"schema":{"$ref":"#/definitions/AppVolumesManagerUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"deletes the given app volumes manager","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/app-volumes-manager/{id}/action/assign-farms":{"post":{"tags":["Config"],"summary":"Assign Farms to App Volumes Manager","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":"assignFarms","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"farmIds","description":"List of farm Ids to be assigned with App Volumes manager","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"App volumes manager ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/app-volumes-manager/{id}/action/push-certificates":{"post":{"tags":["Config"],"summary":"Push cluster certificates to App Volumes Manager","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"App volumes manager ID","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/ceip":{"get":{"tags":["Config"],"summary":"Get the CEIP Information.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CEIPInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/connection-servers":{"get":{"tags":["Config"],"summary":"Lists the connection servers.","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. |","operationId":"listConnectionServers","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ConnectionServerInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/connection-servers/action/disable":{"post":{"tags":["Config"],"summary":"Disables the given list of connection server ids.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of connection server ids to be disabled.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/connection-servers/action/enable":{"post":{"tags":["Config"],"summary":"Enables the given list of connection server ids.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of connection server ids to be enabled.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/connection-servers/action/generate-csr":{"post":{"tags":["Config"],"summary":"Generate Certificate Signing Request(CSR).","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"CSR Spec.","required":true,"schema":{"$ref":"#/definitions/CsrSpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CsrGenerateResponseInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/connection-servers/action/import-certificate":{"post":{"tags":["Config"],"summary":"Import the SSL certificate to connection server's personal certificate store.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Certificate Spec.","required":true,"schema":{"$ref":"#/definitions/CertificateSpec"}}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/connection-servers/certificates":{"get":{"tags":["Config"],"summary":"Retrieves the certificate details.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/CertificateInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/connection-servers/security-configuration":{"get":{"tags":["Config"],"summary":"Retrieves the security configuration of connection server and secure gateway","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SecurityConfigInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/connection-servers/{id}":{"get":{"tags":["Config"],"summary":"Retrieves information about a connection server.","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. |","operationId":"getConnectionServer","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConnectionServerInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the settings of the given Connection Server.","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":"updateConnectionServer","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Connection Server object whose settings need to be updated.","required":true,"schema":{"$ref":"#/definitions/ConnectionServerUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/environment-properties":{"get":{"tags":["Config"],"summary":"Retrieves the environment settings.","operationId":"getEnvironment","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvironmentInfo"}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/event-database":{"get":{"tags":["Config"],"summary":"Returns information about event database configured.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventDatabaseInfo"}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates event database configuration.","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":"updateEventDatabase","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Event database configuration to be updated.","required":true,"schema":{"$ref":"#/definitions/EventDatabaseUpdateSpec"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/event-database/action/clear":{"post":{"tags":["Config"],"summary":"Deletes event database configuration.","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","consumes":["application/json"],"produces":["*/*"],"responses":{"204":{"description":"No Content"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/federation-access-groups":{"get":{"tags":["Config"],"summary":"Lists all federation access groups.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/FederationAccessGroupInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates federation access group.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Federation access group object to be created.","required":true,"schema":{"$ref":"#/definitions/FederationAccessGroupCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/federation-access-groups/{id}":{"get":{"tags":["Config"],"summary":"Retrieves a federation access group.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FederationAccessGroupInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes a federation access group.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/gateways":{"get":{"tags":["Config"],"summary":"Lists the registered gateways.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/GatewayInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/gateways/{id}":{"get":{"tags":["Config"],"summary":"Retrieves information about a registered gateway.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GatewayInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/gssapi-authenticators":{"get":{"tags":["Config"],"summary":"Lists the configured GSSAPI Authenticators.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/GSSAPIAuthenticatorInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates a GSSAPI authenticator.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"spec","description":"GSSAPI Authenticator specification","required":true,"schema":{"$ref":"#/definitions/GSSAPIAuthenticatorCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/gssapi-authenticators/{id}":{"get":{"tags":["Config"],"summary":"Retrieves information about a GSSAPI Authenticator.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GSSAPIAuthenticatorInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates a GSSAPI Authenticator.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"GSSAPIAuthenticator whose settings need to be updated.","required":true,"schema":{"$ref":"#/definitions/GSSAPIAuthenticatorUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes a GSSAPI Authenticator.","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","produces":["*/*"],"parameters":[{"name":"forced","in":"query","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","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/ic-domain-accounts":{"get":{"tags":["Config"],"summary":"Lists instant clone domain accounts of the environment.","description":"This API supports Pagination.
\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","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/InstantCloneDomainAccountInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates instant clone domain account.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Instant clone domain account object to be created.","required":true,"schema":{"$ref":"#/definitions/InstantCloneDomainAccountCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/ic-domain-accounts/{id}":{"get":{"tags":["Config"],"summary":"Gets instant clone domain account.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InstantCloneDomainAccountInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates instant clone domain account.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Instant clone domain account object to be updated.","required":true,"schema":{"$ref":"#/definitions/InstantCloneDomainAccountUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes instant clone domain account.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/im-assets":{"get":{"tags":["Config"],"summary":"Lists image management assets.","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","produces":["*/*"],"parameters":[{"name":"im_version_id","in":"query","description":"Image management version ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ImageManagementAssetInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates image management asset.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Image management asset object to be created.","required":true,"schema":{"$ref":"#/definitions/ImageManagementAssetCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/im-assets/action/bulk-create":{"post":{"tags":["Config"],"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.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Image management asset object to be created in bulk.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ImageManagementAssetCreateSpec"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/im-assets/{id}":{"get":{"tags":["Config"],"summary":"Gets image management asset.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ImageManagementAssetInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates image management asset.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Image management asset object to be updated.","required":true,"schema":{"$ref":"#/definitions/ImageManagementAssetUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes image management asset.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/im-streams":{"get":{"tags":["Config"],"summary":"Lists image management streams.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ImageManagementStreamInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates image management stream.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Image management stream object to be created.","required":true,"schema":{"$ref":"#/definitions/ImageManagementStreamCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/im-streams/action/bulk-create":{"post":{"tags":["Config"],"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.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Image management stream object to be created in bulk.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ImageManagementStreamCreateSpec"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/im-streams/{id}":{"get":{"tags":["Config"],"summary":"Gets image management stream.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ImageManagementStreamInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates image management stream.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Image management stream object to be updated.","required":true,"schema":{"$ref":"#/definitions/ImageManagementStreamUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes image management stream.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/im-tags":{"get":{"tags":["Config"],"summary":"Lists image management tags.","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","produces":["*/*"],"parameters":[{"name":"im_stream_id","in":"query","description":"Image management stream ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ImageManagementTagInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates image management tag.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Image management tag object to be created.","required":true,"schema":{"$ref":"#/definitions/ImageManagementTagCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/im-tags/action/bulk-create":{"post":{"tags":["Config"],"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.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Image management tag object to be created in bulk.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ImageManagementTagCreateSpec"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/im-tags/{id}":{"get":{"tags":["Config"],"summary":"Gets image management tag.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ImageManagementTagInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates image management tag.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Image management tag object to be updated.","required":true,"schema":{"$ref":"#/definitions/ImageManagementTagUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes image management tag.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/im-versions":{"get":{"tags":["Config"],"summary":"Lists image management versions.","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","produces":["*/*"],"parameters":[{"name":"im_stream_id","in":"query","description":"Image management stream ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ImageManagementVersionInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates image management version.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Image management version object to be created.","required":true,"schema":{"$ref":"#/definitions/ImageManagementVersionCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/im-versions/action/bulk-create":{"post":{"tags":["Config"],"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.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Image management version object to be created in bulk.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ImageManagementVersionCreateSpec"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/im-versions/{id}":{"get":{"tags":["Config"],"summary":"Gets image management version.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ImageManagementVersionInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates image management version.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Image management version object to be updated.","required":true,"schema":{"$ref":"#/definitions/ImageManagementVersionUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes image management version.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/jwt-authenticators":{"get":{"tags":["Config"],"summary":"Lists the configured JWT authenticators.","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":"listJWTAuthenticators","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/JWTAuthenticatorInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates a JWT authenticator.","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":"createJWTAuthenticator","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"JWT authenticator object to be created.","required":true,"schema":{"$ref":"#/definitions/JWTAuthenticatorCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/jwt-authenticators/{id}":{"get":{"tags":["Config"],"summary":"Retrieves information about the given JWT authenticator.","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":"getJWTAuthenticator","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/JWTAuthenticatorInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the given JWT authenticator.","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":"updateJWTAuthenticator","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"JWT authenticator object to be updated.","required":true,"schema":{"$ref":"#/definitions/JWTAuthenticatorUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes the given JWT authenticator.","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":"deleteJWTAuthenticator","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/licenses":{"get":{"tags":["Config"],"summary":"Lists all licenses.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/LicenseInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/licenses/action/set-mode":{"post":{"tags":["Config"],"summary":"Set the License Mode","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"The specification to set the license mode.","required":true,"schema":{"$ref":"#/definitions/LicenseModeSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/local-access-groups":{"get":{"tags":["Config"],"summary":"Lists all local access groups.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/LocalAccessGroupInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates local access group.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Local access group object to be created.","required":true,"schema":{"$ref":"#/definitions/LocalAccessGroupCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/local-access-groups/{id}":{"get":{"tags":["Config"],"summary":"Retrieves a local access group.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LocalAccessGroupInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes a local access group.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/permissions":{"get":{"tags":["Config"],"summary":"Lists all permissions.","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","produces":["*/*"],"parameters":[{"name":"ids","in":"query","description":"Permission IDs","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PermissionInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates permissions in bulk.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Permission objects to be created.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/PermissionCreateSpec"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes permissions in bulk.","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","produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Permission ids to be deleted.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/permissions/{id}":{"get":{"tags":["Config"],"summary":"Retrieves a permission.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PermissionInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/pre-logon-settings":{"get":{"tags":["Config"],"summary":"Gets the pre logon settings.","operationId":"getPreLogonSettings","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PreLogonSettingsInfo"}}},"deprecated":false}},"/config/v1/privileges":{"get":{"tags":["Config"],"summary":"Lists all selectable privileges.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PrivilegeInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/radius-authenticators":{"get":{"tags":["Config"],"summary":"Lists the configured RADIUS Authenticators.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/RADIUSAuthenticatorInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates a RADIUS Authenticator.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"RADIUS authenticator object to be created.","required":true,"schema":{"$ref":"#/definitions/RADIUSAuthenticatorCreateSpec"}}],"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/radius-authenticators/{id}":{"get":{"tags":["Config"],"summary":"Retrieves information about a RADIUS Authenticator.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RADIUSAuthenticatorInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the given RADIUS Authenticator.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"RADIUS authenticator object to be updated.","required":true,"schema":{"$ref":"#/definitions/RADIUSAuthenticatorUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes the given RADIUS Authenticator.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/rcx/clients":{"post":{"tags":["Config"],"summary":"Registers the RCX client","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"RCX client object to be registered.","required":true,"schema":{"$ref":"#/definitions/RCXClientRegisterSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/rcx/clients/{id}":{"put":{"tags":["Config"],"summary":"Updates the given RCX client.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"RCX client object to be updated.","required":true,"schema":{"$ref":"#/definitions/RCXClientUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Unregisters the given RCX Client","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/rcx/servers":{"get":{"tags":["Config"],"summary":"Lists RCX servers of the cluster.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/RCXServerInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/roles":{"get":{"tags":["Config"],"summary":"Lists all roles.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/RoleInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates a role.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Role object to be created.","required":true,"schema":{"$ref":"#/definitions/RoleCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/roles/{id}":{"get":{"tags":["Config"],"summary":"Retrieves a role.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RoleInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates a role.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Role object to be updated.","required":true,"schema":{"$ref":"#/definitions/RoleUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes a role.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/saml-authenticators":{"get":{"tags":["Config"],"summary":"Lists the configured SAML authenticators.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SAMLAuthenticatorInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates a SAML authenticator.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"spec","description":"SAML Authenticator specification","required":true,"schema":{"$ref":"#/definitions/SAMLAuthenticatorCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/saml-authenticators/action/validate-certificate":{"post":{"tags":["Config"],"summary":"Validates SAML Authenticator certificate.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"SAML Authenticator Server Spec.","required":true,"schema":{"$ref":"#/definitions/SAMLAuthenticatorServerSpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CertificateData"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/saml-authenticators/{id}":{"get":{"tags":["Config"],"summary":"Retrieves information about a SAML authenticator.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SAMLAuthenticatorInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates a SAML Authenticator.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"SAML Authenticator object to be updated.","required":true,"schema":{"$ref":"#/definitions/SAMLAuthenticatorUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes a SAML Authenticator.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/settings":{"get":{"tags":["Config"],"summary":"Retrieves the configuration settings.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SettingsInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the configuration settings.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Configuration settings object to be updated.","required":true,"schema":{"$ref":"#/definitions/SettingsUpdateSpec"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/settings/feature":{"get":{"tags":["Config"],"summary":"Retrieves the feature settings.","operationId":"getFeatureSettings","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FeatureSettings"}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the feature settings.","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":"updateFeatureSettings","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Feature settings object to be updated.","required":true,"schema":{"$ref":"#/definitions/FeatureSettingsUpdateSpec"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/settings/general":{"get":{"tags":["Config"],"summary":"Retrieves the general settings.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GeneralSettings"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the general settings.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"General settings object to be updated.","required":true,"schema":{"$ref":"#/definitions/GeneralSettingsUpdateSpec"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/settings/security":{"get":{"tags":["Config"],"summary":"Retrieves the security settings.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SecuritySettings"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the security settings.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Security settings object to be updated.","required":true,"schema":{"$ref":"#/definitions/SecuritySettingsUpdateSpec"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/true-sso-enrollment-servers":{"get":{"tags":["Config"],"summary":"Lists the paired TrueSSO Enrollment Servers.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TrueSSOEnrollmentServerInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/true-sso-enrollment-servers/{id}":{"get":{"tags":["Config"],"summary":"Retrieves information about a paired TrueSSO Enrollment Server.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TrueSSOEnrollmentServerInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/unauthenticated-access-users":{"get":{"tags":["Config"],"summary":"Lists unauthenticated access users in the environment.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/UnauthenticatedAccessUserInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates a specified unauthenticated access user in the environment.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"spec","description":"Unauthenticated access user specification","required":true,"schema":{"$ref":"#/definitions/UnauthenticatedAccessUserCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/unauthenticated-access-users/{id}":{"get":{"tags":["Config"],"summary":"Retrieves a specified unauthenticated access user in the environment.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"ID of the unauthenticated access user","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UnauthenticatedAccessUserInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes a specified unauthenticated access user in the environment.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"ID of the unauthenticated access user","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/users-or-groups-local-summary":{"get":{"tags":["Config"],"summary":"Lists local summary info of users or groups.","description":"Optional Privileges - \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":"listUsersOrGroupsLocalSummary","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/UserOrGroupLocalSummaryInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/virtual-centers":{"get":{"tags":["Config"],"summary":"Lists Virtual Centers configured in the environment.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VirtualCenterInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/virtual-centers/action/validate-certificate":{"post":{"tags":["Config"],"summary":"Validates Virtual Center certificate.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Server Spec.","required":true,"schema":{"$ref":"#/definitions/ServerSpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CertificateData"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/virtual-centers/{id}/action/mark-datastores-for-archival":{"post":{"tags":["Config"],"summary":"Sets archival datastore paths for the vCenter.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Set of datastore ids where archived vms will be saved","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"host_or_cluster_id","in":"query","description":"Host or Cluster ID","required":true,"type":"string","allowEmptyValue":false},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v2/connection-servers":{"get":{"tags":["Config"],"summary":"Lists the connection servers.","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. |","operationId":"listConnectionServersV2","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ConnectionServerInfoV2"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v2/connection-servers/{id}":{"get":{"tags":["Config"],"summary":"Retrieves information about a connection server.","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. |","operationId":"getConnectionServerV2","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConnectionServerInfoV2"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the settings of the given Connection Server.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Connection Server object whose settings need to be updated.","required":true,"schema":{"$ref":"#/definitions/ConnectionServerUpdateSpecV2"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v2/environment-properties":{"get":{"tags":["Config"],"summary":"Retrieves the environment settings.","operationId":"getEnvironmentV2","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EnvironmentInfoV2"}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v2/federation-access-groups":{"get":{"tags":["Config"],"summary":"Lists all federation access groups.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/FederationAccessGroupInfoV2"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v2/federation-access-groups/{id}":{"get":{"tags":["Config"],"summary":"Retrieves a federation access group.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FederationAccessGroupInfoV2"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v2/licenses":{"get":{"tags":["Config"],"summary":"Lists all licenses.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/LicenseInfoV2"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v2/local-access-groups":{"get":{"tags":["Config"],"summary":"Lists all local access groups.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/LocalAccessGroupInfoV2"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v2/local-access-groups/{id}":{"get":{"tags":["Config"],"summary":"Retrieves a local access group.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LocalAccessGroupInfoV2"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v2/settings":{"get":{"tags":["Config"],"summary":"Retrieves the configuration settings.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SettingsInfoV2"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the configuration settings.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Configuration settings object to be updated.","required":true,"schema":{"$ref":"#/definitions/SettingsUpdateSpecV2"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v2/settings/general":{"get":{"tags":["Config"],"summary":"Retrieves the general settings.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GeneralSettingsV2"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the general settings.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"General settings object to be updated.","required":true,"schema":{"$ref":"#/definitions/GeneralSettingsUpdateSpecV2"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v2/settings/security":{"get":{"tags":["Config"],"summary":"Retrieves the security settings.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SecuritySettingsV2"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v2/virtual-centers":{"get":{"tags":["Config"],"summary":"Lists Virtual Centers configured in the environment.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VirtualCenterInfoV2"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v3/settings":{"get":{"tags":["Config"],"summary":"Retrieves the configuration settings.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SettingsInfoV3"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the configuration settings.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Configuration settings object to be updated.","required":true,"schema":{"$ref":"#/definitions/SettingsUpdateSpecV3"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v3/settings/general":{"get":{"tags":["Config"],"summary":"Retrieves the general settings.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GeneralSettingsV3"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates the general settings.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"General settings object to be updated.","required":true,"schema":{"$ref":"#/definitions/GeneralSettingsUpdateSpecV3"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/entitlements/v1/application-pools":{"get":{"tags":["Entitlements"],"summary":"Lists the entitlements for Application Pools in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/EntitlementInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Entitlements"],"summary":"Create the bulk entitlements for a set of application pools","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specifications for bulk application entitlements to be created.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EntitlementSpec"}}}],"responses":{"200":{"description":"Created","schema":{"type":"array","items":{"$ref":"#/definitions/BulkEntitlementResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Entitlements"],"summary":"Delete the bulk entitlements for a set of application pools","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","produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specifications for bulk application entitlements to be deleted.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EntitlementSpec"}}}],"responses":{"200":{"description":"Created","schema":{"type":"array","items":{"$ref":"#/definitions/BulkEntitlementResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/entitlements/v1/application-pools/{id}":{"get":{"tags":["Entitlements"],"summary":"Returns the IDs of users or groups entitled to a given application pool.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EntitlementInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/entitlements/v1/desktop-pools":{"get":{"tags":["Entitlements"],"summary":"Lists the entitlements for Desktop Pools in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/EntitlementInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Entitlements"],"summary":"Create the bulk entitlements for a set of desktop pools","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specifications for bulk desktop entitlements to be created.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EntitlementSpec"}}}],"responses":{"200":{"description":"Created","schema":{"type":"array","items":{"$ref":"#/definitions/BulkEntitlementResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Entitlements"],"summary":"Delete the bulk entitlements for a set of desktop pools","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","produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specifications for bulk desktop entitlements to be deleted.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EntitlementSpec"}}}],"responses":{"200":{"description":"Created","schema":{"type":"array","items":{"$ref":"#/definitions/BulkEntitlementResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/entitlements/v1/desktop-pools/{id}":{"get":{"tags":["Entitlements"],"summary":"Returns the IDs of users or groups entitled to a given desktop pool.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EntitlementInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/entitlements/v1/global-application-entitlements":{"get":{"tags":["Entitlements"],"summary":"Lists the user or group entitlements for Global Application Entitlements in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.
Note that this API depends on internal cache. There may be a delay in new entities being reflected in the response.
This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/EntitlementInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Entitlements"],"summary":"Create the bulk entitlements for a set of Global Application Entitlements","description":"Note: CPA must be initialized for the pod for invoking this API.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specifications for bulk GAE Entitlements to be created.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EntitlementSpec"}}}],"responses":{"200":{"description":"Created","schema":{"type":"array","items":{"$ref":"#/definitions/BulkEntitlementResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Entitlements"],"summary":"Delete the bulk entitlements for a set of Global Application Entitlements","description":"Note: CPA must be initialized for the pod for invoking this API.
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","produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specifications for bulk GAE Entitlements to be Deleted.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EntitlementSpec"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkEntitlementResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/entitlements/v1/global-application-entitlements/{id}":{"get":{"tags":["Entitlements"],"summary":"Gets the user or group entitlements for a Global Application Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EntitlementInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/entitlements/v1/global-desktop-entitlements":{"get":{"tags":["Entitlements"],"summary":"Lists the user or group entitlements for Global Desktop Entitlements in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.
Note that this API depends on internal cache. There may be a delay in new entities being reflected in the response.
This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/EntitlementInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Entitlements"],"summary":"Create the bulk entitlements for a set of Global Desktop Entitlements","description":"Note: CPA must be initialized for the pod for invoking this API.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specifications for bulk GDE Entitlements to be created.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EntitlementSpec"}}}],"responses":{"200":{"description":"Created","schema":{"type":"array","items":{"$ref":"#/definitions/BulkEntitlementResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Entitlements"],"summary":"Delete the bulk entitlements for a set of Global Desktop Entitlements","description":"Note: CPA must be initialized for the pod for invoking this API.
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","produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specifications for bulk GDE Entitlements to be Deleted.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EntitlementSpec"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkEntitlementResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/entitlements/v1/global-desktop-entitlements/{id}":{"get":{"tags":["Entitlements"],"summary":"Gets the user or group entitlements for a Global Desktop Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EntitlementInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-domains":{"get":{"tags":["External"],"summary":"Lists information related to AD Domains of the environment.","operationId":"listADDomains","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ADDomainInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-domains/action/bind":{"post":{"tags":["External"],"summary":"Bind untrusted domain to the connection server.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specification of untrusted domain.","required":true,"schema":{"$ref":"#/definitions/ADDomainSpec"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ADDomainBindInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-domains/action/update-auxiliary-accounts":{"post":{"tags":["External"],"summary":"Update auxiliary accounts of the untrusted domain","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specification to update auxiliary accounts.","required":true,"schema":{"$ref":"#/definitions/ADDomainAuxiliaryAccountUpdateSpec"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-domains/{id}/action/add-auxiliary-accounts":{"post":{"tags":["External"],"summary":"Add auxiliary accounts to the untrusted domain","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specification of auxiliary accounts.","required":true,"schema":{"$ref":"#/definitions/ADDomainAuxiliaryAccountCreateSpec"}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-domains/{id}/action/delete-auxiliary-accounts":{"post":{"tags":["External"],"summary":"Specification to delete auxiliary accounts from the untrusted domain","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Auxiliary accounts to delete.","required":true,"schema":{"$ref":"#/definitions/ADDomainAuxiliaryAccountDeleteSpec"}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-domains/{id}/action/unbind":{"post":{"tags":["External"],"summary":"Unbind untrusted domain from the connection server.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-domains/{id}/action/update":{"post":{"tags":["External"],"summary":"Updates untrusted domain.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Untrusted domain object to be updated.","required":true,"schema":{"$ref":"#/definitions/ADDomainUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-domains/{id}/ad-containers":{"get":{"tags":["External"],"summary":"List active directory containers for a specific domain.","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","produces":["*/*"],"parameters":[{"name":"container_name","in":"query","description":"AD container name in Base64URL encoded format","required":false,"type":"string","allowEmptyValue":false},{"name":"id","in":"path","description":"AD domain SID","required":true,"type":"string"},{"name":"rdn","in":"query","description":"rdn of AD container in Base64URL encoded format","required":false,"type":"string","allowEmptyValue":false},{"name":"sub_tree_search","in":"query","description":"true to search subtree. Subtree search is only supported for rdn.","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ADContainerInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-domains/{id}/ad-containers/default":{"get":{"tags":["External"],"summary":"Get default AD container for specified domain.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"AD Domain SID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ADContainerInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-domains/{id}/ad-containers/{rdn}":{"get":{"tags":["External"],"summary":"Gets the AD container for specified domain.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"AD Domain SID","required":true,"type":"string"},{"name":"rdn","in":"path","description":"rdn of AD container in Base64URL encoded format.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ADContainerInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-users-or-groups":{"get":{"tags":["External"],"summary":"Lists AD users or groups information.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.com","operationId":"listADUserOrGroupSummary","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"group_only","in":"query","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.","required":false,"type":"string","allowEmptyValue":false},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ADUserOrGroupSummary"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-users-or-groups/action/change-user-password":{"post":{"tags":["External"],"summary":"Changes the password of AD User","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"AD user password object to be changed.","required":true,"schema":{"$ref":"#/definitions/ADUserChangePasswordSpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ADUserInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-users-or-groups/action/hold":{"post":{"tags":["External"],"summary":"Put users on hold.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Set of AD user SIDs to put on hold.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-users-or-groups/action/release-hold":{"post":{"tags":["External"],"summary":"Release users from hold.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Set of AD user SIDs to release from hold.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-users-or-groups/action/validate-user-encrypted-credentials":{"post":{"tags":["External"],"summary":"Validates the encrypted credentials of AD User","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"AD user encrypted credentials object to be validated.","required":true,"schema":{"$ref":"#/definitions/ADUserEncryptedCredentialSpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ADUserInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-users-or-groups/held-users-or-groups":{"get":{"tags":["External"],"summary":"List information related to Held Users.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/HeldUserOrGroupInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-users-or-groups/{id}":{"get":{"tags":["External"],"summary":"Get information related to AD User or Group","operationId":"getADUserOrGroupInfo","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ADUserOrGroupInfo"}},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/audit-events":{"get":{"tags":["External"],"summary":"Lists the audit events.","description":"This API supports Pagination.
","operationId":"listAuditEvents","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AuditEventSummary"}}},"401":{"description":"User is not authenticated"},"409":{"description":"Conflict"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/audit-events/extended-attributes":{"get":{"tags":["External"],"summary":"Get extended attributes of audit events","operationId":"auditEventsExtendedAttributes","produces":["*/*"],"parameters":[{"name":"ids","in":"query","description":"Audit Event IDs","required":true,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AuditEventAttributeInfo"}}},"401":{"description":"User is not authenticated"},"409":{"description":"Conflict"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/base-snapshots":{"get":{"tags":["External"],"summary":"Lists all the VM snapshots from the vCenter for a given VM.","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","produces":["*/*"],"parameters":[{"name":"base_vm_id","in":"query","description":"VM ID","required":true,"type":"string","allowEmptyValue":false,"x-example":"vm-1"},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false,"x-example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BaseSnapshotInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/base-vms":{"get":{"tags":["External"],"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.","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","produces":["*/*"],"parameters":[{"name":"datacenter_id","in":"query","description":"Datacenter ID","required":false,"type":"string","allowEmptyValue":false},{"name":"filter_incompatible_vms","in":"query","description":"Whether to filter out incompatible VMs","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BaseVMInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/customization-specifications":{"get":{"tags":["External"],"summary":"Lists all the customization specifications from the vCenter.","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","produces":["*/*"],"parameters":[{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/CustomizationSpecInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/datacenters":{"get":{"tags":["External"],"summary":"Lists all the datacenters of a vCenter.","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","produces":["*/*"],"parameters":[{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DatacenterInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/datastore-clusters":{"get":{"tags":["External"],"summary":"Lists all the datastore clusters from the vCenter for the given host or cluster.","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","produces":["*/*"],"parameters":[{"name":"host_or_cluster_id","in":"query","description":"Host or Cluster ID","required":true,"type":"string","allowEmptyValue":false},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DatastoreClusterInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/datastore-paths":{"get":{"tags":["External"],"summary":"Lists all the folder paths within a Datastore from vCenter.","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","produces":["*/*"],"parameters":[{"name":"datastore_id","in":"query","description":"Datastore ID","required":true,"type":"string","allowEmptyValue":false,"x-example":"datastore-29"},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false,"x-example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DatastorePathInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/datastores":{"get":{"tags":["External"],"summary":"Lists all the datastores from the vCenter for the given host or cluster.","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","produces":["*/*"],"parameters":[{"name":"host_or_cluster_id","in":"query","description":"Host or Cluster ID","required":true,"type":"string","allowEmptyValue":false,"x-example":"domain-c85"},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false,"x-example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DatastoreInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/datastores/action/compute-requirements":{"post":{"tags":["External"],"summary":"Computes the datastore space requirements for inventory resources.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Datastore space requirement to be computed.","required":true,"schema":{"$ref":"#/definitions/DatastoreSpaceRequirementSpec"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DatastoreSpaceRequirementInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/domains":{"get":{"tags":["External"],"summary":"Returns a map of domain NETBIOS name and dns name for domains which are configured on connection server.","operationId":"listDomains","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"object","additionalProperties":{"type":"string"}}}},"deprecated":false}},"/external/v1/hosts-or-clusters":{"get":{"tags":["External"],"summary":"Lists all the hosts or clusters of the datacenter.","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","produces":["*/*"],"parameters":[{"name":"datacenter_id","in":"query","description":"Datacenter ID","required":true,"type":"string","allowEmptyValue":false},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/HostOrClusterInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/network-interface-cards":{"get":{"tags":["External"],"summary":"Returns a list of network interface cards (NICs) suitable for configuration on a desktop pool/farm.","description":"If the base VM and snapshot are specified, then the NICs present on the given snapshot are listed.
If the template is specified then the NICs present on the given template are listed.
If only base VM is specified then the NICs present on the given base VM are listed.
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","produces":["*/*"],"parameters":[{"name":"base_snapshot_id","in":"query","description":"Base Snapshot ID","required":false,"type":"string","allowEmptyValue":false},{"name":"base_vm_id","in":"query","description":"Base VM ID","required":false,"type":"string","allowEmptyValue":false},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false},{"name":"vm_template_id","in":"query","description":"VM Template ID","required":false,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/NetworkInterfaceCardInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/network-labels":{"get":{"tags":["External"],"summary":"Retrieves all network labels on the given host or cluster","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.
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","produces":["*/*"],"parameters":[{"name":"host_or_cluster_id","in":"query","description":"Host or Cluster ID","required":true,"type":"string","allowEmptyValue":false},{"name":"network_type","in":"query","description":"Network Type\n* NETWORK: Standard network.\n* OPAQUE_NETWORK: Opaque network.\n* DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS Port group.","required":false,"type":"string","allowEmptyValue":false,"enum":["NETWORK","OPAQUE_NETWORK","DISTRUBUTED_VIRTUAL_PORT_GROUP"]},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/NetworkLabelInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/resource-pools":{"get":{"tags":["External"],"summary":"Lists all the resource pools from the vCenter for the given host or cluster.","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","produces":["*/*"],"parameters":[{"name":"host_or_cluster_id","in":"query","description":"Host or Cluster ID","required":true,"type":"string","allowEmptyValue":false,"x-example":"domain-c85"},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false,"x-example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ResourcePoolInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/virtual-machines":{"get":{"tags":["External"],"summary":"Lists all the VMs from a vCenter.","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","produces":["*/*"],"parameters":[{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VirtualMachineInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/vm-folders":{"get":{"tags":["External"],"summary":"Lists all the VM folders from the vCenter for the given datacenter.","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","produces":["*/*"],"parameters":[{"name":"datacenter_id","in":"query","description":"Datacenter ID","required":true,"type":"string","allowEmptyValue":false,"x-example":"datacenter-1"},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false,"x-example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VMFolderInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/vm-templates":{"get":{"tags":["External"],"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.","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","produces":["*/*"],"parameters":[{"name":"datacenter_id","in":"query","description":"Datacenter ID","required":false,"type":"string","allowEmptyValue":false},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VMTemplateInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v2/ad-domains":{"get":{"tags":["External"],"summary":"Lists information related to AD Domains of the environment.","operationId":"listADDomainsV2","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ADDomainInfoV2"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v2/ad-users-or-groups/action/hold":{"post":{"tags":["External"],"summary":"Put users on hold.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Set of AD user SIDs to put on hold.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/HeldUserOrGroupResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v2/ad-users-or-groups/action/release-hold":{"post":{"tags":["External"],"summary":"Release users from hold.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Set of AD user SIDs to release from hold.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/HeldUserOrGroupResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v2/base-snapshots":{"get":{"tags":["External"],"summary":"Lists all the VM snapshots from the vCenter for a given VM.","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","produces":["*/*"],"parameters":[{"name":"base_vm_id","in":"query","description":"VM ID","required":true,"type":"string","allowEmptyValue":false,"x-example":"vm-1"},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false,"x-example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BaseSnapshotInfoV2"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v2/base-vms":{"get":{"tags":["External"],"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.","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","produces":["*/*"],"parameters":[{"name":"datacenter_id","in":"query","description":"Datacenter ID","required":false,"type":"string","allowEmptyValue":false},{"name":"filter_incompatible_vms","in":"query","description":"Whether to filter out incompatible VMs","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BaseVMInfoV2"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v2/network-interface-cards":{"get":{"tags":["External"],"summary":"Returns a list of network interface cards (NICs) suitable for configuration on a desktop pool/farm.","description":"If the base VM and snapshot are specified, then the NICs present on the given snapshot are listed.
If the template is specified then the NICs present on the given template are listed.
If only base VM is specified then the NICs present on the given base VM are listed.
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","produces":["*/*"],"parameters":[{"name":"base_snapshot_id","in":"query","description":"Base Snapshot ID","required":false,"type":"string","allowEmptyValue":false},{"name":"base_vm_id","in":"query","description":"Base VM ID","required":false,"type":"string","allowEmptyValue":false},{"name":"vcenter_id","in":"query","description":"Virtual Center ID","required":true,"type":"string","allowEmptyValue":false},{"name":"vm_template_id","in":"query","description":"VM Template ID","required":false,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/NetworkInterfaceCardInfoV2"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v3/ad-domains":{"get":{"tags":["External"],"summary":"Lists information related to AD Domains of the environment.","operationId":"listADDomainsV3","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ADDomainInfoV3"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/cpa":{"get":{"tags":["Federation"],"summary":"Retrieves the pod federation details.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PodFederationInfo"}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Federation"],"summary":"Updates a Pod Federation.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Pod Federation object to be updated.","required":true,"schema":{"$ref":"#/definitions/CPAUpdateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/cpa/action/eject":{"post":{"tags":["Federation"],"summary":"Removes a pod from Cloud Pod Federation.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"The specification for removing a pod from pod federation.","required":true,"schema":{"$ref":"#/definitions/CPAEjectSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/cpa/action/initialize":{"post":{"tags":["Federation"],"summary":"Initialize Cloud Pod Federation.","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","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CPATaskResponseInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/cpa/action/join":{"post":{"tags":["Federation"],"summary":"Join Cloud Pod Federation.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"The specification for joining the pod federation.","required":true,"schema":{"$ref":"#/definitions/CPAJoinSpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CPATaskResponseInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/cpa/action/uninitialize":{"post":{"tags":["Federation"],"summary":"Uninitialize Cloud Pod Federation.","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","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CPATaskResponseInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/cpa/action/unjoin":{"post":{"tags":["Federation"],"summary":"Unjoin from Cloud Pod Federation.","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","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CPATaskResponseInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/cpa/tasks":{"get":{"tags":["Federation"],"summary":"Lists all the CPA tasks in the pod federation.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TaskInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/cpa/tasks/{id}":{"get":{"tags":["Federation"],"summary":"Retrieves the information for a given task.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TaskInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/home-sites":{"get":{"tags":["Federation"],"summary":"Lists all the home sites in the pod federation.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/HomeSiteInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Federation"],"summary":"Creates the given home sites in the pod federation.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of home site objects to be created.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/HomeSiteCreateSpec"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Federation"],"summary":"Deletes the given home sites from the pod federation.","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","produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of home site IDs to be deleted.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/home-sites/action/resolve":{"post":{"tags":["Federation"],"summary":"Resolves home sites for a user in the pod federation.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Home site specification to be resolved.","required":true,"schema":{"$ref":"#/definitions/HomeSiteResolutionSpec"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/HomeSiteResolutionInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/home-sites/{id}":{"get":{"tags":["Federation"],"summary":"Retrieves a given home site in the pod federation.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/HomeSiteInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/pod-assignments":{"get":{"tags":["Federation"],"summary":"Lists all the pod assignments in the pod federation.","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 Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PodAssignmentInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/pod-assignments/{id}":{"get":{"tags":["Federation"],"summary":"Retrieves a given pod assignment from the pod federation.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PodAssignmentInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/pods":{"get":{"tags":["Federation"],"summary":"Lists all the pods in the pod federation.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PodInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/pods/{id}":{"get":{"tags":["Federation"],"summary":"Retrieves a given pod from the pod federation.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"ID of the Pod.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PodInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Federation"],"summary":"Updates the given pod in the pod federation.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"ID of the Pod.","required":true,"type":"string"},{"in":"body","name":"podUpdateSpec","description":"Pod object to be updated.","required":true,"schema":{"$ref":"#/definitions/PodUpdateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/pods/{id}/endpoints":{"get":{"tags":["Federation"],"summary":"Lists all the pod endpoints for the given pod.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Pod ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PodEndpointInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/pods/{id}/endpoints/{endpointId}":{"get":{"tags":["Federation"],"summary":"Retrieves pod endpoint details for the given pod endpoint id in the given pod.","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","produces":["*/*"],"parameters":[{"name":"endpointId","in":"path","description":"Pod endpoint ID","required":true,"type":"string"},{"name":"id","in":"path","description":"Pod ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PodEndpointInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/sites":{"get":{"tags":["Federation"],"summary":"Lists all the sites in the pod federation.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SiteInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Federation"],"summary":"Creates a site.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Site object to be created.","required":true,"schema":{"$ref":"#/definitions/SiteCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/federation/v1/sites/{id}":{"get":{"tags":["Federation"],"summary":"Retrives a given site.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SiteInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Federation"],"summary":"Updates a site.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Site object to be updated.","required":true,"schema":{"$ref":"#/definitions/SiteUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Federation"],"summary":"Deletes a site.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/agent-installer-packages":{"get":{"tags":["Inventory"],"summary":"Lists agent installer packages.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AgentInstallerPackageInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/agent-installer-packages/action/register":{"post":{"tags":["Inventory"],"summary":"Registers an agent installer package.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Agent installer package to be registered","required":true,"schema":{"$ref":"#/definitions/AgentInstallerPackageRegisterSpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AgentInstallerPackageRegisterResponseInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/agent-installer-packages/{id}":{"get":{"tags":["Inventory"],"summary":"Retrieves an agent installer package.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Id of agent installer package","required":true,"type":"string","x-example":"8fdefa82-17e4-4367-b5b1-8d97e4fd5e56"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AgentInstallerPackageInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/agent-installer-packages/{id}/action/unregister":{"post":{"tags":["Inventory"],"summary":"Unregisters an agent installer package.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Id of agent installer package to be unregistered","required":true,"type":"string","x-example":"8fdefa82-17e4-4367-b5b1-8d97e4fd5e56"}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/application-icons":{"get":{"tags":["Inventory"],"summary":"Lists the application icons for the given application pool.","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.
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","produces":["*/*"],"parameters":[{"name":"application_pool_id","in":"query","description":"Application Pool ID","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ApplicationIconInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Creates an application icon.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Application icon object to be created.","required":true,"schema":{"$ref":"#/definitions/ApplicationIconCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/application-icons/{id}":{"get":{"tags":["Inventory"],"summary":"Gets application icon.","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.
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplicationIconInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/application-pools":{"get":{"tags":["Inventory"],"summary":"Lists the application pools in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ApplicationPoolInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Creates an application pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Application pool object to be created.","required":true,"schema":{"$ref":"#/definitions/ApplicationPoolCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/application-pools/action/check-name-availability":{"post":{"tags":["Inventory"],"summary":"Checks if the given name is available for application pool creation.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Name Availability Spec.","required":true,"schema":{"$ref":"#/definitions/NameAvailabilitySpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NameAvailabilityInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/application-pools/{id}":{"get":{"tags":["Inventory"],"summary":"Gets application pool.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplicationPoolInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Inventory"],"summary":"Updates application pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Application pool object to be updated.","required":true,"schema":{"$ref":"#/definitions/ApplicationPoolUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Inventory"],"summary":"Deletes application pool.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/application-pools/{id}/action/add-custom-icon":{"post":{"tags":["Inventory"],"summary":"Associates a custom icon to the application pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Icon id to be associated with the application pool.","required":true,"schema":{"$ref":"#/definitions/ApplicationIconAssociateSpec"}},{"name":"id","in":"path","description":"Application pool ID","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/application-pools/{id}/action/remove-custom-icon":{"post":{"tags":["Inventory"],"summary":"Removes the associated custom icon from the application pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Application pool ID","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/category-folders":{"get":{"tags":["Inventory"],"summary":"Lists the category folders.","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.
|\n| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, on the associated federated access group to read category folder.
. |","operationId":"listCategoryFolders","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools":{"get":{"tags":["Inventory"],"summary":"Lists the Desktop Pools in the environment.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DesktopPoolInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Creates a desktop pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Desktop pool object to be created.","required":true,"schema":{"$ref":"#/definitions/DesktopPoolCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/action/check-name-availability":{"post":{"tags":["Inventory"],"summary":"Checks if the given name is available for desktop pool creation.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Name Availability Spec.","required":true,"schema":{"$ref":"#/definitions/NameAvailabilitySpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NameAvailabilityInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/action/validate-specified-names":{"post":{"tags":["Inventory"],"summary":"Validates manually specified virtual machines. Ensures machine and user names are valid and aren't duplicated in the given desktop pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"The specification for specified names validation that needs to be validated.","required":true,"schema":{"$ref":"#/definitions/SpecifiedNamesValidationSpec"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SpecifiedNamesValidationInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Desktop Pool information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DesktopPoolInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Inventory"],"summary":"Updates desktop pool.","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.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Desktop Pool object to be updated.","required":true,"schema":{"$ref":"#/definitions/DesktopPoolUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Inventory"],"summary":"Deletes a desktop pool.","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","produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Desktop pool object to be deleted.","required":false,"schema":{"$ref":"#/definitions/DesktopPoolDeleteSpec"}},{"name":"id","in":"path","description":"ID of the desktop pool to be deleted.","required":true,"type":"string","x-example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe"}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/action/add-machines":{"post":{"tags":["Inventory"],"summary":"Adds machines to the given manual desktop pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Machine Ids representing the machines to be added to the desktop pool.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/action/add-machines-by-name":{"post":{"tags":["Inventory"],"summary":"Adds the named machines to the given desktop pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of MachineSpecifiedName representing the machines to be added to the desktop pool.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/MachineSpecifiedName"}}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/action/apply-image":{"post":{"tags":["Inventory"],"summary":"Applies the pending image or the current image to selected machines in the desktop pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Machines on which the image is to be applied.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"Desktop pool ID","required":true,"type":"string"},{"name":"pending_image","in":"query","description":"Indicates whether the pending image is to be applied. If false, the current image will be applied.","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/action/cancel-scheduled-push-image":{"post":{"tags":["Inventory"],"summary":"Request the cancellation of the current scheduled push image operation on the specified instant clone desktop pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/action/promote-pending-image":{"post":{"tags":["Inventory"],"summary":"Promotes pending image to current image in the desktop pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/action/remove-machines":{"post":{"tags":["Inventory"],"summary":"Removes machines from the given manual desktop pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Machine Ids representing the machines to be removed from the desktop pool.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/action/schedule-push-image":{"post":{"tags":["Inventory"],"summary":"Schedule/reschedule a request to update the image in an instant clone desktop pool.","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.
To schedule the request, there should not be any operation on the desktop pool currently.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specification for the push image operation.","required":true,"schema":{"$ref":"#/definitions/DesktopPoolPushImageSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/action/validate-installed-applications":{"post":{"tags":["Inventory"],"summary":"Validates that each application in the given list is installed on the machines belonging to the specified desktop pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of application exe paths for the applications to be validated.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"Desktop Pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/InstalledApplicationValidationInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/installed-applications":{"get":{"tags":["Inventory"],"summary":"Lists the installed applications on the given desktop pool.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/InstalledApplicationInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/tasks":{"get":{"tags":["Inventory"],"summary":"Lists the tasks on the desktop pool.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DesktopPoolTaskInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/tasks/{taskId}":{"get":{"tags":["Inventory"],"summary":"Gets the task information on the desktop pool.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Desktop pool ID","required":true,"type":"string"},{"name":"taskId","in":"path","description":"Desktop pool task ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DesktopPoolTaskInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/tasks/{taskId}/action/cancel":{"post":{"tags":["Inventory"],"summary":"Cancels the instant clone desktop pool push image task.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Desktop pool ID","required":true,"type":"string"},{"name":"taskId","in":"path","description":"Desktop pool task ID","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/tasks/{taskId}/action/pause":{"post":{"tags":["Inventory"],"summary":"Pause the instant clone desktop pool push image task.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Desktop pool ID","required":true,"type":"string"},{"name":"taskId","in":"path","description":"Desktop pool task ID","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/desktop-pools/{id}/tasks/{taskId}/action/resume":{"post":{"tags":["Inventory"],"summary":"Resume the instant clone desktop pool push image task.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specification for resuming the task. If not provided, specification will be set to default values.","required":false,"schema":{"$ref":"#/definitions/ResumeTaskSpec"}},{"name":"id","in":"path","description":"Desktop pool ID","required":true,"type":"string"},{"name":"taskId","in":"path","description":"Desktop pool task ID","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/farms":{"get":{"tags":["Inventory"],"summary":"Lists the Farms in the environment.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/FarmInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Creates a farm.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Farm object to be created.","required":true,"schema":{"$ref":"#/definitions/FarmCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/farms/action/check-name-availability":{"post":{"tags":["Inventory"],"summary":"Checks if the given name is available for farm creation.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Name Availability Spec.","required":true,"schema":{"$ref":"#/definitions/NameAvailabilitySpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NameAvailabilityInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/farms/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Farm information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FarmInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Inventory"],"summary":"Updates farm.","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.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Farm object to be updated.","required":true,"schema":{"$ref":"#/definitions/FarmUpdateSpec"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Inventory"],"summary":"Deletes a farm.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/farms/{id}/action/add-rds-servers":{"post":{"tags":["Inventory"],"summary":"Add RDS servers to the specified manual farm.","description":"Note: This operation is only applicable for manual farms.\n
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of RDS server IDs representing the RDS servers to be added to the farm.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"Farm ID","required":true,"type":"string","x-example":"5134796a-322g-5fe5-343f-4daa5d25ebfe"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/farms/{id}/action/apply-image":{"post":{"tags":["Inventory"],"summary":"Applies the pending image or the current image to selected RDS servers in the farm.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"RDS servers on which the image is to be applied.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"Farm ID","required":true,"type":"string"},{"name":"pending_image","in":"query","description":"Indicates whether the pending image is to be applied. If false, the current image will be applied.","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/farms/{id}/action/cancel-scheduled-maintenance":{"post":{"tags":["Inventory"],"summary":"Requests cancellation of the current scheduled maintenance on the specified Instant Clone farm.","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
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"The specification to cancel the scheduled maintenance operation.","required":true,"schema":{"$ref":"#/definitions/FarmCancelMaintenanceSpec"}},{"name":"id","in":"path","description":"Farm ID","required":true,"type":"string","x-example":"5134796a-322g-5fe5-343f-4daa5d25ebfe"}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/farms/{id}/action/promote-pending-image":{"post":{"tags":["Inventory"],"summary":"Promotes pending image to current image in the farm.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/farms/{id}/action/remove-rds-servers":{"post":{"tags":["Inventory"],"summary":"Remove RDS servers from the specified farm.","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
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of RDS server IDs representing the RDS servers to be removed from the farm.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"Farm ID","required":true,"type":"string","x-example":"5134796a-322g-5fe5-343f-4daa5d25ebfe"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/farms/{id}/action/schedule-maintenance":{"post":{"tags":["Inventory"],"summary":"Creates maintenance schedule for the specified farm.","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
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"The specification to schedule maintenance.","required":true,"schema":{"$ref":"#/definitions/FarmMaintenanceSpec"}},{"name":"id","in":"path","description":"Farm ID","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/farms/{id}/action/validate-installed-applications":{"post":{"tags":["Inventory"],"summary":"Validates that each application in the given list is installed on the RDS Servers belonging to the specified Farm.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of application exe paths for the applications to be validated.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"Farm ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/InstalledApplicationValidationInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/farms/{id}/app-volumes-applications":{"get":{"tags":["Inventory"],"summary":"Lists the App Volumes applications on the given farm.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AppVolumesApplicationInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/farms/{id}/installed-applications":{"get":{"tags":["Inventory"],"summary":"Lists the installed applications on the given farm.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/InstalledApplicationInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-application-entitlements":{"get":{"tags":["Inventory"],"summary":"Lists the Global Application Entitlements in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/GlobalApplicationEntitlementSummary"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Creates a Global Application Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Global Application Entitlement object to be created.","required":true,"schema":{"$ref":"#/definitions/GlobalApplicationEntitlementCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-application-entitlements/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Global Application Entitlement in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GlobalApplicationEntitlementInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Inventory"],"summary":"Updates a Global Application Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Global Application Entitlement object to be updated.","required":true,"schema":{"$ref":"#/definitions/GlobalApplicationEntitlementUpdateSpec"}},{"name":"id","in":"path","description":"Global Application Entitlement object to be updated","required":true,"type":"string","x-example":"5134796a-322g-5fe5-343f-4daa5d25ebfe"}],"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Inventory"],"summary":"Deletes a Global Application Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Global Application Entitlement ID","required":true,"type":"string","x-example":"5134796a-322g-5fe5-343f-4daa5d25ebfe"}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-application-entitlements/{id}/compatible-backup-global-application-entitlements":{"get":{"tags":["Inventory"],"summary":"Lists the Global Application Entitlements that can be associated as backup Global Application Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Global Application Entitlement ID","required":true,"type":"string","x-example":"5134796a-322g-5fe5-343f-4daa5d25ebfe"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-application-entitlements/{id}/compatible-local-application-pools":{"get":{"tags":["Inventory"],"summary":"Lists Local Application Pools which are compatible with Global Application Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-application-entitlements/{id}/local-application-pools":{"get":{"tags":["Inventory"],"summary":"Lists Local Application Pools which are assigned to Global Application Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Adds Local Application Pools to Global Application Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of local application pool ids to be added.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Inventory"],"summary":"Removes Local Application Pools from Global Application Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of local application pool ids to be removed.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-desktop-entitlements":{"get":{"tags":["Inventory"],"summary":"Lists the Global Desktop Entitlements in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/GlobalDesktopEntitlementSummary"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Creates a Global Desktop Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Global Desktop Entitlement object to be created.","required":true,"schema":{"$ref":"#/definitions/GlobalDesktopEntitlementCreateSpec"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-desktop-entitlements/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Global Desktop Entitlement in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GlobalDesktopEntitlementInfo"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Inventory"],"summary":"Updates a Global Desktop Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Global Desktop Entitlement object to be updated.","required":true,"schema":{"$ref":"#/definitions/GlobalDesktopEntitlementUpdateSpec"}},{"name":"id","in":"path","description":"Global Desktop Entitlement object to be updated","required":true,"type":"string","x-example":"5134796a-322g-5fe5-343f-4daa5d25ebfe"}],"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Inventory"],"summary":"Deletes a Global Desktop Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Global Desktop Entitlement ID","required":true,"type":"string","x-example":"5134796a-322g-5fe5-343f-4daa5d25ebfe"}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-desktop-entitlements/{id}/compatible-backup-global-desktop-entitlements":{"get":{"tags":["Inventory"],"summary":"Lists the Global Desktop Entitlements that can be associated as backup Global Desktop Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Global Desktop Entitlement ID","required":true,"type":"string","x-example":"5134796a-322g-5fe5-343f-4daa5d25ebfe"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-desktop-entitlements/{id}/compatible-local-desktop-pools":{"get":{"tags":["Inventory"],"summary":"Lists Local Desktop Pools which are compatible with Global Desktop Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-desktop-entitlements/{id}/local-desktop-pools":{"get":{"tags":["Inventory"],"summary":"Lists Local Desktop Pools which are assigned to Global Desktop Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Adds Local Desktop Pools to Global Desktop Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of local desktop pool ids to be added.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Inventory"],"summary":"Removes Local Desktop Pools from Global Desktop Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of local desktop pool ids to be removed.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-sessions":{"get":{"tags":["Inventory"],"summary":"Lists global sessions in the environment for the given user, pod or brokering pod.","description":"Note: CPA must be initialized for the pod for invoking this API.
Exactly one of user_id, pod_id and brokering_pod_id must be set to non-null value.
This API supports Pagination.
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","produces":["*/*"],"parameters":[{"name":"brokering_pod_id","in":"query","description":"ID of the pod that brokered the session.","required":false,"type":"string","allowEmptyValue":false,"x-example":"806ca35f-bcab-4a42-9006-04ba27cad900"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"pod_id","in":"query","description":"ID of the pod that hosted the session.","required":false,"type":"string","allowEmptyValue":false,"x-example":"96d708fe-badb-40f8-9b80-9029b0ab2ef2"},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10},{"name":"user_id","in":"query","description":"SID of the user.","required":false,"type":"string","allowEmptyValue":false,"x-example":"S-1-5-21-1111111111-2222222222-3333333333-500"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/GlobalSessionInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-sessions/action/disconnect":{"post":{"tags":["Inventory"],"summary":"Disconnects global sessions in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"global_session_action_specs","description":"Sessions which are to be disconnected.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/GlobalSessionActionSpec"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkGlobalSessionActionResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-sessions/action/logoff":{"post":{"tags":["Inventory"],"summary":"Logs off global sessions in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"forced","in":"query","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","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":true},{"in":"body","name":"global_session_action_specs","description":"Sessions which are to be logged off.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/GlobalSessionActionSpec"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkGlobalSessionActionResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-sessions/action/reset":{"post":{"tags":["Inventory"],"summary":"Resets machines of global sessions in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"global_session_action_specs","description":"Sessions which are to be reset.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/GlobalSessionActionSpec"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkGlobalSessionActionResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-sessions/action/restart":{"post":{"tags":["Inventory"],"summary":"Restarts machines of global sessions in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"global_session_action_specs","description":"Sessions which are to be restarted.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/GlobalSessionActionSpec"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkGlobalSessionActionResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/global-sessions/action/send-message":{"post":{"tags":["Inventory"],"summary":"Sends message to global sessions in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Global sessions to which message is to be sent.","required":true,"schema":{"$ref":"#/definitions/GlobalSessionSendMessageSpec"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkGlobalSessionActionResponseInfo"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines":{"get":{"tags":["Inventory"],"summary":"Lists the Machines in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MachineInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Inventory"],"summary":"Deletes the specified machines.","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","produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"The machines and specification for deletion.","required":true,"schema":{"$ref":"#/definitions/MachineDeleteSpec"}}],"responses":{"200":{"description":"No Content","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/action/archive":{"post":{"tags":["Inventory"],"summary":"Initiates machine archival process","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Set of Held Machine Ids which should be archived.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/action/cancel-agent-upgrade":{"post":{"tags":["Inventory"],"summary":"cancel agent upgrades.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Set of task IDs to cancel the agent upgrade.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/action/check-name-availability":{"post":{"tags":["Inventory"],"summary":"Checks if the given prefix is available for machine creation.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Name Availability Spec.","required":true,"schema":{"$ref":"#/definitions/NameAvailabilitySpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NameAvailabilityInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/action/enter-maintenance":{"post":{"tags":["Inventory"],"summary":"Puts the machines into maintenance mode.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Machine Ids representing the machines to be put into maintenance mode.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"enforce","in":"query","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.","required":false,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/action/exit-maintenance":{"post":{"tags":["Inventory"],"summary":"Puts the machines out of maintenance mode.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Machine Ids representing the machines to be put out of maintenance mode.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/action/rebuild":{"post":{"tags":["Inventory"],"summary":"Rebuilds the specified machines.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Machine Ids representing the machines to be rebuilt.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/action/recover":{"post":{"tags":["Inventory"],"summary":"Recovers the specified machines.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Machine Ids representing the machines to be recovered.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"enforce","in":"query","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.","required":false,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/action/reset":{"post":{"tags":["Inventory"],"summary":"Resets the specified machines.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Machine Ids representing the machines to be reset.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"enforce","in":"query","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.","required":false,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/action/restart":{"post":{"tags":["Inventory"],"summary":"Restarts the specified machines.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of Machine Ids representing the machines to be restarted.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"enforce","in":"query","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.","required":false,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/action/schedule-agent-upgrade":{"post":{"tags":["Inventory"],"summary":"Schedule agents for upgrade.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Machine agent upgrade spec.","required":true,"schema":{"$ref":"#/definitions/MachineAgentUpgradeSpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AgentUpgradeTaskResponseInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/agent-upgrade-tasks":{"get":{"tags":["Inventory"],"summary":"List agent upgrade tasks information.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AgentUpgradeTaskInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/agent-upgrade-tasks/{id}":{"get":{"tags":["Inventory"],"summary":"Get agent upgrade task information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AgentUpgradeTaskInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Machine information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MachineInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Inventory"],"summary":"Deletes the machine.","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","produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"The specification applicable to deleting the machine.","required":true,"schema":{"$ref":"#/definitions/MachineDeleteData"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/{id}/action/assign-aliases":{"post":{"tags":["Inventory"],"summary":"Assigns the specified aliases to the assigned users of the machine.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of MachineAlias. If a user is assigned to the machine we can set the corresponding aliases.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/MachineAliasSpec"}}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/{id}/action/assign-users":{"post":{"tags":["Inventory"],"summary":"Assigns the specified users to the machine.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of User SIDs representing the users to be assigned to the machine.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/{id}/action/unassign-aliases":{"post":{"tags":["Inventory"],"summary":"Un-assigns the aliases for the specified users from the machine.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of User SIDs whose aliases will be un-assigned from the machine.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/machines/{id}/action/unassign-users":{"post":{"tags":["Inventory"],"summary":"Un-assigns the specified users from the machine.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of User SIDs representing the users to be un-assigned from the machine.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/physical-machines":{"get":{"tags":["Inventory"],"summary":"Lists the Physical Machines in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PhysicalMachineInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/physical-machines/action/register":{"post":{"tags":["Inventory"],"summary":"Registers the Physical Machine.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"The specification for registering the physical machine.","required":true,"schema":{"$ref":"#/definitions/PhysicalMachineRegisterSpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PhysicalMachineRegisterInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/physical-machines/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Physical Machine information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Physical machine ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PhysicalMachineInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Inventory"],"summary":"Deletes the Physical Machine.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Physical machine ID","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/rds-servers":{"get":{"tags":["Inventory"],"summary":"Lists the RDS Servers in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/RDSServerInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/rds-servers/action/check-name-availability":{"post":{"tags":["Inventory"],"summary":"Checks if the given prefix is available for RDS Server creation.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Name Availability Spec.","required":true,"schema":{"$ref":"#/definitions/NameAvailabilitySpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NameAvailabilityInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/rds-servers/action/recover":{"post":{"tags":["Inventory"],"summary":"Recovers the specified RDS Servers.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of RDS Server Ids representing the RDS Servers to be recovered.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/rds-servers/action/register":{"post":{"tags":["Inventory"],"summary":"Registers the RDS Server.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"The specification for registering the RDS Server.","required":true,"schema":{"$ref":"#/definitions/RDSServerRegisterSpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RDSServerRegisterInfo"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/rds-servers/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the RDS Server information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"RDS Server ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RDSServerInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Inventory"],"summary":"Updates the RDS Server.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"The specification for updating the RDS Server.","required":true,"schema":{"$ref":"#/definitions/RDSServerUpdateSpec"}},{"name":"id","in":"path","description":"RDS Server ID","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Inventory"],"summary":"Deletes the RDS Server.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"RDS Server ID","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/sessions":{"get":{"tags":["Inventory"],"summary":"Lists the locally resourced Sessions in the environment","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SessionInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/sessions/action/disconnect":{"post":{"tags":["Inventory"],"summary":"Disconnects locally resourced user sessions.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of session ids to be disconnected.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/sessions/action/logoff":{"post":{"tags":["Inventory"],"summary":"Logs off locally resourced user sessions, if they are not locked.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of session ids to be logged off.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"forced","in":"query","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.","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/sessions/action/reset":{"post":{"tags":["Inventory"],"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.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of session ids to be reset.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/sessions/action/restart":{"post":{"tags":["Inventory"],"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.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"List of session ids to be restarted.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/sessions/action/send-message":{"post":{"tags":["Inventory"],"summary":"Sends the message to locally resourced user sessions.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Message information object to be sent to sessions.","required":true,"schema":{"$ref":"#/definitions/SessionSendMessageSpec"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v1/sessions/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Session information for locally resourced session.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SessionInfo"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/application-pools":{"get":{"tags":["Inventory"],"summary":"Lists the application pools in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ApplicationPoolInfoV2"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Creates an application pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Application pool object to be created.","required":true,"schema":{"$ref":"#/definitions/ApplicationPoolCreateSpecV2"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/application-pools/{id}":{"get":{"tags":["Inventory"],"summary":"Gets application pool.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplicationPoolInfoV2"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Inventory"],"summary":"Updates application pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Application pool object to be updated.","required":true,"schema":{"$ref":"#/definitions/ApplicationPoolUpdateSpecV2"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/desktop-pools":{"get":{"tags":["Inventory"],"summary":"Lists the desktop pools in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DesktopPoolInfoV2"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Creates a desktop pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Desktop pool object to be created.","required":true,"schema":{"$ref":"#/definitions/DesktopPoolCreateSpecV2"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/desktop-pools/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the desktop pool information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DesktopPoolInfoV2"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/desktop-pools/{id}/action/schedule-push-image":{"post":{"tags":["Inventory"],"summary":"Schedule/reschedule a request to update the image in an instant clone desktop pool.","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.
To schedule the request, there should not be any operation on the desktop pool currently.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Specification for the push image operation.","required":true,"schema":{"$ref":"#/definitions/DesktopPoolPushImageSpecV2"}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/farms":{"get":{"tags":["Inventory"],"summary":"Lists the Farms in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.com\n
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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/FarmInfoV2"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Creates a farm.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Farm object to be created.","required":true,"schema":{"$ref":"#/definitions/FarmCreateSpecV2"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/farms/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Farm information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FarmInfoV2"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Inventory"],"summary":"Updates farm.","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.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Farm object to be updated.","required":true,"schema":{"$ref":"#/definitions/FarmUpdateSpecV2"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/farms/{id}/action/schedule-maintenance":{"post":{"tags":["Inventory"],"summary":"Creates maintenance schedule for the specified farm.","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
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"The specification to schedule maintenance.","required":true,"schema":{"$ref":"#/definitions/FarmMaintenanceSpecV2"}},{"name":"id","in":"path","description":"Farm ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BulkItemResponseInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/global-application-entitlements":{"get":{"tags":["Inventory"],"summary":"Lists the Global Application Entitlements in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/GlobalApplicationEntitlementSummaryV2"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/global-application-entitlements/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Global Application Entitlement in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GlobalApplicationEntitlementInfoV2"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/global-desktop-entitlements":{"get":{"tags":["Inventory"],"summary":"Lists the Global Desktop Entitlements in the environment.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/GlobalDesktopEntitlementSummaryV2"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Creates a Global Desktop Entitlement.","description":"Note: CPA must be initialized for the pod for invoking this API.\n
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Global Desktop Entitlement object to be created.","required":true,"schema":{"$ref":"#/definitions/GlobalDesktopEntitlementCreateSpecV2"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/global-desktop-entitlements/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Global Desktop Entitlement in the environment.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GlobalDesktopEntitlementInfoV2"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/machines":{"get":{"tags":["Inventory"],"summary":"Lists the Machines in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MachineInfoV2"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/machines/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Machine information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MachineInfoV2"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/physical-machines":{"get":{"tags":["Inventory"],"summary":"Lists the Physical Machines in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PhysicalMachineInfoV2"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v2/physical-machines/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Physical Machine information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"Physical machine ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PhysicalMachineInfoV2"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v3/application-pools":{"get":{"tags":["Inventory"],"summary":"Lists the application pools in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ApplicationPoolInfoV3"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Creates an application pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Application pool object to be created.","required":true,"schema":{"$ref":"#/definitions/ApplicationPoolCreateSpecV3"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v3/application-pools/{id}":{"get":{"tags":["Inventory"],"summary":"Gets application pool.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplicationPoolInfoV3"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Inventory"],"summary":"Updates application pool.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Application pool object to be updated.","required":true,"schema":{"$ref":"#/definitions/ApplicationPoolUpdateSpecV3"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v3/desktop-pools":{"get":{"tags":["Inventory"],"summary":"Lists the desktop pools in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DesktopPoolInfoV3"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v3/desktop-pools/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the desktop pool information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DesktopPoolInfoV3"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v3/farms":{"get":{"tags":["Inventory"],"summary":"Lists the Farms in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.com\n
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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/FarmInfoV3"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Inventory"],"summary":"Creates a farm.","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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Farm object to be created.","required":true,"schema":{"$ref":"#/definitions/FarmCreateSpecV3"}}],"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v3/farms/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Farm information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FarmInfoV3"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Inventory"],"summary":"Updates farm.","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.
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","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Farm object to be updated.","required":true,"schema":{"$ref":"#/definitions/FarmUpdateSpecV3"}},{"name":"id","in":"path","description":"id","required":true,"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v3/machines":{"get":{"tags":["Inventory"],"summary":"Lists the Machines in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MachineInfoV3"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v3/machines/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Machine information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MachineInfoV3"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v4/application-pools":{"get":{"tags":["Inventory"],"summary":"Lists the application pools in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ApplicationPoolInfoV4"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v4/application-pools/{id}":{"get":{"tags":["Inventory"],"summary":"Gets application pool.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplicationPoolInfoV4"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v4/desktop-pools":{"get":{"tags":["Inventory"],"summary":"Lists the desktop pools in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DesktopPoolInfoV4"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v4/desktop-pools/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the desktop pool information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DesktopPoolInfoV4"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v4/farms":{"get":{"tags":["Inventory"],"summary":"Lists the Farms in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.com\n
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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/FarmInfoV4"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v4/farms/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Farm information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FarmInfoV4"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v4/machines":{"get":{"tags":["Inventory"],"summary":"Lists the Machines in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MachineInfoV4"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v4/machines/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Machine information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MachineInfoV4"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v5/desktop-pools":{"get":{"tags":["Inventory"],"summary":"Lists the desktop pools in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.com\n
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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DesktopPoolInfoV5"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v5/desktop-pools/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the desktop pool information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DesktopPoolInfoV5"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v5/farms":{"get":{"tags":["Inventory"],"summary":"Lists the Farms in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.com\n
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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/FarmInfoV5"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v5/farms/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the Farm information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FarmInfoV5"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v6/desktop-pools":{"get":{"tags":["Inventory"],"summary":"Lists the desktop pools in the environment.","description":"This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.com\n
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","produces":["*/*"],"parameters":[{"name":"filter","in":"query","description":"filter expression built using fields with 'supported filters' as described in output model schema of this API.","required":false,"type":"string","x-example":"{\"type\":\"And\", \"filters\":[{\"type\":\"Equals\", \"name\":\"<>\", \"value\":\"<>\"}] }"},{"name":"page","in":"query","description":"page, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":1},{"name":"size","in":"query","description":"size, if passed should be > 0.","required":false,"type":"integer","format":"int32","x-example":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DesktopPoolInfoV6"}}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/inventory/v6/desktop-pools/{id}":{"get":{"tags":["Inventory"],"summary":"Gets the desktop pool information.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DesktopPoolInfoV6"}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/key-agreement":{"post":{"tags":["Auth"],"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.","operationId":"keyAgreement","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Client key derivation spec.","required":true,"schema":{"$ref":"#/definitions/ClientKeyDerivationSpec"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServerKeyDerivationInfo"}},"400":{"description":"Bad Request"}},"deprecated":false}},"/login":{"get":{"tags":["Auth"],"summary":"Logs in a user with smart card. Returns access and refresh tokens.","description":"Note: Smart card authentication is only supported in admin console.","operationId":"authenticateSmartCard","produces":["*/*"],"parameters":[{"name":"Accept-Language","in":"header","description":"Accept-Language","required":false,"type":"string"},{"name":"client_reference_id","in":"query","description":"client_reference_id","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SmartCardAuthTokens"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"deprecated":false},"post":{"tags":["Auth"],"summary":"Logs in a user. Returns access token and refresh token.","description":"Note: UPN(e.g. testadmin@example.com) based login is not supported.","operationId":"loginUser","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Accept-Language","in":"header","description":"Header to support localization.","required":false,"type":"string","default":"en","enum":["de","en","es","fr","ja","ko","zh-CN","zh-TW"]},{"in":"body","name":"body","description":"Login credentials needed for Authentication","required":true,"schema":{"$ref":"#/definitions/AuthLogin"}},{"name":"client_reference_id","in":"query","description":"Client reference identifier present in the response of key-agreement api.","required":false,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AuthTokens"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"deprecated":false}},"/logout":{"post":{"tags":["Auth"],"summary":"Logs out a user.","operationId":"logoutUser","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Refresh token needed for Logout","required":true,"schema":{"$ref":"#/definitions/RefreshToken"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/monitor/ad-domains":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to AD Domains of the environment.","operationId":"listADDomainMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ADDomainMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/app-volumes-managers":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to App volumes managers registered in the environment.","operationId":"listAppVolumesManagerMonitorInfoV1","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AppVolumesManagerMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/app-volumes-managers/{id}":{"get":{"tags":["Monitor"],"summary":"Retrieves information about an app volumes manager.","operationId":"getAppVolumesManagerMonitorInfo","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AppVolumesManagerMonitorInfo"}},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/connection-servers":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Connection Servers of the environment.","operationId":"listConnectionServerMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ConnectionServerMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/event-database":{"get":{"tags":["Monitor"],"summary":"Returns monitoring information related to Event database of the environment.","operationId":"getEventDatabaseMonitor","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventDatabaseMonitorInfo"}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/farms":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Farms of the environment.","operationId":"listFarmMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/FarmMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/gateways":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Gateways registered in the environment.","operationId":"listGatewayMonitorInfoV1","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/GatewayMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/rds-servers":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to RDS Servers of the environment.","operationId":"listRDSServerMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/RDSServerMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/saml-authenticators":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to SAML Authenticators of the environment.","operationId":"listSAMLAuthenticatorMonitorsV1","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SAMLAuthenticatorMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/connection-servers/{id}":{"get":{"tags":["Monitor"],"summary":"Gets monitoring information related to Connection Server.","operationId":"getConnectionServerMonitorInfoV2","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConnectionServerMonitorInfoV2"}},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/desktop-pools/metrics":{"get":{"tags":["Monitor"],"summary":"Lists metrics of desktop pools (except RDS desktop pools).","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","produces":["*/*"],"parameters":[{"name":"ids","in":"query","description":"Desktop pool IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DesktopPoolMetricsInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/farms/{id}":{"get":{"tags":["Monitor"],"summary":"Gets monitoring information related to farm.","operationId":"getFarmMonitorInfo","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FarmMonitorInfo"}},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/gateways/{id}":{"get":{"tags":["Monitor"],"summary":"Gets monitoring information related to a Gateway.","operationId":"getGatewayMonitorInfo","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GatewayMonitorInfoV2"}},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/pods":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to the remote pods.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PodMonitorInfo"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/pods/{id}":{"get":{"tags":["Monitor"],"summary":"Gets monitoring information related to the remote pod.","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","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PodMonitorInfoV2"}},"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"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/rds-servers/{id}":{"get":{"tags":["Monitor"],"summary":"Gets monitoring information related to RDS Server.","operationId":"getRDSServerMonitors","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RDSServerMonitorInfo"}},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/saml-authenticators/{id}":{"get":{"tags":["Monitor"],"summary":"Gets Monitoring Information related to a SAML Authenticator","operationId":"getSAMLAuthenticatorMonitorInfo","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SAMLAuthenticatorMonitorInfoV2"}},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/true-sso":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to True SSO connectors.","operationId":"listTrueSSOMonitorInfos","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TrueSSOMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/true-sso/{id}":{"get":{"tags":["Monitor"],"summary":"Gets monitoring information related to a True SSO connector.","operationId":"getTrueSSOMonitorInfo","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TrueSSOMonitorInfo"}},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/view-composers/{vcId}":{"get":{"tags":["Monitor"],"summary":"View Composer is no longer supported from Horizon version 2012 onwards.","operationId":"getViewComposerByVCId","produces":["*/*"],"parameters":[{"name":"vcId","in":"path","description":"vcId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ViewComposerMonitorInfoV2"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":true}},"/monitor/v1/virtual-centers/{id}":{"get":{"tags":["Monitor"],"summary":"Gets monitoring information related to Virtual Center.","operationId":"getVirtualCenterMonitorInfo","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VirtualCenterMonitorInfoV2"}},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v2/ad-domains":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to AD Domains of the environment.","operationId":"listADDomainMonitorInfosV2","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ADDomainMonitorInfoV2"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v2/connection-servers":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Connection Servers of the environment.","operationId":"listConnectionServerMonitorsV2","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ConnectionServerMonitorInfoV2"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v2/connection-servers/{id}":{"get":{"tags":["Monitor"],"summary":"Gets monitoring information related to Connection Server.","operationId":"getConnectionServerMonitorInfoV3","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConnectionServerMonitorInfoV3"}},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v2/gateways":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Gateways registered in the environment.","operationId":"listGatewayMonitorInfoV2","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/GatewayMonitorInfoV2"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v2/gateways/{id}":{"get":{"tags":["Monitor"],"summary":"Gets monitoring information related to a Gateway.","operationId":"getGatewayMonitorInfoV2","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GatewayMonitorInfoV3"}},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v2/pods":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to the remote pods.","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","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PodMonitorInfoV2"}}},"401":{"description":"User is not authenticated"},"403":{"description":"Access to the resource is forbidden"},"409":{"description":"Conflict | CPA not initialized for the pod"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v2/saml-authenticators":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to SAML Authenticators of the environment.","operationId":"listSAMLAuthenticatorMonitorsV2","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SAMLAuthenticatorMonitorInfoV2"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v2/view-composers":{"get":{"tags":["Monitor"],"summary":"View Composer is no longer supported from Horizon version 2012 onwards.","operationId":"listViewComposerMonitorsV2","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ViewComposerMonitorInfoV2"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":true}},"/monitor/v2/virtual-centers":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Virtual Centers of the environment.","operationId":"listVirtualCenterMonitorsV2","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VirtualCenterMonitorInfoV2"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v3/ad-domains":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to AD Domains of the environment.","operationId":"listADDomainMonitorInfosV3","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ADDomainMonitorInfoV3"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v3/connection-servers":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Connection Servers of the environment.","operationId":"listConnectionServerMonitorsV3","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ConnectionServerMonitorInfoV3"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v3/gateways":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Gateways registered in the environment.","operationId":"listGatewayMonitorInfoV3","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/GatewayMonitorInfoV3"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/view-composers":{"get":{"tags":["Monitor"],"summary":"View Composer is no longer supported from Horizon version 2012 onwards.","operationId":"listViewComposerMonitorsV1","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ViewComposerMonitorInfo"}}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":true}},"/monitor/virtual-centers":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Virtual Centers of the environment.","operationId":"listVirtualCenterMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VirtualCenterMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/refresh":{"post":{"tags":["Auth"],"summary":"Refreshes access token from refresh token.","operationId":"refreshAccessToken","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Refresh token needed to generate new Access Token","required":true,"schema":{"$ref":"#/definitions/RefreshToken"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AccessToken"}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"deprecated":false}}},"securityDefinitions":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"ADContainerInfo":{"type":"object","properties":{"rdn":{"type":"string","example":"CN=ComPartitions,CN=System","description":"The rdn of the active directory container, relative to the root of the domain."}},"title":"ADContainerInfo","description":"Information about an active directory container."},"ADDomainAdvancedSettings":{"type":"object","required":["ad_domain_context","port"],"properties":{"ad_domain_auto_discovery":{"type":"boolean","example":true,"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."},"ad_domain_context":{"type":"string","example":"dc=abc,dc=com","description":"Active directory domain Context."},"ad_domain_controllers":{"type":"array","example":["example.com","example1.com"],"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.","items":{"type":"string"}},"ad_domain_preferred_site":{"type":"string","example":"Bengaluru","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."},"port":{"type":"integer","format":"int32","example":389,"description":"Port of the server to connect to."}},"title":"ADDomainAdvancedSettings","description":"Information related to untrusted Domain advance settings."},"ADDomainAdvancedSettingsInfo":{"type":"object","properties":{"ad_domain_auto_discovery":{"type":"boolean","example":true,"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."},"ad_domain_context":{"type":"string","example":"dc=abc,dc=com","description":"Active directory domain Context."},"ad_domain_controllers":{"type":"array","example":"example.com","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.","items":{"type":"string"}},"ad_domain_preferred_site":{"type":"string","example":"Bengaluru","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."},"port":{"type":"integer","format":"int32","example":389,"description":"Port of the server to connect to."}},"title":"ADDomainAdvancedSettingsInfo","description":"Information related to untrusted Domain advance settings."},"ADDomainAuxiliaryAccountCreateSpec":{"type":"object","required":["auxiliary_accounts"],"properties":{"auxiliary_accounts":{"type":"array","description":"Auxiliary service account credentials.","items":{"$ref":"#/definitions/ADDomainServiceAccountSpec"}}},"title":"ADDomainAuxiliaryAccountCreateSpec","description":"Specification to create ADDomain auxiliary accounts"},"ADDomainAuxiliaryAccountDeleteSpec":{"type":"object","required":["auxiliary_account_ids"],"properties":{"auxiliary_account_ids":{"type":"array","description":"Auxiliary account ID's.","items":{"type":"string"}}},"title":"ADDomainAuxiliaryAccountDeleteSpec","description":"Specification to delete auxiliary accounts from untrusted domain."},"ADDomainAuxiliaryAccountUpdateSpec":{"type":"object","required":["auxiliary_accounts"],"properties":{"auxiliary_accounts":{"type":"array","description":"Auxiliary service account credentials.","items":{"$ref":"#/definitions/AuxiliaryAccountUpdateData"}}},"title":"ADDomainAuxiliaryAccountUpdateSpec","description":"Specification to update auxiliary accounts of untrusted domain"},"ADDomainAuxiliaryServiceAccountInfo":{"type":"object","properties":{"id":{"type":"string","example":"554c9fc8-d948-4fbb-9612-69cd640191e6_user1","description":"Unique SID representing auxiliary account."},"username":{"type":"string","example":"Administrator","description":"Service account username."}},"title":"ADDomainAuxiliaryServiceAccountInfo","description":"Information related to auxiliary service accounts of untrusted domain."},"ADDomainBindInfo":{"type":"object","properties":{"id":{"type":"string","example":"S-1-5-21-3861703653-2745738756-3849765893","description":"Unique ID representing the AD domain."}},"title":"ADDomainBindInfo","description":"ADDomain bind response."},"ADDomainInfo":{"type":"object","properties":{"dns_name":{"type":"string","example":"example.com","description":"DNS name of the AD Domain."},"id":{"type":"string","example":"S-1-5-21-1085031214-1563985344-725345543","description":"Unique SID representing AD Domain."},"netbios_name":{"type":"string","example":"AD-EXAMPLE1","description":"NetBIOS name of the AD Domain."}},"title":"ADDomainInfo","description":"Information related to AD Domains of the environment."},"ADDomainInfoV2":{"type":"object","properties":{"ad_domain_advanced_settings":{"description":"Advanced information of untrusted domain.","$ref":"#/definitions/ADDomainAdvancedSettingsInfo"},"dns_name":{"type":"string","example":"example.com","description":"DNS name of the AD Domain."},"domain_type":{"type":"string","example":"CONNECTION_SERVER_DOMAIN","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.","enum":["CONNECTION_SERVER_DOMAIN","NO_TRUST_DOMAIN"]},"id":{"type":"string","example":"S-1-5-21-1085031214-1563985344-725345543","description":"Unique SID representing AD Domain."},"netbios_name":{"type":"string","example":"AD-EXAMPLE1","description":"NetBIOS name of the AD Domain."},"primary_account":{"description":"Primary service account credentials.","$ref":"#/definitions/ADDomainPrimaryServiceAccountInfo"}},"title":"ADDomainInfoV2","description":"Information related to AD Domains of the environment."},"ADDomainInfoV3":{"type":"object","properties":{"ad_domain_advanced_settings":{"description":"Advanced information of untrusted domain.","$ref":"#/definitions/ADDomainAdvancedSettingsInfo"},"auxiliary_accounts":{"type":"array","description":"Auxiliary service accounts information of untrusted domain.","items":{"$ref":"#/definitions/ADDomainAuxiliaryServiceAccountInfo"}},"dns_name":{"type":"string","example":"example.com","description":"DNS name of the AD Domain."},"domain_type":{"type":"string","example":"CONNECTION_SERVER_DOMAIN","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.","enum":["CONNECTION_SERVER_DOMAIN","NO_TRUST_DOMAIN"]},"id":{"type":"string","example":"S-1-5-21-1085031214-1563985344-725345543","description":"Unique SID representing AD Domain."},"netbios_name":{"type":"string","example":"AD-EXAMPLE1","description":"NetBIOS name of the AD Domain."},"primary_account":{"description":"Primary service account credentials.","$ref":"#/definitions/ADDomainPrimaryServiceAccountInfo"}},"title":"ADDomainInfoV3","description":"Information related to AD Domains of the environment."},"ADDomainMonitorConnectionServer":{"type":"object","properties":{"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the connection server."},"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"FULLY_ACCESSIBLE","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.","enum":["UNCONTACTABLE","FULLY_ACCESSIBLE","CANNOT_BIND","UNKNOWN"]},"trust_relationship":{"type":"string","example":"TWO_WAY","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.","enum":["PRIMARY_DOMAIN","FROM_BROKER","TO_BROKER","TWO_WAY","TWO_WAY_FOREST","MANUAL","NOTRUST","UNKNOWN"]}},"title":"ADDomainMonitorConnectionServer","description":"Information about the AD Domain connection from connection server."},"ADDomainMonitorConnectionServerV2":{"type":"object","properties":{"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the connection server."},"last_updated_timestamp":{"type":"integer","format":"int64","example":1582029025748,"description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time."},"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"FULLY_ACCESSIBLE","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.","enum":["UNCONTACTABLE","FULLY_ACCESSIBLE","CANNOT_BIND","UNKNOWN"]},"trust_relationship":{"type":"string","example":"TWO_WAY","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.","enum":["PRIMARY_DOMAIN","FROM_BROKER","TO_BROKER","TWO_WAY","TWO_WAY_FOREST","MANUAL","NOTRUST","UNKNOWN"]}},"title":"ADDomainMonitorConnectionServerV2","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":"#/definitions/ADDomainMonitorConnectionServer"}},"dns_name":{"type":"string","example":"ad-example1.example.com","description":"The DNS name for the domain."},"netbios_name":{"type":"string","example":"AD-EXAMPLE1","description":"The NetBIOS name for the domain."},"nt4_domain":{"type":"boolean","example":true,"description":"If this is an NT4 domain or not."}},"title":"ADDomainMonitorInfo","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":"#/definitions/ADDomainMonitorConnectionServerV2"}},"dns_name":{"type":"string","example":"ad-example1.example.com","description":"The DNS name for the domain."},"netbios_name":{"type":"string","example":"AD-EXAMPLE1","description":"The NetBIOS name for the domain."},"nt4_domain":{"type":"boolean","example":true,"description":"If this is an NT4 domain or not."}},"title":"ADDomainMonitorInfoV2","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":"#/definitions/ADDomainMonitorConnectionServerV2"}},"dns_name":{"type":"string","example":"ad-example1.example.com","description":"The DNS name for the domain."},"domain_type":{"type":"string","example":"CONNECTION_SERVER_DOMAIN","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.","enum":["CONNECTION_SERVER_DOMAIN","NO_TRUST_DOMAIN"]},"netbios_name":{"type":"string","example":"AD-EXAMPLE1","description":"The NetBIOS name for the domain."},"nt4_domain":{"type":"boolean","example":true,"description":"If this is an NT4 domain or not."},"service_accounts":{"type":"array","description":"Service accounts for the domain.","items":{"$ref":"#/definitions/ServiceAccount"}}},"title":"ADDomainMonitorInfoV3","description":"Monitoring information related to AD Domain."},"ADDomainPrimaryServiceAccountInfo":{"type":"object","properties":{"username":{"type":"string","example":"Administrator","description":"Service account username."}},"title":"ADDomainPrimaryServiceAccountInfo","description":"Information related to untrusted Domain service accounts."},"ADDomainServiceAccountSpec":{"type":"object","required":["password","username"],"properties":{"password":{"type":"array","example":"","description":"Service account user password.","items":{"type":"string"}},"username":{"type":"string","example":"Administrator","description":"Service account username."}},"title":"ADDomainServiceAccountSpec","description":"Information related to untrusted Domain service accounts."},"ADDomainSpec":{"type":"object","required":["ad_domain_advanced_settings","dns_name","netbios_name","primary_account"],"properties":{"ad_domain_advanced_settings":{"description":"Advanced information of untrusted domain.","$ref":"#/definitions/ADDomainAdvancedSettings"},"dns_name":{"type":"string","example":"example.com","description":"The DNS name of the domain."},"netbios_name":{"type":"string","example":"EXAMPLE","description":"The NetBIOS name of the domain."},"primary_account":{"description":"Primary service account credentials.","$ref":"#/definitions/ADDomainServiceAccountSpec"}},"title":"ADDomainSpec","description":"Specification of ADDomain"},"ADDomainUpdateSpec":{"type":"object","required":["ad_domain_advanced_settings","primary_account"],"properties":{"ad_domain_advanced_settings":{"description":"Advanced information of untrusted domain.","$ref":"#/definitions/ADDomainAdvancedSettings"},"primary_account":{"description":"Primary service account credentials.","$ref":"#/definitions/ADDomainServiceAccountSpec"}},"title":"ADDomainUpdateSpec","description":"Specification of ADDomain"},"ADUserChangePasswordSpec":{"type":"object","required":["key_id","new_encrypted_password","old_encrypted_password","protected_password_key","username"],"properties":{"domain":{"type":"string","example":"example.com","description":"The domain of user. Note that domain is optional if UPN is supplied."},"key_id":{"type":"string","example":"ut0yGq7CbhtBUGfW3ngjkvjQ2cc=","description":"The keyId of the cluster's SSO KeyPair used to encrypt the password key."},"new_encrypted_password":{"type":"string","example":"4TGdfggfwrrGUPSg4/JK/tYub7lUI8pGtyHd/ty5g8h5=","description":"New password for the user in encrypted format."},"old_encrypted_password":{"type":"string","example":"9QYxpdXrcrOGPSSz1/K/pJu8QlYT7pDkaKg/rb3hlw4=","description":"Old password for the user in encrypted format."},"protected_password_key":{"type":"string","example":"Qvvjglg5iZinyuldroueo/hQFyqydMMDJPmfYGgIebqxbU9chJ9I8iM9SCBRHSkSW9y+RMQOfC","description":"Decryption key for the password. This key is itself encrypted with cluster's SSO keypair."},"username":{"type":"string","example":"testuser or testuser@example.com","description":"The username or UPN."}},"title":"ADUserChangePasswordSpec","description":"Specification for changing AD user's password."},"ADUserEncryptedCredentialSpec":{"type":"object","required":["encrypted_password","key_id","protected_password_key","username"],"properties":{"domain":{"type":"string","example":"example.com","description":"The domain of user. Note that domain is optional if UPN is supplied."},"encrypted_password":{"type":"string","example":"9QYxpdXrcrOGPSSz1/K/pJu8QlYT7pDkaKg/rb3hlw4=","description":"Encrypted password for the user."},"key_id":{"type":"string","example":"ut0yGq7CbhtBUGfW3ngjkvjQ2cc=","description":"The keyId of the cluster's SSO KeyPair used to encrypt the protectedPasswordKey."},"protected_password_key":{"type":"string","example":"Qvvjglg5iZinyuldroueo/hQFyqydMMDJPmfYGgIebqxbU9chJ9I8iM9SCBRHSkSW9y+RM","description":"Decryption key for the password. This key is itself encrypted with cluster's SSO keypair."},"username":{"type":"string","example":"testuser or testuser@example.com","description":"The username or UPN."}},"title":"ADUserEncryptedCredentialSpec","description":"Specification for validating AD user's encrypted credentials."},"ADUserInfo":{"type":"object","properties":{"domain":{"type":"string","example":"example.com","description":"DNS name of the domain in which this user or group belongs to."},"group_guids":{"type":"array","example":["5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA", "6H8S6Y4-35D3-6534-5ERC-A678E3YG4FAD"],"description":"Guids of the user's groups in RFC 4122 format.","items":{"type":"string"}},"group_sids":{"type":"array","example":["S-1-5-21-544", "S-1-5-21-1111111111-2222222222-3333333333-513"],"description":"List of unique SIDs of the groups, this user or group belongs to.","items":{"type":"string"}},"user_guid":{"type":"string","example":"5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA","description":"GUID of the user in RFC 4122 format."},"user_principal_name":{"type":"string","example":"testuser@example.com","description":"User Principal name(UPN) of this user."},"user_sid":{"type":"string","example":"S-1-5-21-544","description":"Unique SID representing this AD User."},"username":{"type":"string","example":"testuser","description":"Username of this user."}},"title":"ADUserInfo","description":"Information related to AD User."},"ADUserOrGroupInfo":{"type":"object","properties":{"container":{"type":"string","example":"example.com/Users","description":"AD container for this user or group."},"description":{"type":"string","example":"Test User account","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'."},"display_name":{"type":"string","example":"example.com\\\\testuser","description":"Login name with domain of this user or group."},"distinguished_name":{"type":"string","example":"CN=Test User,CN=Users,DC=example,DC=com","description":"Active Directory distinguished name for this user or group."},"domain":{"type":"string","example":"example.com","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."},"email":{"type":"string","example":"testuser@example.com","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'."},"first_name":{"type":"string","example":"Test","description":"First name of this user or group."},"group":{"type":"boolean","example":false,"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."},"group_membership_ids":{"type":"array","example":["S-1-5-21-544", "S-1-5-21-1111111111-2222222222-3333333333-513"],"description":"List of unique SIDs of the groups, this user or group belongs to.","items":{"type":"string"}},"guid":{"type":"string","example":"5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA","description":"GUID of the user or group in RFC 4122 format.\nSupported Filters : 'Equals'."},"id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-500","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."},"kiosk_user":{"type":"boolean","example":false,"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."},"last_name":{"type":"string","example":"User","description":"Last name of this user or group."},"login_name":{"type":"string","example":"testuser","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'."},"long_display_name":{"type":"string","example":"testuser@example.com (Test User)","description":"Login name, domain and name for this user or group, else display name"},"name":{"type":"string","example":"Test User","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'."},"phone":{"type":"string","example":"1-877-486-9273","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'."},"sub_group_count":{"type":"integer","format":"int32","example":2,"description":"Number of subgroups in this group, or 0 if not a group."},"user_count":{"type":"integer","format":"int32","example":2,"description":"Number of users in this group, or 0 if not a group."},"user_display_name":{"type":"string","example":"Test User","description":"User or group's display name. This corresponds with displayName attribute in AD."},"user_principal_name":{"type":"string","example":"testuser@example.com","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'."}},"title":"ADUserOrGroupInfo","description":"Information related to AD User or Group."},"ADUserOrGroupSummary":{"type":"object","properties":{"container":{"type":"string","example":"example.com/Users","description":"AD container for this user or group."},"description":{"type":"string","example":"Test User account","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'."},"display_name":{"type":"string","example":"example.com\\\\testuser","description":"Login name with domain of this user or group."},"distinguished_name":{"type":"string","example":"CN=Test User,CN=Users,DC=example,DC=com","description":"Active Directory distinguished name for this user or group."},"domain":{"type":"string","example":"example.com","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."},"email":{"type":"string","example":"testuser@example.com","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'."},"first_name":{"type":"string","example":"Test","description":"First name of this user or group."},"group":{"type":"boolean","example":false,"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."},"guid":{"type":"string","example":"5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA","description":"GUID of the user or group in RFC 4122 format.\nSupported Filters : 'Equals'."},"id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-500","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."},"kiosk_user":{"type":"boolean","example":false,"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."},"last_name":{"type":"string","example":"User","description":"Last name of this user or group."},"login_name":{"type":"string","example":"testuser","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'."},"long_display_name":{"type":"string","example":"testuser@example.com (Test User)","description":"Login name, domain and name for this user or group, else display name"},"name":{"type":"string","example":"Test User","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'."},"phone":{"type":"string","example":"1-877-486-9273","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'."},"user_display_name":{"type":"string","example":"Test User","description":"User or group's display name. This corresponds with displayName attribute in AD."},"user_principal_name":{"type":"string","example":"testuser@example.com","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'."}},"title":"ADUserOrGroupSummary","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","example":"inventory.machine.not.found","description":"Error key configured in message bundle."},"error_message":{"type":"string","example":"username cannot be empty","description":"Error message translated in user's locale."}},"title":"APIError","description":"Response for each API which results in error.
Contains a unique error key and localised version of error message."},"AccessToken":{"type":"object","properties":{"access_token":{"type":"string","example":"","description":"Access Token to be used in API calls."}},"title":"AccessToken","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":"#/definitions/AdminUserOrGroupPrivilegesInfo"}},"help_desk_admin":{"type":"boolean"},"id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-500","description":"Unique SID representing the admin user or group."},"local_privileges_info":{"type":"array","description":"Set of privileges information based on local access groups for this user or group.","items":{"$ref":"#/definitions/AdminUserOrGroupPrivilegesInfo"}}},"title":"AdminUserOrGroupPermissionsInfo","description":"Information about admin user or group permissions."},"AdminUserOrGroupPreferencesInfo":{"type":"object","properties":{"admin_timeout_in_minutes":{"type":"integer","format":"int32","example":400,"description":"UI console session timeout preference in minutes for Horizon Console."},"grid_preferences":{"type":"object","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.","additionalProperties":{"type":"array","items":{"type":"string"}}}},"title":"AdminUserOrGroupPreferencesInfo","description":"Preferences for administrators of Horizon Console."},"AdminUserOrGroupPreferencesUpdateSpec":{"type":"object","properties":{"admin_timeout_in_minutes":{"type":"integer","format":"int32","example":400,"description":"UI console session timeout preference in minutes for Horizon Console."},"grid_preferences":{"type":"object","example":{ "desktopsListing": ["DisplayName", "Type"]},"description":"Grid preferences for data grids on Horizon Console.","additionalProperties":{"type":"array","items":{"type":"string"}}}},"title":"AdminUserOrGroupPreferencesUpdateSpec","description":"Information required to update Horizon Console administrator preferences."},"AdminUserOrGroupPrivilegesInfo":{"type":"object","properties":{"access_group_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"ID of the access group."},"access_group_name":{"type":"string","example":"root","description":"Name of the access group."},"privileges":{"type":"array","example":["VC_CONFIG_VIEW", "FEDERATED_LDAP_MANAGE","GLOBAL_CONFIG_MANAGEMENT"],"description":"The set of privileges on the access group.","items":{"type":"string","enum":["ADMINISTRATOR","ADMINISTRATOR_VIEW","VC_CONFIG_VIEW","LOG_COLLECTION","FORENSICS","MANAGE_CERTIFICATES","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_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","UNKNOWN_PRIVILEGE"]}}},"title":"AdminUserOrGroupPrivilegesInfo","description":"Information about admin user or group privileges."},"AgentInstallerPackageInfo":{"type":"object","properties":{"build_number":{"type":"string","example":12345678,"description":"Build number of the installer."},"id":{"type":"string","example":"087ae070-602e-4498-b67c-d7f5807ab5e4","description":"Unique identifier for this agent installer package."},"url":{"type":"string","example":"https://example.com/build.exe","description":"URL of the installer executable."},"version":{"type":"string","example":"8.5.0","description":"Version of the installer MSI."}},"title":"AgentInstallerPackageInfo","description":"Information about a registered agent installer package."},"AgentInstallerPackageRegisterResponseInfo":{"type":"object","properties":{"agent_installer_package_id":{"type":"string","example":"d49e4ffa-2238-4bc7-a292-539b2ea96548","description":"Id of the installer registered."}},"title":"AgentInstallerPackageRegisterResponseInfo","description":"Response for agent installer package register operation."},"AgentInstallerPackageRegisterSpec":{"type":"object","required":["metadata_file_url"],"properties":{"metadata_file_url":{"type":"string","example":"https://example.com/metadata.json","description":"URL of the metadata file concerning the agent installer package which is to be registered."}},"title":"AgentInstallerPackageRegisterSpec","description":"Information required to register an agent installer package."},"AgentUpgradeTaskInfo":{"type":"object","properties":{"agent_installer_package_id":{"type":"string","example":"2b6eaeb8-2e91-11ed-a261-0242ac120002","description":"ID of the agent installer package."},"cancelled_machine_or_rds_server_ids":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe", "7cdd624f-37d1-46c1-ab96-695a5d13956f"],"description":"Machines or RDS servers for which upgrade has been cancelled.","items":{"type":"string"}},"end_time":{"type":"integer","format":"int64","example":1652079610000,"description":"Agent upgrade end time."},"failed_machine_or_rds_server_ids":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe", "7cdd624f-37d1-46c1-ab96-695a5d13956f"],"description":"Machines or RDS servers for which upgrade has failed.","items":{"type":"string"}},"id":{"type":"string","example":"16c2faaa-2e8c-11ed-a261-0242ac120002","description":"Task ID of the agent upgrade."},"in_progress_machine_or_rds_server_ids":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe", "7cdd624f-37d1-46c1-ab96-695a5d13956f"],"description":"Machines or RDS servers for which upgrade are in progress.","items":{"type":"string"}},"not_started_machine_or_rds_server_ids":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe", "7cdd624f-37d1-46c1-ab96-695a5d13956f"],"description":"Machines or RDS servers for which upgrade has not started.","items":{"type":"string"}},"operation":{"type":"string","example":"SCHEDULED","description":"The current agent upgrade task operation."},"skipped_machine_or_rds_server_ids":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe", "7cdd624f-37d1-46c1-ab96-695a5d13956f"],"description":"Machines or RDS servers for which upgrade has skipped.","items":{"type":"string"}},"start_time":{"type":"integer","format":"int64","example":1652079610000,"description":"Agent upgrade start time."},"state":{"type":"string","description":"The state of an agent upgrade task."},"succeeded_machine_or_rds_server_ids":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe", "7cdd624f-37d1-46c1-ab96-695a5d13956f"],"description":"Machines or RDS servers for which upgrade has succeeded.","items":{"type":"string"}}},"title":"AgentUpgradeTaskInfo"},"AgentUpgradeTaskResponseInfo":{"type":"object","properties":{"details":{"type":"array","description":"List of BulkItemResponseInfo corresponding to each machine id in the action operation.","items":{"$ref":"#/definitions/BulkItemResponseInfo"}},"task_id":{"type":"string","example":"7d01dc94-2e93-11ed-a261-0242ac120002","description":"Unique ID representing the task."}},"title":"AgentUpgradeTaskResponseInfo"},"AndFilter":{"title":"AndFilter","allOf":[{"$ref":"#/definitions/BaseFilter"},{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/definitions/BaseFilter"}},"type":{"type":"string","enum":["And","Or","Not","NotEquals","Equals","Contains","StartsWith","EndsWith","Between"]}},"title":"AndFilter"}]},"AppVolumesApplicationInfo":{"type":"object","properties":{"avm_shortcut_id":{"type":"string","example":1,"description":"Shortcut ID of AVM managed application."},"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable."},"file_types":{"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":"#/definitions/ApplicationFileTypeData"}},"name":{"type":"string","example":"Firefox","description":"Application name information, as sent by RDSServer/machine during application discovery."},"other_file_types":{"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":"#/definitions/ApplicationOtherFileTypeData"}},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher"},"version":{"type":"string","example":"72.0.2","description":"Application version."}},"title":"AppVolumesApplicationInfo","description":"Information about the application available in App volumes Manager."},"AppVolumesManagerCreateSpec":{"type":"object","required":["password","server_name","username"],"properties":{"password":{"type":"array","example":"","description":"Password of the account.","items":{"type":"string"}},"port":{"type":"integer","format":"int32","example":443,"description":"Port of the App Volumes manager to connect to."},"server_name":{"type":"string","example":"avm.example.com","description":"App Volumes Manager's server name or IP address."},"username":{"type":"string","example":"administrator","description":"Username to login to App Volumes Manager"}},"title":"AppVolumesManagerCreateSpec","description":"Information required to add App Volumes Manager."},"AppVolumesManagerInfo":{"type":"object","properties":{"id":{"type":"string","example":"625bdb01-7c4f-423e-a9b8-a2256c21447d","description":"Unique Id of the App Volumes Manager."},"port":{"type":"integer","format":"int32","example":443,"description":"Port of the App Volumes Manager to connect to."},"server_name":{"type":"string","example":"avm.example.com","description":"App Volumes Manager's server name or IP address."},"username":{"type":"string","example":"administrator","description":"Username to login to App Volumes Manager."}},"title":"AppVolumesManagerInfo","description":"Information about App Volumes Manager."},"AppVolumesManagerMonitorConnectionServer":{"type":"object","properties":{"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"OK","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.","enum":["ERROR","OK"]}},"title":"AppVolumesManagerMonitorConnectionServer","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":"#/definitions/AppVolumesManagerMonitorConnectionServer"}},"description":{"type":"string","example":"SUCCESS","description":"App volumes Manager Connection description.\n* SUCCESS: No problem detected.\n* PROBLEM: Problem detected in connecting to App Volumes Manager.","enum":["SUCCESS","PROBLEM"]},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID of the App volumes Manager."},"status":{"type":"string","example":"OK","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.","enum":["ERROR","OK"]},"url":{"type":"string","example":"avm.example.com","description":"App volumes Manager url."},"version":{"type":"string","example":"App Volumes 4, version 2209 (4.9.0.2996)","description":"App volumes Manager version."}},"title":"AppVolumesManagerMonitorInfo","description":"Monitoring information related to App volumes Manager registered in the environment."},"AppVolumesManagerUpdateSpec":{"type":"object","required":["password","server_name","username"],"properties":{"password":{"type":"array","example":"","description":"Password of the account.","items":{"type":"string"}},"port":{"type":"integer","format":"int32","example":443,"description":"Port of the app volumes manager to connect to."},"server_name":{"type":"string","example":"avm.example.com","description":"App Volumes Manager's server name or IP address."},"username":{"type":"string","example":"administrator","description":"Username to login to App Volumes Manager"}},"title":"AppVolumesManagerUpdateSpec","description":"Information required to update App Volumes Manager."},"ApplicationAntiAffinityData":{"type":"object","required":["anti_affinity_count","anti_affinity_patterns"],"properties":{"anti_affinity_count":{"type":"integer","format":"int32","example":10,"description":"Maximum number of other applications that can be running on the RDS Server before the RDS Server is rejected for new application sessions."},"anti_affinity_patterns":{"type":"array","example":["*pad.exe", "*notepad.???"],"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.
Pattern strings may contain wildcard characters. '*' matches zero or more characters. '?' matches exactly one character.","items":{"type":"string"}}},"title":"ApplicationAntiAffinityData","description":"Anti-affinity data required to create an application pool."},"ApplicationData":{"type":"object","properties":{"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable."},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher."},"version":{"type":"string","example":"72.0.2","description":"Application version."}},"title":"ApplicationData","description":"Information about Application."},"ApplicationFileTypeData":{"type":"object","required":["type"],"properties":{"description":{"type":"string","example":"Firefox Document","description":"Friendly name for the file type. If unset, no friendly name will be displayed."},"type":{"type":"string","example":".html","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."}},"title":"ApplicationFileTypeData","description":"Information about the file type supported by the application."},"ApplicationIconAssociateSpec":{"type":"object","required":["icon_id"],"properties":{"icon_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing an application icon."}},"title":"ApplicationIconAssociateSpec"},"ApplicationIconCreateSpec":{"type":"object","required":["data","height","width"],"properties":{"data":{"type":"string","format":"byte","description":"Icon image data in PNG format. This is the Base64 encoded binary data of the image."},"height":{"type":"integer","format":"int64","example":16,"description":"Icon height.","minimum":16,"maximum":256,"exclusiveMinimum":false,"exclusiveMaximum":false},"width":{"type":"integer","format":"int64","example":16,"description":"Icon width.","minimum":16,"maximum":256,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"ApplicationIconCreateSpec","description":"Information required to create an Application icon."},"ApplicationIconInfo":{"type":"object","properties":{"application_pool_ids":{"type":"array","example":["855ea6c5-720a-41e1-96f4-958c90e6e424","1453c2a3-e549-4301-af12-d62210d18d54"],"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.
","items":{"type":"string"}},"data":{"type":"string","format":"byte","description":"Icon image data in PNG format."},"height":{"type":"integer","format":"int32","example":16,"description":"Icon height."},"icon_hash":{"type":"string","example":"13a5d8a8410445b51edf45b6eee2cd8d","description":"MD5 hash of icon image data, to enable quick icon lookup."},"icon_source":{"type":"string","example":"HORIZON_AGENT","description":"Source of the application icon. The icon can be from Machine/RDS Agent or custom icon.\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.","enum":["HORIZON_AGENT","HORIZON_CONNECTION_SERVER"]},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing application icon."},"width":{"type":"integer","format":"int32","example":16,"description":"Icon width."}},"title":"ApplicationIconInfo","description":"Application icon information."},"ApplicationOtherFileTypeData":{"type":"object","required":["name","type"],"properties":{"description":{"type":"string","example":"Firefox URL","description":"Friendly name for the file type. If unset, no friendly name will be displayed."},"name":{"type":"string","example":"https","description":"The name for other file type data."},"type":{"type":"string","example":"URL","description":"Other file type currently supported.\n* URL: URL scheme types supported by application.\n* OTHER: Other scheme types supported by application.","enum":["URL","OTHER"]}},"title":"ApplicationOtherFileTypeData","description":"Information about different file types supported by Application that can be passed from agent to client via Connection Server."},"ApplicationPoolCreateSpec":{"type":"object","required":["executable_path","name"],"properties":{"anti_affinity_data":{"description":"Configure to enable anti-affinity rules. When an anti-affinity rule is configured for an application pool, Horizon Connection Server attempts to launch the application only on RDS servers that have sufficient resources to run the application. This feature can be useful for controlling applications that consume large amounts of CPU or memory resources.
An anti-affinity rule consists of an application matching pattern and a maximum count. For example, the application matching pattern might be autocad.exe and the maximum count might be 2.","$ref":"#/definitions/ApplicationAntiAffinityData"},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"description":{"type":"string","description":"Notes about the application pool."},"desktop_pool_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","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."},"display_name":{"type":"string","example":"Firefox","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."},"enable_client_restrictions":{"type":"boolean","example":false,"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."},"enable_pre_launch":{"type":"boolean","example":false,"description":"Whether to pre-launch the application. Default value is false."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the application pool is enabled. Default value is true"},"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","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."},"max_multi_sessions":{"type":"integer","format":"int32","example":5,"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."},"multi_session_mode":{"type":"string","example":"DISABLED","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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","example":"Firefox","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."},"parameters":{"type":"string","example":"-p myprofile","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher"},"shortcut_locations":{"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","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"description":"Supported file types details.","$ref":"#/definitions/ApplicationSupportedFileTypesData"},"version":{"type":"string","example":"72.0.2","description":"Application version."}},"title":"ApplicationPoolCreateSpec","description":"Information required to create an application pool."},"ApplicationPoolCreateSpecV2":{"type":"object","required":["executable_path","name"],"properties":{"anti_affinity_data":{"description":"Configure to enable anti-affinity rules. When an anti-affinity rule is configured for an application pool, Horizon Connection Server attempts to launch the application only on RDS servers that have sufficient resources to run the application. This feature can be useful for controlling applications that consume large amounts of CPU or memory resources.
An anti-affinity rule consists of an application matching pattern and a maximum count. For example, the application matching pattern might be autocad.exe and the maximum count might be 2.","$ref":"#/definitions/ApplicationAntiAffinityData"},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_brokered":{"type":"boolean","example":false,"description":"Indicates whether the application pool is cloud brokered. Default value is false.
"},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"description":{"type":"string","description":"Notes about the application pool."},"desktop_pool_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","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."},"display_name":{"type":"string","example":"Firefox","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."},"enable_client_restrictions":{"type":"boolean","example":false,"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."},"enable_pre_launch":{"type":"boolean","example":false,"description":"Whether to pre-launch the application. Default value is false."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the application pool is enabled. Default value is true"},"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","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."},"max_multi_sessions":{"type":"integer","format":"int32","example":5,"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."},"multi_session_mode":{"type":"string","example":"DISABLED","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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","example":"Firefox","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."},"parameters":{"type":"string","example":"-p myprofile","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher"},"shortcut_locations":{"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","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"description":"Supported file types details.","$ref":"#/definitions/ApplicationSupportedFileTypesData"},"version":{"type":"string","example":"72.0.2","description":"Application version."}},"title":"ApplicationPoolCreateSpecV2","description":"Information required to create an application pool."},"ApplicationPoolCreateSpecV3":{"type":"object","required":["executable_path","name"],"properties":{"anti_affinity_data":{"description":"Configure to enable anti-affinity rules. When an anti-affinity rule is configured for an application pool, Horizon Connection Server attempts to launch the application only on RDS servers that have sufficient resources to run the application. This feature can be useful for controlling applications that consume large amounts of CPU or memory resources.
An anti-affinity rule consists of an application matching pattern and a maximum count. For example, the application matching pattern might be autocad.exe and the maximum count might be 2.","$ref":"#/definitions/ApplicationAntiAffinityData"},"avm_shortcut_id":{"type":"string","example":1,"description":"Shortcut ID of AVM managed application."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_brokered":{"type":"boolean","example":false,"description":"Indicates whether the application pool is cloud brokered. Default value is false.
"},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"description":{"type":"string","description":"Notes about the application pool."},"desktop_pool_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","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."},"display_name":{"type":"string","example":"Firefox","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."},"enable_client_restrictions":{"type":"boolean","example":false,"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."},"enable_pre_launch":{"type":"boolean","example":false,"description":"Whether to pre-launch the application. Default value is false."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the application pool is enabled. Default value is true"},"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","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."},"max_multi_sessions":{"type":"integer","format":"int32","example":5,"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."},"multi_session_mode":{"type":"string","example":"DISABLED","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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","example":"Firefox","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."},"parameters":{"type":"string","example":"-p myprofile","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher"},"shortcut_locations":{"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","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"description":"Supported file types details.","$ref":"#/definitions/ApplicationSupportedFileTypesData"},"version":{"type":"string","example":"72.0.2","description":"Application version."}},"title":"ApplicationPoolCreateSpecV3","description":"Information required to create an application pool."},"ApplicationPoolInfo":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","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.
Supported Filters: 'Equals'."},"anti_affinity_data":{"description":"Anti-affinity data. When an anti-affinity rule is configured for an application pool, Horizon Connection Server attempts to launch the application only on RDS servers that have sufficient resources to run the application. This feature can be useful for controlling applications that consume large amounts of CPU or memory resources.
An anti-affinity rule consists of an application matching pattern and a maximum count. For example, the application matching pattern might be autocad.exe and the maximum count might be 2.","$ref":"#/definitions/ApplicationAntiAffinityData"},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"customized_icon_ids":{"type":"array","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26", "b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"description":"List of customized icon IDs associated with the application which the user has configured.","items":{"type":"string"}},"description":{"type":"string","description":"Notes about the application pool.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"desktop_pool_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.
Supported Filters: 'Equals'."},"display_name":{"type":"string","example":"Firefox","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.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.
Supported Filters: 'Equals'."},"enable_pre_launch":{"type":"boolean","example":false,"description":"Whether to pre-launch the application.
Supported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the application pool is enabled.
Supported Filters: 'Equals'."},"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable.
Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.
Supported Filters: 'Equals'."},"icon_ids":{"type":"array","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac", "920b7766-87b4-4712-9dac-1e7afcba28a6"],"description":"List of icon IDs associated with the application which are fetched from the agent.","items":{"type":"string"}},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing application pool.
Supported Filters: 'Equals'."},"max_multi_sessions":{"type":"integer","format":"int32","example":5,"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\""},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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.
Supported Filters: 'Equals'.\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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","example":"Firefox","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.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"shortcut_locations":{"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","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application."},"supported_file_types_data":{"description":"Supported file types details.","$ref":"#/definitions/ApplicationSupportedFileTypesData"},"version":{"type":"string","example":"72.0.2","description":"Application version.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."}},"title":"ApplicationPoolInfo","description":"Application pool information.
List API returning this summary information can use search filter query to filter on specific fields supported by filters.
Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"ApplicationPoolInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","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.
Supported Filters: 'Equals'."},"anti_affinity_data":{"description":"Anti-affinity data. When an anti-affinity rule is configured for an application pool, Horizon Connection Server attempts to launch the application only on RDS servers that have sufficient resources to run the application. This feature can be useful for controlling applications that consume large amounts of CPU or memory resources.
An anti-affinity rule consists of an application matching pattern and a maximum count. For example, the application matching pattern might be autocad.exe and the maximum count might be 2.","$ref":"#/definitions/ApplicationAntiAffinityData"},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"customized_icon_ids":{"type":"array","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26", "b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"description":"List of customized icon IDs associated with the application which the user has configured.","items":{"type":"string"}},"description":{"type":"string","description":"Notes about the application pool.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"desktop_pool_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.
Supported Filters: 'Equals'."},"display_name":{"type":"string","example":"Firefox","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.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.
Supported Filters: 'Equals'."},"enable_pre_launch":{"type":"boolean","example":false,"description":"Whether to pre-launch the application.
Supported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the application pool is enabled.
Supported Filters: 'Equals'."},"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable.
Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.
Supported Filters: 'Equals'."},"global_application_entitlement_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","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.
Supported Filters: 'Equals'."},"icon_ids":{"type":"array","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac", "920b7766-87b4-4712-9dac-1e7afcba28a6"],"description":"List of icon IDs associated with the application which are fetched from the agent.","items":{"type":"string"}},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing application pool.
Supported Filters: 'Equals'."},"max_multi_sessions":{"type":"integer","format":"int32","example":5,"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\""},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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.
Supported Filters: 'Equals'.\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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","example":"Firefox","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.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"shortcut_locations":{"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","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application."},"supported_file_types_data":{"description":"Supported file types details.","$ref":"#/definitions/ApplicationSupportedFileTypesData"},"version":{"type":"string","example":"72.0.2","description":"Application version.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."}},"title":"ApplicationPoolInfoV2","description":"Information related to Application Pool.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"ApplicationPoolInfoV3":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","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.
Supported Filters: 'Equals'."},"anti_affinity_data":{"description":"Anti-affinity data. When an anti-affinity rule is configured for an application pool, Horizon Connection Server attempts to launch the application only on RDS servers that have sufficient resources to run the application. This feature can be useful for controlling applications that consume large amounts of CPU or memory resources.
An anti-affinity rule consists of an application matching pattern and a maximum count. For example, the application matching pattern might be autocad.exe and the maximum count might be 2.","$ref":"#/definitions/ApplicationAntiAffinityData"},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_brokered":{"type":"boolean","example":false,"description":"Indicates whether the application pool is cloud brokered.
Supported Filters: 'Equals'."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"customized_icon_ids":{"type":"array","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26", "b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"description":"List of customized icon IDs associated with the application which the user has configured.","items":{"type":"string"}},"description":{"type":"string","description":"Notes about the application pool.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"desktop_pool_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.
Supported Filters: 'Equals'."},"display_name":{"type":"string","example":"Firefox","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.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.
Supported Filters: 'Equals'."},"enable_pre_launch":{"type":"boolean","example":false,"description":"Whether to pre-launch the application.
Supported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the application pool is enabled.
Supported Filters: 'Equals'."},"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable.
Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.
Supported Filters: 'Equals'."},"global_application_entitlement_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","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.
Supported Filters: 'Equals'."},"icon_ids":{"type":"array","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac", "920b7766-87b4-4712-9dac-1e7afcba28a6"],"description":"List of icon IDs associated with the application which are fetched from the agent.","items":{"type":"string"}},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing application pool.
Supported Filters: 'Equals'."},"max_multi_sessions":{"type":"integer","format":"int32","example":5,"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\""},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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.
Supported Filters: 'Equals'.\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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","example":"Firefox","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.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"shortcut_locations":{"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","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application."},"supported_file_types_data":{"description":"Supported file types details.","$ref":"#/definitions/ApplicationSupportedFileTypesData"},"version":{"type":"string","example":"72.0.2","description":"Application version.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."}},"title":"ApplicationPoolInfoV3","description":"Information related to Application Pool.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"ApplicationPoolInfoV4":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","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.
Supported Filters: 'Equals'."},"anti_affinity_data":{"description":"Anti-affinity data. When an anti-affinity rule is configured for an application pool, Horizon Connection Server attempts to launch the application only on RDS servers that have sufficient resources to run the application. This feature can be useful for controlling applications that consume large amounts of CPU or memory resources.
An anti-affinity rule consists of an application matching pattern and a maximum count. For example, the application matching pattern might be autocad.exe and the maximum count might be 2.","$ref":"#/definitions/ApplicationAntiAffinityData"},"avm_shortcut_id":{"type":"string","example":1,"description":"Shortcut ID of AVM managed application."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_brokered":{"type":"boolean","example":false,"description":"Indicates whether the application pool is cloud brokered.
Supported Filters: 'Equals'."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"customized_icon_ids":{"type":"array","example":["e8d7bf41-0fcd-477a-b7e0-1338b3868d26", "b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"],"description":"List of customized icon IDs associated with the application which the user has configured.","items":{"type":"string"}},"description":{"type":"string","description":"Notes about the application pool.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"desktop_pool_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"ID of the desktop pool from which this application pool is created. Either this or farm id will be set.
Supported Filters: 'Equals'."},"display_name":{"type":"string","example":"Firefox","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.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.
Supported Filters: 'Equals'."},"enable_pre_launch":{"type":"boolean","example":false,"description":"Whether to pre-launch the application.
Supported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the application pool is enabled.
Supported Filters: 'Equals'."},"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable.
Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"ID of the farm from which this application pool is created. Either this or desktop pool id will be set.
Supported Filters: 'Equals'."},"global_application_entitlement_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","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.
Supported Filters: 'Equals'."},"icon_ids":{"type":"array","example":["200fd5fd-26d6-490e-b023-509cbe19c0ac", "920b7766-87b4-4712-9dac-1e7afcba28a6"],"description":"List of icon IDs associated with the application which are fetched from the agent.","items":{"type":"string"}},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing application pool.
Supported Filters: 'Equals'."},"max_multi_sessions":{"type":"integer","format":"int32","example":5,"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\""},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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.
Supported Filters: 'Equals'.\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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"name":{"type":"string","example":"Firefox","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.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"parameters":{"type":"string","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"shortcut_locations":{"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","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application."},"supported_file_types_data":{"description":"Supported file types details.","$ref":"#/definitions/ApplicationSupportedFileTypesData"},"version":{"type":"string","example":"72.0.2","description":"Application version.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."}},"title":"ApplicationPoolInfoV4","description":"Information related to Application Pool.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"ApplicationPoolUpdateSpec":{"type":"object","required":["enable_pre_launch","enabled","executable_path","supported_file_types_data"],"properties":{"anti_affinity_data":{"description":"Configure to enable anti-affinity rules. When an anti-affinity rule is configured for an application pool, Horizon Connection Server attempts to launch the application only on RDS servers that have sufficient resources to run the application. This feature can be useful for controlling applications that consume large amounts of CPU or memory resources.
An anti-affinity rule consists of an application matching pattern and a maximum count. For example, the application matching pattern might be autocad.exe and the maximum count might be 2.","$ref":"#/definitions/ApplicationAntiAffinityData"},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"description":{"type":"string","description":"Notes about the application pool."},"display_name":{"type":"string","example":"Firefox","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."},"enable_client_restrictions":{"type":"boolean","example":false,"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."},"enable_pre_launch":{"type":"boolean","example":false,"description":"Whether to pre-launch the application."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the application pool is enabled."},"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable."},"max_multi_sessions":{"type":"integer","format":"int32","example":5,"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."},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"parameters":{"type":"string","example":"-p myprofile","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher"},"shortcut_locations":{"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","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"description":"Supported file types details.","$ref":"#/definitions/ApplicationSupportedFileTypesData"},"version":{"type":"string","example":"72.0.2","description":"Application version."}},"title":"ApplicationPoolUpdateSpec","description":"Information required to update an application pool."},"ApplicationPoolUpdateSpecV2":{"type":"object","required":["enable_pre_launch","enabled","executable_path","supported_file_types_data"],"properties":{"anti_affinity_data":{"description":"Configure to enable anti-affinity rules. When an anti-affinity rule is configured for an application pool, Horizon Connection Server attempts to launch the application only on RDS servers that have sufficient resources to run the application. This feature can be useful for controlling applications that consume large amounts of CPU or memory resources.
An anti-affinity rule consists of an application matching pattern and a maximum count. For example, the application matching pattern might be autocad.exe and the maximum count might be 2.","$ref":"#/definitions/ApplicationAntiAffinityData"},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_brokered":{"type":"boolean","example":false,"description":"Indicates whether the application pool is cloud brokered. Default value is false.
"},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"description":{"type":"string","description":"Notes about the application pool."},"display_name":{"type":"string","example":"Firefox","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."},"enable_client_restrictions":{"type":"boolean","example":false,"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."},"enable_pre_launch":{"type":"boolean","example":false,"description":"Whether to pre-launch the application."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the application pool is enabled."},"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable."},"max_multi_sessions":{"type":"integer","format":"int32","example":5,"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."},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"parameters":{"type":"string","example":"-p myprofile","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher"},"shortcut_locations":{"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","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"description":"Supported file types details.","$ref":"#/definitions/ApplicationSupportedFileTypesData"},"version":{"type":"string","example":"72.0.2","description":"Application version."}},"title":"ApplicationPoolUpdateSpecV2","description":"Information required to update an application pool."},"ApplicationPoolUpdateSpecV3":{"type":"object","required":["enable_pre_launch","enabled","executable_path","supported_file_types_data"],"properties":{"anti_affinity_data":{"description":"Configure to enable anti-affinity rules. When an anti-affinity rule is configured for an application pool, Horizon Connection Server attempts to launch the application only on RDS servers that have sufficient resources to run the application. This feature can be useful for controlling applications that consume large amounts of CPU or memory resources.
An anti-affinity rule consists of an application matching pattern and a maximum count. For example, the application matching pattern might be autocad.exe and the maximum count might be 2.","$ref":"#/definitions/ApplicationAntiAffinityData"},"avm_shortcut_id":{"type":"string","example":1,"description":"Shortcut ID of AVM managed application."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_brokered":{"type":"boolean","example":false,"description":"Indicates whether the application pool is cloud brokered. Default value is false.
"},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"description":{"type":"string","description":"Notes about the application pool."},"display_name":{"type":"string","example":"Firefox","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."},"enable_client_restrictions":{"type":"boolean","example":false,"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."},"enable_pre_launch":{"type":"boolean","example":false,"description":"Whether to pre-launch the application."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the application pool is enabled."},"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable."},"max_multi_sessions":{"type":"integer","format":"int32","example":5,"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."},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"parameters":{"type":"string","example":"-p myprofile","description":"Parameters to pass to application when launching."},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher"},"shortcut_locations":{"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","enum":["START_MENU","DESKTOP"]}},"start_folder":{"type":"string","description":"Starting folder for application"},"supported_file_types_data":{"description":"Supported file types details.","$ref":"#/definitions/ApplicationSupportedFileTypesData"},"version":{"type":"string","example":"72.0.2","description":"Application version."}},"title":"ApplicationPoolUpdateSpecV3","description":"Information required to update an application pool."},"ApplicationSupportedFileTypesData":{"type":"object","properties":{"enable_auto_update_file_types":{"type":"boolean","example":true,"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."},"enable_auto_update_other_file_types":{"type":"boolean","example":true,"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."},"file_types":{"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":"#/definitions/ApplicationFileTypeData"}},"other_file_types":{"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":"#/definitions/ApplicationOtherFileTypeData"}}},"title":"ApplicationSupportedFileTypesData","description":"Information about the file types supported by the application."},"AuditEventAttributeInfo":{"type":"object","properties":{"event_data":{"type":"object","example":{
"AttrName": "generalData.clientIdleSessionTimeoutMinutes",
"UserDisplayName": "domain\\administrator",
"AttrValue": "15",
"AttrChangeType": "MODIFY"
},"description":"Key value pairs representing Extended attributes related to the event.\n","additionalProperties":{"type":"object"}},"id":{"type":"integer","format":"int64","example":1001,"description":"Unique id representing an event.\n"}},"title":"AuditEventAttributeInfo","description":"Extended attributes related to events."},"AuditEventSummary":{"type":"object","properties":{"application_pool_name":{"type":"string","example":"calculator","description":"Application Pool associated with this event. Will be unset if there is no application association for this event.\nSupported Filters : 'Equals'."},"desktop_pool_name":{"type":"string","example":"manual pool","description":"Desktop Pool associated with this event. Will be unset if there is no desktop association for this event.\nSupported Filters : 'Equals'."},"id":{"type":"integer","format":"int64","example":1001,"description":"Unique id representing an event.\nSupported Filters : 'Equals'."},"machine_dns_name":{"type":"string","example":"broker.domain.com","description":"FQDN of the machine in the Pod that has logged this event.\nSupported Filters : 'Equals'."},"machine_id":{"type":"string","example":"3d78ef58-20a6-4f0e-923d-cb61938002bb","description":"Machine associated with this event. Will be unset if there is no machine association for this event.\nSupported Filters : 'Equals'."},"message":{"type":"string","example":"Broker broker1 has started handling events","description":"Audit event message.\n"},"module":{"type":"string","example":"Broker","description":"Horizon component that has logged this event.\nSupported Filters : 'Equals'."},"severity":{"type":"string","example":"AUDIT_SUCCESS","description":"Severity type of the event.\nSupported Filters : 'Equals'.\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","enum":["INFO","WARNING","ERROR","AUDIT_SUCCESS","AUDIT_FAIL","UNKNOWN"]},"time":{"type":"integer","format":"int64","example":1582181831000,"description":"Time at which the event occurred.\nSupported Filters : 'Between'."},"type":{"type":"string","example":"AGENT_CONNECTED","description":"Event name that corresponds to an item in the message catalog.\nSupported Filters : 'Equals'."},"user_id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-500","description":"Sid of the user associated with this event.\nSupported Filters : 'Equals'."}},"title":"AuditEventSummary","description":"Information related to Audit Events.
Supported Filters : 'And', 'Or', 'Equals' and 'Between'.
See the field description to know the filter types it supports."},"AuthLogin":{"type":"object","required":["domain","password","username"],"properties":{"domain":{"type":"string","example":"AD-TEST-DOMAIN","description":"Domain"},"password":{"type":"array","example":"","description":"User password","items":{"type":"string"}},"username":{"type":"string","example":"Administrator","description":"User Name"}},"title":"AuthLogin","description":"Login Request"},"AuthTokens":{"type":"object","properties":{"access_token":{"type":"string","example":"","description":"Access Token to be used in API calls."},"refresh_token":{"type":"string","example":"","description":"Refresh Token to be used to get a new Access token."}},"title":"AuthTokens","description":"Authentication Tokens"},"AuxiliaryAccountUpdateData":{"type":"object","required":["id","password"],"properties":{"id":{"type":"string","example":"1f95a15c-a7a5-4584-963f-2c3f5355b49f","description":"Auxiliary Service account ID."},"password":{"type":"array","example":"","description":"Service account user password.","items":{"type":"string"}}},"title":"AuxiliaryAccountUpdateData"},"BaseFilter":{"type":"object","discriminator":"type","properties":{"type":{"type":"string","enum":["And","Or","Not","NotEquals","Equals","Contains","StartsWith","EndsWith","Between"]}},"title":"BaseFilter"},"BaseSnapshotInfo":{"type":"object","properties":{"created_timestamp":{"type":"integer","format":"int64","example":1582181947320,"description":"Epoch time in milli seconds, when the VM snapshot was created."},"description":{"type":"string","example":"Base image snapshot","description":"Description of the VM snapshot."},"disk_size_mb":{"type":"integer","format":"int64","example":42949,"description":"Sum of capacities of all the virtual disks in the VM snapshot, in MB."},"hardware_version":{"type":"integer","format":"int32","example":13,"description":"VM snapshot hardware version"},"id":{"type":"string","example":"snapshot-4","description":"Unique ID representing the VM snapshot."},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this VM snapshot from being used in linked/instant clone desktop pool or farm creation.","items":{"type":"string","enum":["POWERED_ON","INCOMPATIBLE_HARDWARE_VERSION"]}},"max_number_of_monitors":{"type":"integer","format":"int32","example":1,"description":"Maximum number of monitors set in SVGA settings for the VM snapshot in vCenter."},"max_resolution_of_any_one_monitor":{"type":"string","example":"1600x1200","description":"Maximum resolution of any one monitor set in SVGA settings for the VM snapshot in vCenter."},"memory_mb":{"type":"integer","format":"int32","example":4096,"description":"The physical memory size of VM snapshot, in MB"},"memory_reservation_mb":{"type":"integer","format":"int64","example":0,"description":"Amount of memory that is guaranteed available to the virtual machine, in MB."},"name":{"type":"string","example":"Snapshot1","description":"VM snapshot name."},"path":{"type":"string","example":"/Snapshot1","description":"VM snapshot path."},"renderer3d":{"type":"string","example":"DISABLED","description":"Indicate how the virtual video device for the VM snapshot renders 3D graphics. Will be set only if VM snapshot supports 3D functions.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* AUTOMATIC: 3D rendering is automatic.\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.\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* DISABLED: 3D rendering is disabled.","enum":["MANAGE_BY_VSPHERE_CLIENT","AUTOMATIC","SOFTWARE","HARDWARE","DISABLED"]},"total_video_memory_mb":{"type":"number","format":"double","example":8.0,"description":"Total video memory in MB set in SVGA settings for the VM snapshot in vCenter."},"vcenter_id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Virtual Center id for this VM snapshot."},"vgpu_type":{"type":"string","description":"NVIDIA GRID vGPU type configured on this VM snapshot."}},"title":"BaseSnapshotInfo","description":"Information related to VM snapshot."},"BaseSnapshotInfoV2":{"type":"object","properties":{"created_timestamp":{"type":"integer","format":"int64","example":1582181947320,"description":"Epoch time in milli seconds, when the VM snapshot was created."},"description":{"type":"string","example":"Base image snapshot","description":"Description of the VM snapshot."},"disk_size_mb":{"type":"integer","format":"int64","example":42949,"description":"Sum of capacities of all the virtual disks in the VM snapshot, in MB."},"hardware_version":{"type":"integer","format":"int32","example":13,"description":"VM snapshot hardware version"},"id":{"type":"string","example":"snapshot-4","description":"Unique ID representing the VM snapshot."},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this VM snapshot from being used in linked/instant clone desktop pool or farm creation.","items":{"type":"string","enum":["POWERED_ON","INCOMPATIBLE_HARDWARE_VERSION"]}},"max_number_of_monitors":{"type":"integer","format":"int32","example":1,"description":"Maximum number of monitors set in SVGA settings for the VM snapshot in vCenter."},"max_resolution_of_any_one_monitor":{"type":"string","example":"1600x1200","description":"Maximum resolution of any one monitor set in SVGA settings for the VM snapshot in vCenter."},"memory_mb":{"type":"integer","format":"int32","example":4096,"description":"The physical memory size of VM snapshot, in MB"},"memory_reservation_mb":{"type":"integer","format":"int64","example":0,"description":"Amount of memory that is guaranteed available to the virtual machine, in MB."},"name":{"type":"string","example":"Snapshot1","description":"VM snapshot name."},"num_cores_per_socket":{"type":"integer","format":"int32","example":2,"description":"Number of cores per socket present on the VM snapshot."},"num_cpus":{"type":"integer","format":"int32","example":4,"description":"Number of CPUs present on the VM snapshot."},"path":{"type":"string","example":"/Snapshot1","description":"VM snapshot path."},"renderer3d":{"type":"string","example":"DISABLED","description":"Indicate how the virtual video device for the VM snapshot renders 3D graphics. Will be set only if VM snapshot supports 3D functions.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* AUTOMATIC: 3D rendering is automatic.\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.\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* DISABLED: 3D rendering is disabled.","enum":["MANAGE_BY_VSPHERE_CLIENT","AUTOMATIC","SOFTWARE","HARDWARE","DISABLED"]},"total_video_memory_mb":{"type":"number","format":"double","example":8.0,"description":"Total video memory in MB set in SVGA settings for the VM snapshot in vCenter."},"vcenter_id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Virtual Center id for this VM snapshot."},"vgpu_type":{"type":"string","description":"NVIDIA GRID vGPU type configured on this VM snapshot."}},"title":"BaseSnapshotInfoV2","description":"Information related to VM snapshot."},"BaseVMInfo":{"type":"object","properties":{"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter id for this VM."},"id":{"type":"string","example":"vm-416","description":"Unique ID representing a VM."},"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.","items":{"type":"string","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","example":"Win10","description":"VM name."},"network_type":{"type":"string","example":"STANDARD_NETWORK","description":"Type of network base VM belongs to.\n* STANDARD_NETWORK: Standard network.\n* OPAQUE_NETWORK: Opaque network.\n* DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS port group.","enum":["STANDARD_NETWORK","OPAQUE_NETWORK","DISTRUBUTED_VIRTUAL_PORT_GROUP"]},"operating_system":{"type":"string","example":"WINDOWS_10","description":"Operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"operating_system_display_name":{"type":"string","example":"Microsoft Windows 10 (64-bit)","description":"Operating system display name from Virtual Center."},"path":{"type":"string","example":"/Datacenter/vm/VMs/Win10","description":"VM path."},"vcenter_id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Virtual Center id for this VM."}},"title":"BaseVMInfo","description":"Information related to base VM."},"BaseVMInfoV2":{"type":"object","properties":{"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter id for this VM."},"id":{"type":"string","example":"vm-416","description":"Unique ID representing a VM."},"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.","items":{"type":"string","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","example":"Win10","description":"VM name."},"network_type":{"type":"string","example":"STANDARD_NETWORK","description":"Type of network base VM belongs to.\n* STANDARD_NETWORK: Standard network.\n* OPAQUE_NETWORK: Opaque network.\n* DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS port group.","enum":["STANDARD_NETWORK","OPAQUE_NETWORK","DISTRUBUTED_VIRTUAL_PORT_GROUP"]},"num_nics":{"type":"integer","format":"int32","example":2,"description":"Number of network interface cards in a VM."},"operating_system":{"type":"string","example":"WINDOWS_10","description":"Operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"operating_system_display_name":{"type":"string","example":"Microsoft Windows 10 (64-bit)","description":"Operating system display name from Virtual Center."},"path":{"type":"string","example":"/Datacenter/vm/VMs/Win10","description":"VM path."},"vcenter_id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Virtual Center id for this VM."}},"title":"BaseVMInfoV2","description":"Information related to base VM."},"BetweenFilter":{"title":"BetweenFilter","allOf":[{"$ref":"#/definitions/BaseFilter"},{"type":"object","properties":{"from_value":{"type":"object"},"name":{"type":"string"},"to_value":{"type":"object"},"type":{"type":"string","enum":["And","Or","Not","NotEquals","Equals","Contains","StartsWith","EndsWith","Between"]}},"title":"BetweenFilter"}]},"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":"#/definitions/EntitlementResponseInfo"}},"error_messages":{"type":"array","example":["Entity does not exists.", "Property is mandatory."],"description":"Reasons for the failure of the operation. This field is deprecated since 2203 release.","items":{"type":"string"}},"errors":{"type":"array","description":"List of error objects containing error key and error message.","items":{"$ref":"#/definitions/APIError"}},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing the resource for the entitlement operation."},"status_code":{"type":"integer","format":"int32","example":200,"description":"Response HTTP status code of the operation."},"timestamp":{"type":"integer","format":"int64","example":1561939200000,"description":"Timestamp in milliseconds when the operation failed. Measured as epoch time."}},"title":"BulkEntitlementResponseInfo","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":"#/definitions/BulkItemResponseInfo"}},"error_messages":{"type":"array","example":["Entity does not exist."],"description":"Reasons for failure of the operation. This field is deprecated since 2203 release.","items":{"type":"string"}},"errors":{"type":"array","description":"List of error objects containing error key and error message.","items":{"$ref":"#/definitions/APIError"}},"pod_id":{"type":"string","example":"54c122e0-d6b5-476c-af91-fd00392e5983","description":"ID of the hosting pod for the sessions."},"status_code":{"type":"integer","format":"int32","example":200,"description":"HTTP Status Code of the operation."},"timestamp":{"type":"integer","format":"int64","example":1611939200000,"description":"Timestamp in milliseconds when the operation failed. \nMeasured as epoch time."}},"title":"BulkGlobalSessionActionResponseInfo","description":"Response corresponding to each pod in a bulk global session action operation."},"BulkItemResponseInfo":{"type":"object","properties":{"error_messages":{"type":"array","example":["Entity does not exist.", "Property is mandatory."],"description":"Reasons for the failure of the operation. This field is deprecated since 2203 release.","items":{"type":"string"}},"errors":{"type":"array","description":"List of error objects containing error key and error message.","items":{"$ref":"#/definitions/APIError"}},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing the entity on which the operation was performed. Will not be populated for create operation if the operation fails."},"key":{"type":"string","example":"user1","description":"Key on which the operation was performed."},"status_code":{"type":"integer","format":"int32","example":200,"description":"Response HTTP status code of the operation."},"timestamp":{"type":"integer","format":"int64","example":1561939200000,"description":"Timestamp in milliseconds when the operation failed. Measured as epoch time."}},"title":"BulkItemResponseInfo","description":"Response for each of the operation in a bulk operation."},"CEIPInfo":{"type":"object","properties":{"company_size":{"type":"string","example":"SIZE_1_100","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.","enum":["SIZE_1_100","SIZE_101_500","SIZE_501_1000","SIZE_1001_5000","SIZE_5001_10000","SIZE_10001"]},"enabled":{"type":"boolean","example":true,"description":"Indicates whether to send information to VMware."},"geolocation":{"type":"string","example":"ASIA_PACIFIC","description":"The geolocation of the company."},"vertical":{"type":"string","example":"BANKING_FINANCE","description":"The vertical of the company."}},"title":"CEIPInfo","description":"Configuration information for the customer experience improvement program."},"CPAEjectSpec":{"type":"object","required":["pod_id"],"properties":{"pod_id":{"type":"string","example":"9e94a90d-e7c2-40b6-a702-bd781512408d","description":"The ID of the pod that has to be removed from Pod Federation."}},"title":"CPAEjectSpec"},"CPAJoinSpec":{"type":"object","required":["password","remote_pod_address","username"],"properties":{"password":{"type":"array","example":"","description":"The password for the user.","items":{"type":"string"}},"remote_pod_address":{"type":"string","example":"cs1.example.com","description":"The IP address or hostname for the remote pod."},"username":{"type":"string","example":"AD-TEST-DOMAIN\\Administrator","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."}},"title":"CPAJoinSpec"},"CPATaskResponseInfo":{"type":"object","properties":{"task_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing the task."}},"title":"CPATaskResponseInfo","description":"CPA action response."},"CPAUpdateSpec":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Horizon Cloud Pod Federation","description":"Name of the pod federation."}},"title":"CPAUpdateSpec","description":"Information required to update a pod federation."},"CertificateData":{"type":"object","properties":{"allow_admin_override":{"type":"boolean","example":true,"description":"Indicates if admin override is allowed."},"certificate":{"type":"string","example":"","description":"The certificate in string form."},"certificate_encoding":{"type":"string","example":"DER_BASE64_PEM","description":"The encoding of the certificate."},"invalid_reasons":{"type":"array","example":[ "NOT_TRUSTED", "CANT_CHECK_REVOKED"],"description":"The reason(s) why the certificate could not be validated.","items":{"type":"string"}},"ssl_cert_thumbprint":{"type":"string","example":"","description":"A digest of the certificate."},"ssl_cert_thumbprint_algorithm":{"type":"string","example":"SHA-1","description":"Algorithm used to compute the thumbprint."},"valid":{"type":"boolean","example":true,"description":"Indicates if certificate is valid."}},"title":"CertificateData","description":"Certificate information of the remote server."},"CertificateInfo":{"type":"object","properties":{"certificate_usage":{"type":"string","example":"MACHINE","description":"Indicates how the certificate would be used.\n* MACHINE: vdm certificates","enum":["MACHINE"]},"dnssubject_alternative_names":{"type":"array","items":{"type":"string"}},"in_use":{"type":"boolean","example":true,"description":"Indicates whether certificate is currently used by server or not."},"invalid_reasons":{"type":"array","example":["NAME_MISMATCH","NOT_TRUSTED"],"description":"Indicates the reason for invalid certificate.","items":{"type":"string"}},"is_valid":{"type":"boolean","example":true,"description":"Indicates whether certificate is valid or not."},"issuer_name":{"type":"string","example":"CN=Horizon-server.example.local, OU=VMware Horizon View default certificate, O=VMware, Inc.","description":"Issuer name of certificate."},"serial_number":{"type":"string","example":"8e8fc36503833556","description":"Serial number of certificate."},"sha1_thumbprint":{"type":"string","example":"0F:E0:80:6E:7E:0F:BA:EE:0E:BC:0E:A3:8D:FA:19:D8:BD:C0:5E:DF","description":"SHA1 thumbprint of certificate."},"signature_algorithm":{"type":"string","example":"SHA384withRSA","description":"Signature algorithm of certificate."},"subject_name":{"type":"string","example":"CN=Horizon-server.example.local, OU=VMware Horizon View default certificate, O=VMware, Inc.","description":"Subject name of certificate."},"valid_from":{"type":"string","example":20221010113220,"description":"Certificate valid from. Numeric version of ISO 8601 format."},"valid_until":{"type":"string","example":20250112113220,"description":"Certificate valid until. Numeric version of ISO 8601 format."}},"title":"CertificateInfo","description":"Certificate information of connection server."},"CertificateMonitorInfo":{"type":"object","properties":{"valid":{"type":"boolean","example":true,"description":"Indicates if the certificate is valid."},"valid_from":{"type":"integer","format":"int64","example":1561939200000,"description":"Start time of the certificate validity in milliseconds. Measured as epoch time."},"valid_to":{"type":"integer","format":"int64","example":1561939200000,"description":"Expiration time of the certificate validity in milliseconds. Measured as epoch time."}},"title":"CertificateMonitorInfo","description":"Monitoring data about server's certificate."},"CertificateOverrideData":{"type":"object","properties":{"certificate":{"type":"string","description":"Virtual Center certificate"},"type":{"type":"string","example":"PEM","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","enum":["PEM","UNKNOWN"]}},"title":"CertificateOverrideData","description":"Certificate details and type information, which can be used to override thumbprint details."},"CertificateProperties":{"type":"object","properties":{"key_length":{"type":"integer","format":"int32","example":2048,"description":"Certificate generation SSO Key length."},"validity":{"type":"integer","format":"int32","example":365,"description":"Certificate generation SSO key validity period in days."}},"title":"CertificateProperties","description":"Certificate properties."},"CertificateServerDetails":{"type":"object","properties":{"name":{"type":"string","example":"SSOConnector","description":"Certificate Server name."},"status":{"type":"string","example":"OK","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.","enum":["OK","WARN","ERROR"]}},"title":"CertificateServerDetails"},"CertificateSpec":{"type":"object","required":["certificate_chain","certificate_usage","format"],"properties":{"certificate_chain":{"type":"string","format":"byte","example":[48, -126, 17, -12, 2, 1, 3, 48, -126, 17, -70, 17, -25, 83, -37, 57, 74],"description":"Certificate chain."},"certificate_password":{"type":"array","example":"password","description":"Password for pfx certificate type.","items":{"type":"string"}},"certificate_usage":{"type":"string","example":"MACHINE","description":"Indicates the type of certificate based on usage.\n* MACHINE: vdm certificates","enum":["MACHINE"]},"format":{"type":"string","example":"pem","description":"Certificate Type.","enum":["pem","pfx"]}},"title":"CertificateSpec","description":"Certificate spec for importing ssl certificate to connection server's personal store."},"CertificateThumbprint":{"type":"object","required":["ssl_cert_thumbprint","ssl_cert_thumbprint_algorithm"],"properties":{"ssl_cert_thumbprint":{"type":"string","example":"8f:92:9d:3b:a7:85:55:88:60:cd:e1:c8:1e:70:9a:8b:37:6d:a6:e6","description":"A digest of the certificate."},"ssl_cert_thumbprint_algorithm":{"type":"string","example":"SHA_1","description":"Algorithm used to compute the thumbprint.\n* SHA_1: SHA-1 hashing algorithm.\n* SHA_256: SHA-256 hashing algorithm.","enum":["SHA_1","SHA_256"]}},"title":"CertificateThumbprint","description":"Information about the SSL Certificate thumbprints"},"ClientData":{"type":"object","properties":{"address":{"type":"string","example":"127.0.0.1","description":"IP address of the client machine for the session. \nThis property need not be set.
Supported Filters : 'Equals'."},"location_id":{"type":"string","example":"6bda20e66cda315084edc8b5c67f9cf1e3b0f4559ba990b1004a","description":"Client location for the session. \nThis property need not be set.
Supported Filters : 'Equals'."},"name":{"type":"string","example":"EXAMPLE-CLIENT1","description":"Client machine hostname for the session. \nThis property need not be set.
Supported Filters : 'Equals'."},"type":{"type":"string","example":"WINDOWS","description":"Client type for the session. \nThis property need not be set.
Supported Filters : 'Equals'.\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.","enum":["WINDOWS","MAC","HTMLACCESS","LINUX","IOS","ANDROID","OTHER"]},"version":{"type":"string","example":"5.4.0","description":"Client version for the session. \nThis property need not be set.
Supported Filters : 'Equals'."}},"title":"ClientData","description":"Client data associated with the session."},"ClientKeyDerivationSpec":{"type":"object","required":["identifier","nonce","public_key","supported_schemes"],"properties":{"identifier":{"type":"string","format":"byte","example":"V2luZG93c0xPQ0FUSU9OSUQ6NTIyNTI0NTM0NTM0NjM0MzQ2MzYzNDYzNjc1MzI0NjUyMzY3NDUyNzY1NDIzNjc1NDY3MjM1NDI0Mw==","description":"Identifier as Base64 encoded binary data."},"nonce":{"type":"string","format":"byte","example":"DaY+kne1X2B6h8a4gLZu2w==","description":"Nonce as Base64 encoded binary data."},"public_key":{"type":"string","format":"byte","example":"","description":"Diffie Hellman public key as Base64 encoded binary data."},"supported_schemes":{"type":"array","example":["SCHEME-AES2"],"description":"List of client supported schemes for key derivation.","items":{"type":"string","enum":["SCHEME-AES1","SCHEME-AES2","SCHEME-EC-AES1","SCHEME-EC-AES2"]}}},"title":"ClientKeyDerivationSpec","description":"Client key derivation spec."},"ClientProperties":{"type":"object","properties":{"cipher_suites":{"type":"array","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"],"description":"List of cipher suites of client.","items":{"type":"string"}},"named_groups":{"type":"array","example":["SECP384_R1","FFDHE_2048"],"description":"List of named groups of client.","items":{"type":"string"}},"signature_algorithms":{"type":"array","example":["RSA_PSS_RSAE_SHA512","RSA_PKCS1_SHA512", "ECDSA_SECP521R1_SHA512"],"description":"List of signature algorithms of client.","items":{"type":"string"}},"thumbprint_algorithms":{"type":"array","example":["SHA_512","SHA_384"],"description":"List of thumbprint algorithms of client.","items":{"type":"string"}}},"title":"ClientProperties","description":"Client properties of Security configuration."},"ConnectionServerGSSAPIInfo":{"type":"object","properties":{"allow_receiving_ntlm":{"type":"boolean","example":false,"description":"Indicates whether connection server supports NTLM or not."},"gss_apiauthenticator_id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"ID of the GSS API authenticator to use."},"gss_apienabled":{"type":"boolean","example":false,"description":"Indicates whether GSSAPI authentication is enabled."}},"title":"ConnectionServerGSSAPIInfo","description":"Information related to connection server GSS API configuration."},"ConnectionServerGSSAPISpec":{"type":"object","required":["gss_apienabled"],"properties":{"gss_apienabled":{"type":"boolean","example":false,"description":"Indicates whether GSSAPI authentication is enabled."}},"title":"ConnectionServerGSSAPISpec","description":"Information related to connection server GSS API configuration."},"ConnectionServerInfo":{"type":"object","properties":{"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique Id of the Connection Server."},"jwt_info":{"description":"JWT authentication settings.","$ref":"#/definitions/ConnectionServerJWTInfo"}},"title":"ConnectionServerInfo","description":"Information related to Connection Server."},"ConnectionServerInfoV2":{"type":"object","properties":{"auxillary_external_pcoip_ipv4_address":{"type":"string","example":"127.0.0.1:4172","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."},"bypass_app_blast_gateway":{"type":"boolean","example":false,"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."},"bypass_pcoip_gateway":{"type":"boolean","example":true,"description":"Indicates whether the PCoIP traffic bypasses the secure gateway."},"bypass_tunnel":{"type":"boolean","example":false,"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."},"cluster_name":{"type":"string","example":"Cluster-CS1","description":"Cluster name."},"direct_htmlabsg":{"type":"boolean","example":false,"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."},"disclose_service_principal_name":{"type":"boolean","example":false,"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."},"enable_smart_card_user_name_hint":{"type":"boolean","example":false,"description":"Indicates whether username hints for smart card is enabled."},"enabled":{"type":"boolean","example":true,"description":"Indicate whether the connection server is enabled. A disabled connection server will not accept connection requests from Horizon Clients."},"external_appblast_url":{"type":"string","example":"https://cs1.example.com:8443","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."},"external_pcoip_url":{"type":"string","example":"127.0.0.1:4172","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."},"external_url":{"type":"string","example":"https://cs1.example.com:443","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."},"fips_mode_enabled":{"type":"boolean","example":false,"description":"Indicates whether this server has FIPS mode enabled."},"fqhn":{"type":"string","example":"cs1.example.com","description":"Fully qualified host name."},"gss_apiinfo":{"description":"GSSAPI authentication settings.","$ref":"#/definitions/ConnectionServerGSSAPIInfo"},"has_blast_gateway_support":{"type":"boolean","example":true,"description":"Indicates whether Blast gateway is supported or not."},"has_pcoip_gateway_support":{"type":"boolean","example":true,"description":"Indicates whether PCoIP gateway is supported or not."},"host_redirection":{"type":"boolean","example":false,"description":"Indicates whether connection server supports HTTP host redirection."},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique Id of the Connection Server."},"ip_mode":{"type":"string","example":"IPv4","description":"Indicates the Connection Server IP environment.\n* IPv4: The ip mode is IPv4.\n* IPv6: The ip mode is IPv6.","enum":["IPv4","IPv6"]},"jwt_info":{"description":"JWT authentication settings.","$ref":"#/definitions/ConnectionServerJWTInfo"},"ldap_backup_info":{"description":"Connectionserver LDAP backup settings.","$ref":"#/definitions/ConnectionServerLdapBackupInfo"},"load_balancer_hosts":{"type":"array","example":[
"10.217.68.253",
"10.217.68.254"
],"description":"List of load balancer host names or IP address.","items":{"type":"string"}},"local_connection_server":{"type":"boolean","example":true,"description":"Indicates whether this is the local connection server that handled the connection server service request."},"logoff_when_remove_smart_card":{"type":"boolean","example":false,"description":"Indicates whether user is logged off on removal of Smart Card."},"message_security_enhanced_mode_supported":{"type":"boolean","example":false,"description":"Indicates whether ENHANCED message security mode is currently supported by this Connection Server."},"msg_security_public_key":{"type":"string","example":"MIHwMIGoBgcqhkjOOAQBMIGcAkEA/KaCzo4Syrom78z3EQ5SbbB4sF7ey80etKII864WF64B81uRpH5t9jQTxeEu0Imbz\r\nRMqzVDZkVG9xD7nN1kuFwIVAJYu3cw2nLqOuyYO5rahJtk0bjjFAkBnhHGyepz0TukaScUUfbGpqvJE8FpDTWSGkx0tFCcbn\r\njUDC3H9c9oXkGmzLik1Yw4cIGI1TQ2iCmxBblC+eUykA0MAAkBTVayCjCDm9x1oPkzxvlRrn2ZJWJPnEAMvxnyBOA8rJ/uD0BkQ/iSV/Q3HoR5Mkwc/mMeMuo9VpLK0wgb0BUZ9","description":"The JMS message security public key."},"name":{"type":"string","example":"cs1.example.com","description":"Name of the Connection Server."},"radius_info":{"description":"RADIUS authentication settings.","$ref":"#/definitions/ConnectionServerRADIUSInfo"},"router_ssl_thumbprints":{"type":"array","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"
],"description":"The JMS router SSL thumbprints","items":{"type":"string"}},"rsa_secure_id_info":{"description":"SecureId authentication settings.","$ref":"#/definitions/ConnectionServerRSASecureIdInfo"},"saml_info":{"description":"SAML authentication settings.","$ref":"#/definitions/ConnectionServerSAMLInfo"},"server_url":{"type":"string","example":"https://cs1.example.com:443","description":"General URL for the connection server."},"smart_card_support":{"type":"string","example":"OPTIONAL","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.","enum":["OPTIONAL","REQUIRED","OFF"]},"smart_card_support_for_admin":{"type":"string","example":"OFF","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.","enum":["OPTIONAL","REQUIRED","OFF"]},"tags":{"type":"array","example":["tag1","tag2"],"description":"Tags to restrict accessibility to desktop pools through this server.","items":{"type":"string"}},"unauthenticated_access_info":{"description":"Unauthenticated access settings.","$ref":"#/definitions/ConnectionServerUnauthenticatedAccessInfo"},"version":{"type":"string","example":"8.6.0-19754208","description":"Version attribute to indicate functionalities supported by current connection server."}},"title":"ConnectionServerInfoV2","description":"Information related to Connection server."},"ConnectionServerJWTInfo":{"type":"object","properties":{"jwt_authenticator_ids":{"type":"array","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9", "d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"description":"List of configured JWT authenticators for this Connection Server.","items":{"type":"string"}},"jwt_support":{"type":"string","example":"DISABLED","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.","enum":["DISABLED","MULTI_ENABLED","MULTI_REQUIRED"]}},"title":"ConnectionServerJWTInfo","description":"Information related to connection server JWT authentication settings."},"ConnectionServerJWTSpec":{"type":"object","properties":{"jwt_authenticator_ids":{"type":"array","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9", "d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"description":"List of JWT authenticators to be configured for this Connection Server.","items":{"type":"string"}},"jwt_support":{"type":"string","example":"DISABLED","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.","enum":["DISABLED","MULTI_ENABLED","MULTI_REQUIRED"]}},"title":"ConnectionServerJWTSpec","description":"Settings related to Connection Server JWT authentication"},"ConnectionServerLdapBackupInfo":{"type":"object","properties":{"backup_in_progress":{"type":"boolean"},"frequency_time":{"type":"string","example":"DAY_1","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.","enum":["HOUR_1","HOUR_6","HOUR_12","DAY_1","DAY_2","WEEK_1","WEEK_2","HOUR_0"]},"last_ldap_backup_status":{"type":"string","example":"OK","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* ERROR_UNKNOWN: Indicates that the error is unknown.","enum":["OK","DISK_FULL","UNABLE_TO_CREATE_DIR","ERROR_UNKNOWN"]},"last_ldap_backup_time":{"type":"integer","format":"int64","example":1652079610000,"description":"Last Ldap Backup Time."},"ldap_backup_folder":{"type":"string","example":"C:\\ProgramData\\VMware\\VDM\\backups","description":"Location of the backup folder."},"max_number":{"type":"integer","format":"int32","example":10,"description":"Maximum number of backups."},"time_offset":{"type":"integer","format":"int32","example":0,"description":"Ldap backup time offset in minutes"}},"title":"ConnectionServerLdapBackupInfo","description":"Information related to connection server LDAP backup."},"ConnectionServerLdapBackupSpec":{"type":"object","required":["frequency_time","ldap_backup_folder","max_number","time_offset"],"properties":{"frequency_time":{"type":"string","example":"DAY_1","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.","enum":["HOUR_1","HOUR_6","HOUR_12","DAY_1","DAY_2","WEEK_1","WEEK_2","HOUR_0"]},"ldap_backup_folder":{"type":"string","example":"C:\\ProgramData\\VMware\\VDM\\backups","description":"Location of the backup folder."},"max_number":{"type":"integer","format":"int32","example":10,"description":"Maximum number of backups."},"time_offset":{"type":"integer","format":"int32","example":0,"description":"Ldap backup time offset in minutes"}},"title":"ConnectionServerLdapBackupSpec","description":"Information related to connection server LDAP backup."},"ConnectionServerMonitorCSReplication":{"type":"object","properties":{"server_name":{"type":"string","example":"cs1.example.com","description":"Connection Server host name or IP address."},"status":{"type":"string","example":"OK","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.","enum":["OK","ERROR"]}},"title":"ConnectionServerMonitorCSReplication","description":"Replication status with respect to Peer Connection Servers in the same cluster."},"ConnectionServerMonitorDetails":{"type":"object","properties":{"build":{"type":"string","example":"12345678.0.1","description":"Connection Server build number."},"version":{"type":"string","example":"7.9.0","description":"Connection Server version number."}},"title":"ConnectionServerMonitorDetails","description":"Details of the Connection Server."},"ConnectionServerMonitorInfo":{"type":"object","properties":{"certificate":{"description":"Connection Server certificate information.","$ref":"#/definitions/CertificateMonitorInfo"},"connection_count":{"type":"integer","format":"int32","example":1234,"description":"Number of connections to this Connection Server."},"cs_replications":{"type":"array","description":"Connection Server replication status with respect to the Peer Connection Servers in the same cluster.","items":{"$ref":"#/definitions/ConnectionServerMonitorCSReplication"}},"default_certificate":{"type":"boolean","example":false,"description":"Indicates whether server has the default certificate."},"details":{"description":"Details about the Connection Server.","$ref":"#/definitions/ConnectionServerMonitorDetails"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"name":{"type":"string","example":"cs1.example.com","description":"Connection Server host name or IP address."},"services":{"type":"array","description":"Connection Server related Windows services information.","items":{"$ref":"#/definitions/ConnectionServerMonitorServiceStatus"}},"session_protocol_data":{"type":"array","description":"PCoIP, RDP or BLAST protocol sessions details when clients connect directly to the connection server.","items":{"$ref":"#/definitions/ConnectionServerSessionProtocolData"}},"session_threshold":{"type":"integer","format":"int32","example":2000,"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."},"status":{"type":"string","example":"OK","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.","enum":["OK","ERROR","NOT_RESPONDING","UNKNOWN","RESTART_REQUIRED"]},"tunnel_connection_count":{"type":"integer","format":"int32","example":1234,"description":"Number of connections tunneled through this Connection Server."}},"title":"ConnectionServerMonitorInfo","description":"Monitoring information related to Connection Server."},"ConnectionServerMonitorInfoV2":{"type":"object","properties":{"certificate":{"description":"Connection Server certificate information.","$ref":"#/definitions/CertificateMonitorInfo"},"connection_count":{"type":"integer","format":"int32","example":1234,"description":"Number of connections to this Connection Server."},"cs_replications":{"type":"array","description":"Connection Server replication status with respect to the Peer Connection Servers in the same cluster.","items":{"$ref":"#/definitions/ConnectionServerMonitorCSReplication"}},"default_certificate":{"type":"boolean","example":false,"description":"Indicates whether server has the default certificate."},"details":{"description":"Details about the Connection Server.","$ref":"#/definitions/ConnectionServerMonitorDetails"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"last_updated_timestamp":{"type":"integer","format":"int64","example":1582029025748,"description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time."},"name":{"type":"string","example":"cs1.example.com","description":"Connection Server host name or IP address."},"services":{"type":"array","description":"Connection Server related Windows services information.","items":{"$ref":"#/definitions/ConnectionServerMonitorServiceStatus"}},"session_protocol_data":{"type":"array","description":"PCoIP, RDP or BLAST protocol sessions details when clients connect directly to the connection server.","items":{"$ref":"#/definitions/ConnectionServerSessionProtocolData"}},"session_threshold":{"type":"integer","format":"int32","example":2000,"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."},"status":{"type":"string","example":"OK","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.","enum":["OK","ERROR","NOT_RESPONDING","UNKNOWN","RESTART_REQUIRED"]},"tunnel_connection_count":{"type":"integer","format":"int32","example":1234,"description":"Number of connections tunneled through this Connection Server."}},"title":"ConnectionServerMonitorInfoV2","description":"Monitoring information related to Connection Server."},"ConnectionServerMonitorInfoV3":{"type":"object","properties":{"certificate":{"description":"Connection Server certificate information.","$ref":"#/definitions/CertificateMonitorInfo"},"connection_count":{"type":"integer","format":"int32","example":1234,"description":"Number of connections to this Connection Server."},"cs_replications":{"type":"array","description":"Connection Server replication status with respect to the Peer Connection Servers in the same cluster.","items":{"$ref":"#/definitions/ConnectionServerMonitorCSReplication"}},"default_certificate":{"type":"boolean","example":false,"description":"Indicates whether server has the default certificate."},"details":{"description":"Details about the Connection Server.","$ref":"#/definitions/ConnectionServerMonitorDetails"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"last_updated_timestamp":{"type":"integer","format":"int64","example":1582029025748,"description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time."},"name":{"type":"string","example":"cs1.example.com","description":"Connection Server host name or IP address."},"services":{"type":"array","description":"Connection Server related Windows services information.","items":{"$ref":"#/definitions/ConnectionServerMonitorServiceStatus"}},"session_protocol_data":{"type":"array","description":"PCoIP, RDP or BLAST protocol sessions details when clients connect directly to the connection server.","items":{"$ref":"#/definitions/ConnectionServerSessionProtocolData"}},"session_threshold":{"type":"integer","format":"int32","example":2000,"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."},"status":{"type":"string","example":"OK","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.","enum":["OK","ERROR","NOT_RESPONDING","UNKNOWN","RESTART_REQUIRED"]},"tunnel_connection_count":{"type":"integer","format":"int32","example":1234,"description":"Number of connections tunneled through this Connection Server."},"unrecognized_pcoip_requests_count":{"type":"integer","format":"int32","example":3,"description":"Number of unrecognized PCoIP secure gateway requests."},"unrecognized_tunnel_requests_count":{"type":"integer","format":"int32","example":4,"description":"Number of unrecognized tunnel requests."},"unrecognized_xmlapi_requests_count":{"type":"integer","format":"int32","example":5,"description":"Number of unrecognized XML API requests."}},"title":"ConnectionServerMonitorInfoV3","description":"Monitoring information related to Connection Server."},"ConnectionServerMonitorServiceStatus":{"type":"object","properties":{"service_name":{"type":"string","example":"BLAST_SECURE_GATEWAY","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.","enum":["PCOIP_SECURE_GATEWAY","BLAST_SECURE_GATEWAY","SECURITY_GATEWAY_COMPONENT"]},"status":{"type":"string","example":"UP","description":"Status of the service.\n* UP: The Windows service is UP and running.\n* DOWN: The Windows service is not UP.\n* UNKNOWN: The Windows service state is Unknown.","enum":["UP","DOWN","UNKNOWN"]}},"title":"ConnectionServerMonitorServiceStatus","description":"Status of Connection Server related Windows service."},"ConnectionServerRADIUSInfo":{"type":"object","properties":{"radius_authenticator_id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"The RADIUS Authenticator to use."},"radius_enabled":{"type":"boolean","example":false,"description":"Flag to specify if RADIUS authentication is enabled."},"radius_name_mapping":{"type":"boolean","example":false,"description":"Flag to specify if RADIUS name mapping is enabled."},"radius_sso":{"type":"boolean","example":false,"description":"Flag to specify if RADIUS Windows Single Sign-On is enabled."}},"title":"ConnectionServerRADIUSInfo","description":"Information related to connection server RADIUS authentication settings."},"ConnectionServerRADIUSSpec":{"type":"object","required":["radius_enabled"],"properties":{"radius_authenticator_id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"The RADIUS Authenticator to use."},"radius_enabled":{"type":"boolean","example":false,"description":"Indicates whether RADIUS authentication is enabled."},"radius_name_mapping":{"type":"boolean","example":false,"description":"Indicates whether RADIUS name mapping is enabled."},"radius_sso":{"type":"boolean","example":false,"description":"Indicates whether RADIUS Windows Single Sign-On is enabled."}},"title":"ConnectionServerRADIUSSpec","description":"Information related to connection server RADIUS authentication settings."},"ConnectionServerRSASecureIdInfo":{"type":"object","properties":{"clear_node_secret":{"type":"boolean","example":false,"description":"When set to TRUE the SecureID node secret is cleared"},"name_mapping":{"type":"boolean","example":false,"description":"Indicates how SecureID names map to AD usernames. It is false for not mapped."},"secure_id_enabled":{"type":"boolean","example":false,"description":"Indicates whether SecureID authentication is required."},"security_file_uploaded":{"type":"boolean","example":false,"description":"If SecureID sdconf.rec file is already uploaded. The client can never download the file."}},"title":"ConnectionServerRSASecureIdInfo","description":"Information related to Connection server RSA SecureId authentication settings."},"ConnectionServerRSASecureIdSpec":{"type":"object","required":["secure_id_enabled"],"properties":{"clear_node_secret":{"type":"boolean","example":false,"description":"When set to TRUE the SecureID node secret is cleared"},"name_mapping":{"type":"boolean","example":false,"description":"Indicates how SecureID names map to AD usernames. It is false for not mapped."},"secure_id_enabled":{"type":"boolean","example":false,"description":"Indicates whether SecureID authentication is required."},"security_file_data":{"type":"string","format":"byte","description":"Binary contents of the SecurID sdconf.rec file."}},"title":"ConnectionServerRSASecureIdSpec","description":"Information related to Connection server RSA SecureId authentication settings."},"ConnectionServerSAMLInfo":{"type":"object","properties":{"saml_authenticator_ids":{"type":"array","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9", "d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"description":"List of SamlAuthenticators to use.","items":{"type":"string"}},"saml_support":{"type":"string","example":"DISABLED","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.","enum":["DISABLED","MULTI_ENABLED","MULTI_REQUIRED"]},"workspace_one_block_old_clients":{"type":"boolean","example":false,"description":"Block old clients that don't support Workspace ONE mode."},"workspace_one_host_name":{"type":"string","example":"workspaceone.com","description":"The hostname of the Workspace ONE Server."},"workspace_one_mode_enabled":{"type":"boolean","example":false,"description":"Indicates whether Workspace ONE mode is enabled."}},"title":"ConnectionServerSAMLInfo","description":"Information related to connection server SAML authentication settings."},"ConnectionServerSAMLSpec":{"type":"object","required":["saml_support"],"properties":{"saml_authenticator_ids":{"type":"array","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9", "d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"description":"List of SamlAuthenticators to use.","items":{"type":"string"}},"saml_support":{"type":"string","example":"DISABLED","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.","enum":["DISABLED","MULTI_ENABLED","MULTI_REQUIRED"]},"workspace_one_block_old_clients":{"type":"boolean","example":false,"description":"Indicates whether old clients that don't support Workspace ONE mode are blocked."},"workspace_one_host_name":{"type":"string","example":"workspaceone.com","description":"The hostname of the Workspace ONE Server."},"workspace_one_mode_enabled":{"type":"boolean","example":false,"description":"Indicates whether Workspace ONE mode is enabled."}},"title":"ConnectionServerSAMLSpec","description":"Information related to connection server SAML authentication settings."},"ConnectionServerSessionProtocolData":{"type":"object","properties":{"session_count":{"type":"integer","format":"int32","example":341,"description":"Number of active sessions launched using the protocol."},"session_protocol":{"type":"string","example":"BLAST","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* UNKNOWN: Display protocol is unknown.","enum":["PCOIP","RDP","BLAST","CONSOLE","UNKNOWN"]}},"title":"ConnectionServerSessionProtocolData","description":"Details of connected session count for each session protocol."},"ConnectionServerStatus":{"type":"object","properties":{"id":{"type":"string","example":"c617fd51-e118-4cae-970c-54a7144aaadc","description":"Unique ID of the connection server to which this status pertains."},"message":{"type":"string","example":"OK","description":"The CPA error message for the connection server if any, is populated, or a success message."},"message_code":{"type":"string","example":"LMV_OP_OK","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.","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","example":"CS1","description":"Name of the connection server."},"pending_percentage":{"type":"integer","format":"int32","example":80,"description":" Value between 0 and 100 representing CPA operation completion percentage when connection server status is pending."},"status":{"type":"string","example":"ENABLED","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.","enum":["ENABLED","DISABLED","PENDING","ENABLE_ERROR","DISABLE_ERROR"]}},"title":"ConnectionServerStatus","description":"CPA status for a connection server."},"ConnectionServerUnauthenticatedAccessInfo":{"type":"object","properties":{"block_unsupported_clients":{"type":"boolean","example":false,"description":"Block older clients which don't support client puzzles\r\nto prevent DOS attack on RDSH servers for Unauthenticated Access."},"client_puzzle_difficulty":{"type":"integer","format":"int32","example":21,"description":"Client puzzle difficulty for DoS attack prevention for Unauthenticated Access.\r\nHigher difficulty might increase login time and affect user experience."},"default_unauth_user_id":{"type":"string","example":"11bd230b-87ce-3306-a943-810affe7b68a","description":"Default user for unauthenticated access in this connection server."},"enabled":{"type":"boolean","example":false,"description":"Indicates whether unauthenticated access is enabled in this connection server."},"user_idle_timeout":{"type":"integer","format":"int32","example":10,"description":"Unauthenticated Access user idle session timeout in minutes."}},"title":"ConnectionServerUnauthenticatedAccessInfo","description":"Information related to connection server unauthenticated access settings."},"ConnectionServerUnauthenticatedAccessSpec":{"type":"object","required":["enabled"],"properties":{"block_unsupported_clients":{"type":"boolean","example":false,"description":"Block older clients which don't support client puzzles\r\nto prevent DOS attack on RDSH servers for Unauthenticated Access."},"client_puzzle_difficulty":{"type":"integer","format":"int32","example":21,"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","minimum":14,"maximum":31,"exclusiveMinimum":false,"exclusiveMaximum":false},"default_unauth_user_id":{"type":"string","example":"11bd230b-87ce-3306-a943-810affe7b68a","description":"Default user for unauthenticated access in this connection server."},"enabled":{"type":"boolean","example":false,"description":"Indicates whether unauthenticated access is enabled in this connection server."},"user_idle_timeout":{"type":"integer","format":"int32","example":10,"description":"Unauthenticated Access user idle session timeout in minutes.","minimum":1,"maximum":1440,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"ConnectionServerUnauthenticatedAccessSpec","description":"Information related to connection server unauthenticated access settings."},"ConnectionServerUpdateSpec":{"type":"object","properties":{"jwt_info":{"description":"JWT authentication settings to update.","$ref":"#/definitions/ConnectionServerJWTSpec"}},"title":"ConnectionServerUpdateSpec","description":"Information required to update a Connection Server."},"ConnectionServerUpdateSpecV2":{"type":"object","required":["bypass_app_blast_gateway","bypass_pcoip_gateway","disclose_service_principal_name","enabled","gss_apiinfo","host_redirection","radius_info","rsa_secure_id_info","saml_info","smart_card_support","smart_card_support_for_admin","unauthenticated_access_info"],"properties":{"auxillary_external_pcoip_ipv4_address":{"type":"string","example":"127.0.0.1:4172","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."},"bypass_app_blast_gateway":{"type":"boolean","example":false,"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."},"bypass_pcoip_gateway":{"type":"boolean","example":true,"description":"Indicates whether the PCoIP traffic bypasses the secure gateway."},"bypass_tunnel":{"type":"boolean","example":false,"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."},"direct_htmlabsg":{"type":"boolean","example":false,"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."},"disclose_service_principal_name":{"type":"boolean","example":false,"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."},"enable_smart_card_user_name_hint":{"type":"boolean","example":false,"description":"Indicates whether username hints for smart card is enabled."},"enabled":{"type":"boolean","example":true,"description":"Indicate whether the connection server is enabled. A disabled connection server will not accept connection requests from Horizon Clients."},"external_appblast_url":{"type":"string","example":"https://cs1.example.com:8443","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."},"external_pcoip_url":{"type":"string","example":"127.0.0.1:4172","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."},"external_url":{"type":"string","example":"https://cs1.example.com:443","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."},"gss_apiinfo":{"description":"GSSAPI authentication settings.","$ref":"#/definitions/ConnectionServerGSSAPISpec"},"host_redirection":{"type":"boolean","example":false,"description":"Indicates whether connection server supports HTTP host redirection."},"jwt_info":{"description":"JWT authentication settings to update.","$ref":"#/definitions/ConnectionServerJWTSpec"},"ldap_backup_info":{"description":"Connection server LDAP backup settings.","$ref":"#/definitions/ConnectionServerLdapBackupSpec"},"logoff_when_remove_smart_card":{"type":"boolean","example":false,"description":"Indicates whether user is logged off on removal of Smart Card."},"radius_info":{"description":"RADIUS authentication settings.","$ref":"#/definitions/ConnectionServerRADIUSSpec"},"rsa_secure_id_info":{"description":"SecureId authentication settings.","$ref":"#/definitions/ConnectionServerRSASecureIdSpec"},"saml_info":{"description":"SAML authentication settings.","$ref":"#/definitions/ConnectionServerSAMLSpec"},"smart_card_support":{"type":"string","example":"OFF","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.","enum":["OPTIONAL","REQUIRED","OFF"]},"smart_card_support_for_admin":{"type":"string","example":"OPTIONAL","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.","enum":["OPTIONAL","REQUIRED","OFF"]},"tags":{"type":"array","example":["tag1","tag2"],"description":"Tags to restrict accessibility to desktop pools through this server.","items":{"type":"string"}},"unauthenticated_access_info":{"description":"Unauthenticated access settings.","$ref":"#/definitions/ConnectionServerUnauthenticatedAccessSpec"}},"title":"ConnectionServerUpdateSpecV2","description":"Information related to Connection server."},"ContainsFilter":{"title":"ContainsFilter","allOf":[{"$ref":"#/definitions/BaseFilter"},{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["And","Or","Not","NotEquals","Equals","Contains","StartsWith","EndsWith","Between"]},"value":{"type":"object"}},"title":"ContainsFilter"}]},"CsrGenerateResponseInfo":{"type":"object","properties":{"csr":{"type":"string","example":"MIIC8DCCAdgCAQAwfDF6MHgGA1UEAxNxqRkDxR4gWqAoe26YU1S4...XRdFpQPhpkDRQ13yeO+oq","description":"Generated CSR."}},"title":"CsrGenerateResponseInfo","description":"Response for generate CSR operation."},"CsrSpec":{"type":"object","required":["certificate_usage","subject_name"],"properties":{"certificate_usage":{"type":"string","example":"MACHINE","description":"Indicates the type of certificate based on usage.\n* MACHINE: vdm certificates","enum":["MACHINE"]},"dns_subject_alternative_names":{"type":"array","example":["server.example.com","www.vmware.com"],"description":"Subject alternative DNS names.","items":{"type":"string"}},"subject_name":{"type":"string","example":"CN=Horizon-server.example.local, OU=VMware Horizon View default certificate, O=VMware, S=California, C=CALIFORNIA","description":"Subject name."}},"title":"CsrSpec","description":"Generate Certificate Signing Request(CSR)."},"CustomizationSpecInfo":{"type":"object","properties":{"description":{"type":"string","example":"windows customization specification","description":"Customization specification description."},"guest_os":{"type":"string","example":"Windows","description":"Guest Operating system.\n* UNKNOWN: Unknown\n* WINDOWS: Windows\n* LINUX: Linux","enum":["UNKNOWN","WINDOWS","LINUX"]},"id":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","description":"Unique ID representing the customization specification."},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this customization specification from being used in desktop pool creation.","items":{"type":"string","enum":["DHCP_NOT_CONFIGURED","UNSUPPORTED_OS"]}},"name":{"type":"string","example":"windows specification","description":"Name of the customization specification."}},"title":"CustomizationSpecInfo","description":"Information related to customization specification created in vCenter."},"DatacenterInfo":{"type":"object","properties":{"id":{"type":"string","example":"datacenter-1","description":"Unique ID representing a datacenter."},"name":{"type":"string","example":"datacenter","description":"Name of the datacenter."},"path":{"type":"string","example":"/datacenter","description":"Datacenter path."}},"title":"DatacenterInfo","description":"Information related to datacenter."},"DatastoreClusterInfo":{"type":"object","properties":{"capacity_mb":{"type":"integer","format":"int64","example":946176,"description":"Maximum capacity of this datastore cluster, in MB."},"datacenter_id":{"type":"string","example":"datacenter-1","description":"ID of the datacenter for this datastore cluster."},"datastore_ids":{"type":"array","example":["datastore-29","datastore-12"],"description":"IDs of datastores which are a part of this datastore cluster.","items":{"type":"string"}},"free_space_mb":{"type":"integer","format":"int64","example":88239,"description":"Available capacity of this datastore cluster, in MB."},"host_or_cluster_id":{"type":"string","example":"domain-c15","description":"ID of the host or cluster for this datastore cluster."},"id":{"type":"string","example":"group-p1","description":"Unique ID representing this datastore cluster."},"name":{"type":"string","example":"datastoreCluster1","description":"Datastore cluster name."},"path":{"type":"string","example":"/DC/host/cls/datastoreCluster1","description":"Datastore cluster path."},"vcenter_id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"ID of the virtual center for this datastore cluster."}},"title":"DatastoreClusterInfo"},"DatastoreInfo":{"type":"object","properties":{"capacity_mb":{"type":"integer","format":"int64","example":946176,"description":"Maximum capacity of this datastore, in MB."},"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter id for this datastore."},"disk_type":{"type":"string","example":"NON_SSD","description":"Disk type of the datastore.\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.","enum":["SSD","NON_SSD","UNKNOWN","NON_VMFS"]},"file_system_type":{"type":"string","example":"VMFS","description":"File system type of the datastore.\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.","enum":["VMFS","NFS","VSAN","VVOL","UNKNOWN"]},"free_space_mb":{"type":"integer","format":"int64","example":88239,"description":"Available capacity of this datastore, in MB."},"host_or_cluster_id":{"type":"string","example":"domain-c85","description":"Host or Cluster id for this datastore."},"id":{"type":"string","example":"datastore-29","description":"Unique ID representing the datastore."},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this Datastore from being used in desktop pool/farm.","items":{"type":"string","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","example":true,"description":"Indicates if this datastore is local to a single host."},"name":{"type":"string","example":"Datastore1","description":"Datastore name."},"number_of_vms":{"type":"integer","format":"int32","example":15,"description":"Indicates the number of virtual machines the datastore has for desktop pool/farm when applicable"},"path":{"type":"string","example":"/Datacenter/host/Cluster/Datastore1","description":"Datastore path."},"vcenter_id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Virtual Center id for this datastore."},"vmfs_major_version":{"type":"string","example":5,"description":"The VMFS major version number."}},"title":"DatastoreInfo","description":"Information related to datastore."},"DatastorePathInfo":{"type":"object","properties":{"id":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","description":"Unique ID representing the datastore path."},"path":{"type":"string","example":"[datastore1] ISO images","description":"Datastore path."}},"title":"DatastorePathInfo","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","format":"double","example":15.0,"description":"Indicates maximum recommended disk space, in GB."},"mid_size_disk_gb":{"type":"number","format":"double","example":10.0,"description":"Indicates recommended disk space with 50% utilization, in GB."},"min_size_disk_gb":{"type":"number","format":"double","example":5.0,"description":"Indicates minimum recommended disk space, in GB."}},"title":"DatastoreSpaceRequirementInfo","description":"Information about Datastore Space Requirement."},"DatastoreSpaceRequirementSpec":{"type":"object","required":["pool_size","source","type","vcenter_id"],"properties":{"base_snapshot_id":{"type":"string","example":"snapshot-22","description":"Parent VM snapshot ID. Must be set if source is INSTANT_CLONE."},"base_vm_id":{"type":"string","example":"vm-34","description":"Parent VM ID. Must be set if source is INSTANT_CLONE."},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Id of inventory resource for which space requirement is to be found. Can be desktop pool or farm id."},"pool_size":{"type":"integer","format":"int32","description":"Desired size of the desktop pool or farm.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"source":{"type":"string","example":"INSTANT_CLONE","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.","enum":["FULL_CLONE","INSTANT_CLONE"]},"type":{"type":"string","example":"FARM","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.","enum":["DESKTOP_POOL","FARM"]},"use_separate_replica_and_os_disk":{"type":"boolean","example":false,"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."},"use_vsan":{"type":"boolean","example":false,"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."},"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","example":"ed3f92f3-0eef-4bf1-a405-de69f138d382","description":"ID of virtual center where parent VM or master image is present."},"vm_template_id":{"type":"string","example":"vm-344","description":"VM template ID. Must be set if source is FULL_CLONE."}},"title":"DatastoreSpaceRequirementSpec","description":"Information required to compute Datastore Space Requirement."},"DesktopPoolCloneprepCustomizationSettings":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","example":"cloneprep_postsync_script","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."},"post_synchronization_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Post synchronization script parameters."},"power_off_script_name":{"type":"string","example":"cloneprep_poweroff_script","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."},"power_off_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Power off script parameters."},"priming_computer_account":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","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."}},"title":"DesktopPoolCloneprepCustomizationSettings","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","example":"cloneprep_postsync_script","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."},"post_synchronization_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Post synchronization script parameters."},"power_off_script_name":{"type":"string","example":"cloneprep_poweroff_script","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."},"power_off_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Power off script parameters."},"priming_computer_account":{"type":"string","example":"priming","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."}},"title":"DesktopPoolCloneprepCustomizationSettingsCreateSpec","description":"Settings for CLONE_PREP customization for instant clone desktop pool."},"DesktopPoolCloneprepCustomizationSettingsUpdateSpec":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","example":"cloneprep_postsync_script","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."},"post_synchronization_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Post synchronization script parameters."},"power_off_script_name":{"type":"string","example":"cloneprep_poweroff_script","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."},"power_off_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Power off script parameters."},"priming_computer_account":{"type":"string","example":"priming","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."}},"title":"DesktopPoolCloneprepCustomizationSettingsUpdateSpec","description":"Settings for CLONE_PREP customization for Instant Clone desktop pool."},"DesktopPoolCreateSpec":{"type":"object","required":["name","type"],"properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration.
This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm."},"allow_multiple_user_assignments":{"type":"boolean","example":false,"description":"Applicable To: Dedicated manual and automated desktop pools with manual user assignment with default value as false.
Whether assignment of multiple users to a single machine is allowed.
If this is true then automatic_user_assignment should be false.
"},"allow_rds_pool_multi_session_per_user":{"type":"boolean","example":false,"description":"Applicable To: RDS desktop pools with default value as false.
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.
"},"automatic_user_assignment":{"type":"boolean","example":true,"description":"Automatic assignment of a user the first time they access the machine.
This property is applicable if user_assignment is set to DEDICATED with default value as true.
"},"category_folder_name":{"type":"string","example":"dir1","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."},"cloud_assigned":{"type":"boolean","example":false,"description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
This can be set to true from cloud session only and only when cloud_managed is set to true.
Default value is false.
"},"cloud_brokered":{"type":"boolean","example":false,"description":"Applicable To: RDS Desktop Pools with default value as false."},"cloud_managed":{"type":"boolean","example":false,"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.
Default value is false.
This property cannot be set to true, if any of the conditions are satisfied:
user is provided.
enabled is false.
supported_session_type is not DESKTOP.
global_entitlement is set.
user_assignment is DEDICATED and automatic_user_assignment is false.
Local entitlements are configured.
Any of the machines in the pool have users assigned.
cs_restriction_tags is not set.
Desktop pool type is MANUAL."},"cs_restriction_tags":{"type":"array","example":["CS1_TAG1"],"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"}},"customization_settings":{"description":"Applicable to : Automated desktop pools.
Customization settings for the desktop pool.","$ref":"#/definitions/DesktopPoolCustomizationSettingsCreateSpec"},"description":{"type":"string","example":"Desktop pool description","description":"Description of the desktop pool.","maxLength":1024},"display_assigned_machine_name":{"type":"boolean","example":false,"description":"Applicable To: Dedicated desktop pools with default value as false.
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.
"},"display_machine_alias":{"type":"boolean","example":false,"description":"Applicable To: Dedicated desktop pools with default value as false.
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."},"display_name":{"type":"string","example":"ManualPool","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","maxLength":256},"display_protocol_settings":{"description":"Display protocol settings for the desktop pool.
This property is required for all the pools except RDS desktop pool as it will use display protocol settings of the farm.","$ref":"#/definitions/DesktopPoolDisplayProtocolSettingsCreateSpec"},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Client restrictions to be applied to the desktop pool.
Default value is false."},"enable_provisioning":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools with default value as true.
Indicates whether provisioning is enabled.
"},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the desktop pool is enabled for brokering. Default value is true."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"Applicable To: RDS Desktop pool.
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."},"machines":{"type":"array","description":"Applicable To: Manual desktop pools.
List of machines to add to this desktop pool during creation.","items":{"type":"string"}},"name":{"type":"string","example":"ManualPool","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","minLength":1,"maxLength":64},"naming_method":{"type":"string","example":"SPECIFIED","description":"Applicable To: Automated desktop pool.
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.","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Network interface card settings for machines provisioned for this desktop.","items":{"$ref":"#/definitions/DesktopPoolNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"description":"Applicable to : Automated desktop pools.
Specifies the naming scheme for the automated desktop pool.
This property is required if naming_method is set to PATTERN.","$ref":"#/definitions/DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec"},"provisioning_settings":{"description":"Applicable to : Automated desktop pools.
Virtual center entities used for provisioning.","$ref":"#/definitions/DesktopPoolProvisioningSettingsCreateSpec"},"session_settings":{"description":"Session related settings for the desktop pool.
This property is required for all the pools except RDS desktop pool as it will use session settings of farm.","$ref":"#/definitions/DesktopPoolSessionSettingsCreateSpec"},"session_type":{"type":"string","example":"DESKTOP","description":"Applicable To: Managed desktop pools with default value as DESKTOP.
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* DESKTOP: Only desktop sessions are supported.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","enum":["DESKTOP","APPLICATION","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"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.","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","example":"INSTANT_CLONE","description":"Applicable To: Manual and Automated desktop pools.
Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.
\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* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL 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.","enum":["INSTANT_CLONE","LINKED_CLONE","VIRTUAL_CENTER","RDS","UNMANAGED"]},"specific_naming_settings":{"description":"Applicable to : Automated desktop pools.
Specifies the naming scheme for the automated desktop pool.
This property is required if naming_method is set to SPECIFIED.","$ref":"#/definitions/DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Applicable for Automated pools only with default value as true."},"storage_settings":{"description":"Virtual Center storage settings.","$ref":"#/definitions/DesktopPoolStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Applicable To: Managed Manual and Automated desktop pools with default value as VM.
Transparent page sharing scope for this Desktop Pool.\n* VM: Inter-VM page sharing is not permitted.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","DESKTOP_POOL","POD","GLOBAL"]},"type":{"type":"string","example":"AUTOMATED","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","example":"DEDICATED","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.
\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.","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"ID of the virtual center server.
This is required for all desktop pool except Unmanaged Manual and RDS desktop pool.
"},"view_storage_accelerator_settings":{"description":"Applicable To: Manual and automated desktop pools.
View Storage Accelerator settings.","$ref":"#/definitions/DesktopPoolViewStorageAcceleratorSettingsCreateSpec"}},"title":"DesktopPoolCreateSpec","description":"Information required to create a desktop pool."},"DesktopPoolCreateSpecV2":{"type":"object","required":["name","type"],"properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration.
This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm."},"allow_multiple_user_assignments":{"type":"boolean","example":false,"description":"Applicable To: Dedicated manual and automated desktop pools with manual user assignment with default value as false.
Whether assignment of multiple users to a single machine is allowed.
If this is true then automatic_user_assignment should be false.
"},"allow_rds_pool_multi_session_per_user":{"type":"boolean","example":false,"description":"Applicable To: RDS desktop pools with default value as false.
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.
"},"automatic_user_assignment":{"type":"boolean","example":true,"description":"Automatic assignment of a user the first time they access the machine.
This property is applicable if user_assignment is set to DEDICATED with default value as true.
"},"category_folder_name":{"type":"string","example":"dir1","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."},"cloud_assigned":{"type":"boolean","example":false,"description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
This can be set to true from cloud session only and only when cloud_managed is set to true.
Default value is false.
"},"cloud_brokered":{"type":"boolean","example":false,"description":"Applicable To: RDS Desktop Pools with default value as false."},"cloud_managed":{"type":"boolean","example":false,"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.
Default value is false.
This property cannot be set to true, if any of the conditions are satisfied:
user is provided.
enabled is false.
supported_session_type is not DESKTOP.
global_entitlement is set.
user_assignment is DEDICATED and automatic_user_assignment is false.
Local entitlements are configured.
Any of the machines in the pool have users assigned.
cs_restriction_tags is not set.
Desktop pool type is MANUAL."},"cs_restriction_tags":{"type":"array","example":["CS1_TAG1"],"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"}},"customization_settings":{"description":"Applicable to : Automated desktop pools.
Customization settings for the desktop pool.","$ref":"#/definitions/DesktopPoolCustomizationSettingsCreateSpec"},"description":{"type":"string","example":"Desktop pool description","description":"Description of the desktop pool.","maxLength":1024},"display_assigned_machine_name":{"type":"boolean","example":false,"description":"Applicable To: Dedicated desktop pools with default value as false.
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.
"},"display_machine_alias":{"type":"boolean","example":false,"description":"Applicable To: Dedicated desktop pools with default value as false.
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."},"display_name":{"type":"string","example":"ManualPool","description":"Display name of the desktop pool. If the display name is left blank, it defaults to name.","maxLength":256},"display_protocol_settings":{"description":"Display protocol settings for the desktop pool.
This property is required for all the pools except RDS desktop pool as it will use display protocol settings of the farm.","$ref":"#/definitions/DesktopPoolDisplayProtocolSettingsCreateSpec"},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Client restrictions to be applied to the desktop pool.
Default value is false."},"enable_provisioning":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools with default value as true.
Indicates whether provisioning is enabled.
"},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the desktop pool is enabled for brokering. Default value is true."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"Applicable To: RDS Desktop pool.
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."},"machines":{"type":"array","description":"Applicable To: Manual desktop pools.
List of machines to add to this desktop pool during creation.","items":{"type":"string"}},"name":{"type":"string","example":"ManualPool","description":"Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.","minLength":1,"maxLength":64},"naming_method":{"type":"string","example":"SPECIFIED","description":"Applicable To: Automated desktop pool.
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.","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Network interface card settings for machines provisioned for this desktop.","items":{"$ref":"#/definitions/DesktopPoolNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"description":"Applicable to : Automated desktop pools.
Specifies the naming scheme for the automated desktop pool.
This property is required if naming_method is set to PATTERN.","$ref":"#/definitions/DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec"},"provisioning_settings":{"description":"Applicable to : Automated desktop pools.
Virtual center entities used for provisioning.","$ref":"#/definitions/DesktopPoolProvisioningSettingsCreateSpecV2"},"session_settings":{"description":"Session related settings for the desktop pool.
This property is required for all the pools except RDS desktop pool as it will use session settings of farm.","$ref":"#/definitions/DesktopPoolSessionSettingsCreateSpec"},"session_type":{"type":"string","example":"DESKTOP","description":"Applicable To: Managed desktop pools with default value as DESKTOP.
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* DESKTOP: Only desktop sessions are supported.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","enum":["DESKTOP","APPLICATION","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"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.","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","example":"INSTANT_CLONE","description":"Applicable To: Manual and Automated desktop pools.
Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.
\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* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL 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.","enum":["INSTANT_CLONE","LINKED_CLONE","VIRTUAL_CENTER","RDS","UNMANAGED"]},"specific_naming_settings":{"description":"Applicable to : Automated desktop pools.
Specifies the naming scheme for the automated desktop pool.
This property is required if naming_method is set to SPECIFIED.","$ref":"#/definitions/DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Applicable for Automated pools only with default value as true."},"storage_settings":{"description":"Virtual Center storage settings.","$ref":"#/definitions/DesktopPoolStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Applicable To: Managed Manual and Automated desktop pools with default value as VM.
Transparent page sharing scope for this Desktop Pool.\n* VM: Inter-VM page sharing is not permitted.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","DESKTOP_POOL","POD","GLOBAL"]},"type":{"type":"string","example":"AUTOMATED","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","example":"DEDICATED","description":"Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.
\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.","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"ID of the virtual center server.
This is required for all desktop pool except Unmanaged Manual and RDS desktop pool.
"},"view_storage_accelerator_settings":{"description":"Applicable To: Manual and automated desktop pools.
View Storage Accelerator settings.","$ref":"#/definitions/DesktopPoolViewStorageAcceleratorSettingsCreateSpec"}},"title":"DesktopPoolCreateSpecV2","description":"Information required to create a desktop pool."},"DesktopPoolCustomizationSettings":{"type":"object","properties":{"ad_container_rdn":{"type":"string","example":"CN=Computers","description":"Applicable To: Full/instant clone automated desktop pools.
Full clone and Instant Clone Engine Active Directory container for SysPrep and ClonePrep."},"cloneprep_customization_settings":{"description":"Settings when ClonePrep customization is requested.","$ref":"#/definitions/DesktopPoolCloneprepCustomizationSettings"},"customization_type":{"type":"string","example":"CLONE_PREP","description":"Type of customization to use.\n* NONE: Applicable To: Full clone desktop pools.
No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.
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.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.
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.","enum":["NONE","SYS_PREP","CLONE_PREP"]},"do_not_power_on_vms_after_creation":{"type":"boolean","example":false,"description":"Whether to power on VMs after creation. This is the settings when customization will be done manually."},"instant_clone_domain_account_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To: Instant clone and Full clone desktop pools.
Instant clone or full clone domain account. This is the administrator which will add the machines to its domain upon creation."},"quickprep_customization_settings":{"description":"Settings when QuickPrep customization is requested.","$ref":"#/definitions/DesktopPoolQuickprepCustomizationSettings"},"reuse_pre_existing_accounts":{"type":"boolean","example":false,"description":"Applicable To: Manual and automated desktop pools.
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."},"sysprep_customization_spec_id":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","description":"Customization specification to use when Sysprep customization is requested."},"view_composer_domain_account_id":{"type":"string","example":"0ebb464a-8780-4860-924f-8b2d1d1b33ef","description":"Applicable To: Linked clone automated desktop pools.
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."}},"title":"DesktopPoolCustomizationSettings","description":"Customization settings."},"DesktopPoolCustomizationSettingsCreateSpec":{"type":"object","required":["customization_type"],"properties":{"ad_container_rdn":{"type":"string","example":"CN=Computers","description":"Applicable To : Instant clone and Full clone desktop pools.
This is required for instant clone desktop pools.
Instant Clone Engine and Full Clone Active Directory container for ClonePrep and SysPrep respectively."},"cloneprep_customization_settings":{"description":"Clone prep customization settings for the desktop.","$ref":"#/definitions/DesktopPoolCloneprepCustomizationSettingsCreateSpec"},"customization_type":{"type":"string","example":"CLONE_PREP","description":"Type of customization to use.\n* NONE: Applicable To: Full clone desktop pools.
No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.
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.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.
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.","enum":["NONE","SYS_PREP","CLONE_PREP"]},"do_not_power_on_vms_after_creation":{"type":"boolean","example":false,"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 to NONE with default value as false.
"},"instant_clone_domain_account_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To : Instant clone and Full clone desktop pools.
This is required for instant clone desktop pools.
This is the administrator which will add the machines to its domain upon creation."},"reuse_pre_existing_accounts":{"type":"boolean","example":false,"description":"Applicable To: Automated desktop pools with default value as false.
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.
"},"sysprep_customization_spec_id":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","description":"This is required when customization_type is set as SYS_PREP.
Customization specification to use when Sysprep customization is requested."}},"title":"DesktopPoolCustomizationSettingsCreateSpec","description":"Applicable To: Automated desktop pool.
Customization settings for Automated desktop pool."},"DesktopPoolCustomizationSettingsUpdateSpec":{"type":"object","required":["customization_type"],"properties":{"ad_container_rdn":{"type":"string","example":"CN=Computers","description":"Applicable To : Instant clone and Full clone desktop pools.
This is required for instant clone desktop pools.
Instant Clone Engine and Full Clone Active Directory container for ClonePrep and SysPrep respectively."},"cloneprep_customization_settings":{"description":"Applicable to : Instant clone desktop pools.
Settings when ClonePrep customization is requested.","$ref":"#/definitions/DesktopPoolCloneprepCustomizationSettingsUpdateSpec"},"customization_type":{"type":"string","example":"CLONE_PREP","description":"Type of customization to use.\n* NONE: Applicable To: Full clone desktop pools.
No customization.\n* SYS_PREP: Applicable To: Full clone desktop pools.
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.\n* CLONE_PREP: Applicable To: Instant clone desktop pools.
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.","enum":["NONE","SYS_PREP","CLONE_PREP"]},"do_not_power_on_vms_after_creation":{"type":"boolean","example":false,"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."},"instant_clone_domain_account_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To : Instant clone and Full clone desktop pools.
This is required for instant clone desktop pools.
This is the administrator which will add the machines to its domain upon creation."},"reuse_pre_existing_accounts":{"type":"boolean","example":false,"description":"Applicable To: Automated desktop pools.
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."},"sysprep_customization_spec_id":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","description":"This is required when customization_type is set as SYS_PREP.
Customization specification to use when Sysprep customization is requested."}},"title":"DesktopPoolCustomizationSettingsUpdateSpec","description":"Applicable To: Automated Desktop pool.
Customization settings for Automated desktop pool."},"DesktopPoolDatastoreSettings":{"type":"object","properties":{"datastore_id":{"type":"string","example":"datastore-1","description":"Id of the datastore."},"sdrs_cluster":{"type":"boolean","example":false,"description":"Whether datastore represents a Storage DRS cluster."},"storage_overcommit":{"type":"string","example":"CONSERVATIVE","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.","enum":["NONE","CONSERVATIVE","MODERATE","AGGRESSIVE","UNBOUNDED"]}},"title":"DesktopPoolDatastoreSettings","description":"Settings for a Virtual Center datastore."},"DesktopPoolDatastoreSettingsCreateSpec":{"type":"object","required":["datastore_id"],"properties":{"datastore_id":{"type":"string","example":"datastore-1","description":"Id of the datastore."},"sdrs_cluster":{"type":"boolean","example":false,"description":"Applicable to full clone desktop pools with default value as false. Indicates whether datastore represents a Storage DRS cluster."}},"title":"DesktopPoolDatastoreSettingsCreateSpec","description":"Settings for a Virtual Center datastore."},"DesktopPoolDatastoreSettingsUpdateSpec":{"type":"object","required":["datastore_id"],"properties":{"datastore_id":{"type":"string","example":"datastore-1","description":"Id of the datastore."},"sdrs_cluster":{"type":"boolean","example":false,"description":"Indicates whether datastore represents a Storage DRS cluster."}},"title":"DesktopPoolDatastoreSettingsUpdateSpec","description":"Settings for a Virtual Center datastore."},"DesktopPoolDeleteSpec":{"type":"object","properties":{"delete_from_disk":{"type":"boolean","example":false,"description":"Determines whether the machine VMs should be deleted from vCenter Server.
This must be false for RDS and unmanaged desktop pools and true for Instant Clone desktop pools.
Default value is true for IC pools and false for all other types of desktop pools.
"}},"title":"DesktopPoolDeleteSpec","description":"Information required to delete a desktop pool."},"DesktopPoolDisplayProtocolSettings":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","example":true,"description":"Indicates whether the users can choose the protocol. Default value is true."},"default_display_protocol":{"type":"string","example":"PCOIP","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.\n* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"display_protocols":{"type":"array","example":["PCOIP", "BLAST", "RDP"],"description":"List of supported display protocols for this desktop pool.Default value is [PCOIP, RDP, BLAST].","items":{"type":"string","enum":["RDP","PCOIP","BLAST"]}},"grid_vgpus_enabled":{"type":"boolean","example":false,"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."},"html_access_enabled":{"type":"boolean","example":true,"description":"This property is no longer in use for Horizon Components. It is always set to true. HTML Access, enabled by VMware 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."},"max_number_of_monitors":{"type":"integer","format":"int32","example":2,"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.","minimum":1,"maximum":4,"exclusiveMinimum":false,"exclusiveMaximum":false},"max_resolution_of_any_one_monitor":{"type":"string","example":"WUXGA","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.\n* WSXGA_PLUS: 1680x1050 resolution.\n* WUXGA: 1920x1200 resolution.\n* WQXGA: 2560x1600 resolution.\n* UHD: 3840x2160 resolution.\n* UHD_5K: 5120x2880 resolution.\n* UHD_8K: 7680x4320 resolution.","enum":["WSXGA_PLUS","WUXGA","WQXGA","UHD","UHD_5K","UHD_8K"]},"renderer3d":{"type":"string","example":true,"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.\n* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* AUTOMATIC: 3D rendering is automatic.\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.\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* DISABLED: 3D rendering is disabled.","enum":["MANAGE_BY_VSPHERE_CLIENT","AUTOMATIC","SOFTWARE","HARDWARE","DISABLED"]},"session_collaboration_enabled":{"type":"boolean","example":false,"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."},"vgpu_grid_profile":{"type":"string","example":"instant-profile","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."},"vram_size_mb":{"type":"integer","format":"int32","example":64,"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.","minimum":64,"maximum":512,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"DesktopPoolDisplayProtocolSettings","description":"Settings for the networking protocol to display the remote machine."},"DesktopPoolDisplayProtocolSettingsCreateSpec":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","example":true,"description":"Indicates whether the users can choose the protocol. Default value is true."},"default_display_protocol":{"type":"string","example":"PCOIP","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* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"grid_vgpus_enabled":{"type":"boolean","example":false,"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."},"max_number_of_monitors":{"type":"integer","format":"int32","example":2,"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.
This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.","minimum":1,"maximum":4,"exclusiveMinimum":false,"exclusiveMaximum":false},"max_resolution_of_any_one_monitor":{"type":"string","example":"WUXGA","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.
This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.\n* WSXGA_PLUS: 1680x1050 resolution.\n* WUXGA: 1920x1200 resolution.\n* WQXGA: 2560x1600 resolution.\n* UHD: 3840x2160 resolution.\n* UHD_5K: 5120x2880 resolution.\n* UHD_8K: 7680x4320 resolution.","enum":["WSXGA_PLUS","WUXGA","WQXGA","UHD","UHD_5K","UHD_8K"]},"renderer3d":{"type":"string","example":"DISABLED","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* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* AUTOMATIC: 3D rendering is automatic.\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.\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* DISABLED: 3D rendering is disabled.","enum":["MANAGE_BY_VSPHERE_CLIENT","AUTOMATIC","SOFTWARE","HARDWARE","DISABLED"]},"session_collaboration_enabled":{"type":"boolean","example":false,"description":"Applicable To: Automated and Manual pools with default value of false.
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."},"vram_size_mb":{"type":"integer","format":"int32","example":64,"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.
This property is required if renderer3d is set to AUTOMATIC, SOFTWARE or HARDWARE.","minimum":64,"maximum":512,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"DesktopPoolDisplayProtocolSettingsCreateSpec","description":"Applicable To: Automated and Manual desktop pool.
Display protocol settings for Automated and Manual desktop pool."},"DesktopPoolDisplayProtocolSettingsUpdateSpec":{"type":"object","required":["allow_users_to_choose_protocol","default_display_protocol"],"properties":{"allow_users_to_choose_protocol":{"type":"boolean","example":true,"description":"Indicates whether the users can choose the protocol."},"default_display_protocol":{"type":"string","example":"PCOIP","description":"The default display protocol for the desktop pool.\n* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"max_number_of_monitors":{"type":"integer","format":"int32","example":2,"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.","minimum":1,"maximum":4,"exclusiveMinimum":false,"exclusiveMaximum":false},"max_resolution_of_any_one_monitor":{"type":"string","example":"WUXGA","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.
This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.\n* WSXGA_PLUS: 1680x1050 resolution.\n* WUXGA: 1920x1200 resolution.\n* WQXGA: 2560x1600 resolution.\n* UHD: 3840x2160 resolution.\n* UHD_5K: 5120x2880 resolution.\n* UHD_8K: 7680x4320 resolution.","enum":["WSXGA_PLUS","WUXGA","WQXGA","UHD","UHD_5K","UHD_8K"]},"renderer3d":{"type":"string","example":"DISABLED","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* MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.\n* AUTOMATIC: 3D rendering is automatic.\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.\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* DISABLED: 3D rendering is disabled.","enum":["MANAGE_BY_VSPHERE_CLIENT","AUTOMATIC","SOFTWARE","HARDWARE","DISABLED"]},"session_collaboration_enabled":{"type":"boolean","example":false,"description":"Applicable To: Automated and Manual pools.
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."},"vram_size_mb":{"type":"integer","format":"int32","example":64,"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.","minimum":64,"maximum":512,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"DesktopPoolDisplayProtocolSettingsUpdateSpec","description":"Applicable To: Automated and Manual desktop pool.
Display protocol setting for Automated and Manual desktop pool."},"DesktopPoolInfo":{"type":"object","properties":{"description":{"type":"string","example":"Desktop pool description","description":"Description of the Desktop Pool. The maximum length is 1024 characters."},"display_name":{"type":"string","example":"pool","description":"Display name of the Desktop Pool. The maximum length is 256 characters."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the Desktop Pool is enabled for brokering."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing Desktop Pool."},"name":{"type":"string","example":"sales-pool1","description":"Name of the Desktop Pool. The maximum length is 64 characters."},"settings":{"description":"Settings related to the Desktop Pool.","$ref":"#/definitions/DesktopPoolSettings"},"source":{"type":"string","example":"INSTANT_CLONE","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* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL 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.","enum":["INSTANT_CLONE","LINKED_CLONE","VIRTUAL_CENTER","RDS","UNMANAGED"]},"type":{"type":"string","example":"AUTOMATED","description":"Type of the Desktop Pool.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","enum":["AUTOMATED","MANUAL","RDS"]}},"title":"DesktopPoolInfo","description":"Information related to Desktop Pool."},"DesktopPoolInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'."},"allow_multiple_user_assignments":{"type":"boolean","example":true,"description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.
Whether assignment of multiple users to a single machine is allowed.
Supported Filters: 'Equals'."},"allow_rds_pool_multi_session_per_user":{"type":"boolean","example":false,"description":"Applicable To: RDS desktop pools.
Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable."},"automatic_user_assignment":{"type":"boolean","example":false,"description":"Applicable To: Dedicated manual and automated desktop pools.
Automatic assignment of a user the first time they access the machine.
Supported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1","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."},"cloud_assigned":{"type":"boolean","example":false,"description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
Supported Filters: 'Equals'."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.
Supported Filters: 'Equals'."},"cs_restriction_tags":{"type":"array","example":["CS1_TAG1"],"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.","items":{"type":"string"}},"customization_settings":{"description":"Applicable To: Automated desktop pools.
Customization settings for this desktop pool.","$ref":"#/definitions/DesktopPoolCustomizationSettings"},"delete_in_progress":{"type":"boolean","example":false,"description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.
Supported Filters: 'Equals'."},"description":{"type":"string","example":"Desktop pool description","description":"Description of the Desktop Pool. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_assigned_machine_name":{"type":"boolean","example":false,"description":"Applicable To: Dedicated manual and automated desktop pools.
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.
Supported Filters: 'Equals'."},"display_name":{"type":"string","example":"pool","description":"Display name of the Desktop Pool. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_protocol_settings":{"description":"Remote display protocol settings. These relate to RDP/PCoIP/BLAST.","$ref":"#/definitions/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Client restrictions to be applied to the desktop pool.
Supported Filters: 'Equals'."},"enable_provisioning":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools.
Whether provisioning is enabled.
Supported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the Desktop Pool is enabled for brokering.
Supported Filters: 'Equals'."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"Applicable To: RDS desktop pools.
Farm needed to create RDS desktop pool.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing Desktop Pool.
Supported Filters: 'Equals'."},"image_source":{"type":"string","example":"VIRTUAL_CENTER","description":"Applicable To: Automated desktop pools.
Source of image used in the desktop pool.
Supported Filters: 'Equals'.\n* VIRTUAL_CENTER: Image was created in virtual center.\n* IMAGE_CATALOG: Image was created in image catalog.","enum":["VIRTUAL_CENTER","IMAGE_CATALOG"]},"name":{"type":"string","example":"sales-pool1","description":"Name of the Desktop Pool. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.
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":"#/definitions/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"description":"Applicable To: Automated desktop pools.
Pattern naming settings.","$ref":"#/definitions/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"description":"Applicable To: Automated desktop pools.
Virtual center entities used for provisioning.","$ref":"#/definitions/DesktopPoolProvisioningSettings"},"provisioning_status_data":{"description":"Applicable To: Automated desktop pools.
Provisioning status data about this desktop pool.","$ref":"#/definitions/DesktopPoolProvisioningStatusData"},"session_settings":{"description":"Includes machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare.","$ref":"#/definitions/DesktopPoolSessionSettingsV2"},"session_type":{"type":"string","example":"DESKTOP","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.
Supported Filters: 'Equals'.\n* DESKTOP: Only desktop sessions are supported.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","enum":["DESKTOP","APPLICATION","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"type":"array","example":["Desktop"],"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.","items":{"type":"string"}},"source":{"type":"string","example":"INSTANT_CLONE","description":"Source of the Machines in this Desktop Pool.
Supported Filters: 'Equals'.\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* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL 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.","enum":["INSTANT_CLONE","LINKED_CLONE","VIRTUAL_CENTER","RDS","UNMANAGED"]},"specific_naming_settings":{"description":"Applicable To: Automated desktop pools.
Specified name settings.","$ref":"#/definitions/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools.
Whether provisioning on all machines stops on error."},"storage_settings":{"description":"Applicable To: Automated desktop pools.
Virtual Center storage settings.","$ref":"#/definitions/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Applicable To: Manual and automated desktop pools.
The transparent page sharing scope.\n* VM: Inter-VM page sharing is not permitted.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","DESKTOP_POOL","POD","GLOBAL"]},"type":{"type":"string","example":"AUTOMATED","description":"Type of the desktop pool.
Supported Filters: 'Equals'.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","example":"DEDICATED","description":"Applicable To: Manual and automated desktop pools.
User assignment scheme.
Supported Filters: 'Equals'.\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.","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"Applicable To: Manual and automated desktop pools.
Virtual Center that manages the machines of the desktop pool.
Supported Filters: 'Equals'."},"view_storage_accelerator_settings":{"description":"Applicable To: Manual and automated desktop pools.
View Storage Accelerator settings.","$ref":"#/definitions/DesktopPoolViewStorageAcceleratorSettings"}},"title":"DesktopPoolInfoV2","description":"Information related to Desktop Pool.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"DesktopPoolInfoV3":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'."},"allow_multiple_user_assignments":{"type":"boolean","example":true,"description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.
Whether assignment of multiple users to a single machine is allowed.
Supported Filters: 'Equals'."},"allow_rds_pool_multi_session_per_user":{"type":"boolean","example":false,"description":"Applicable To: RDS desktop pools.
Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable."},"automatic_user_assignment":{"type":"boolean","example":false,"description":"Applicable To: Dedicated manual and automated desktop pools.
Automatic assignment of a user the first time they access the machine.
Supported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1","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."},"cloud_assigned":{"type":"boolean","example":false,"description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
Supported Filters: 'Equals'."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.
Supported Filters: 'Equals'."},"cs_restriction_tags":{"type":"array","example":["CS1_TAG1"],"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.","items":{"type":"string"}},"customization_settings":{"description":"Applicable To: Automated desktop pools.
Customization settings for this desktop pool.","$ref":"#/definitions/DesktopPoolCustomizationSettings"},"delete_in_progress":{"type":"boolean","example":false,"description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.
Supported Filters: 'Equals'."},"description":{"type":"string","example":"Desktop pool description","description":"Description of the Desktop Pool. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_assigned_machine_name":{"type":"boolean","example":false,"description":"Applicable To: Dedicated manual and automated desktop pools.
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.
Supported Filters: 'Equals'."},"display_machine_alias":{"type":"boolean","example":true,"description":"Decides the visibility of the machine alias to the user."},"display_name":{"type":"string","example":"pool","description":"Display name of the Desktop Pool. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_protocol_settings":{"description":"Remote display protocol settings. These relate to RDP/PCoIP/BLAST.","$ref":"#/definitions/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Client restrictions to be applied to the desktop pool.
Supported Filters: 'Equals'."},"enable_provisioning":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools.
Whether provisioning is enabled.
Supported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the Desktop Pool is enabled for brokering.
Supported Filters: 'Equals'."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"Applicable To: RDS desktop pools.
Farm needed to create RDS desktop pool.
Supported Filters: 'Equals'."},"global_desktop_entitlement_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","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.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing Desktop Pool.
Supported Filters: 'Equals'."},"image_source":{"type":"string","example":"VIRTUAL_CENTER","description":"Applicable To: Automated desktop pools.
Source of image used in the desktop pool.
Supported Filters: 'Equals'.\n* VIRTUAL_CENTER: Image was created in virtual center.\n* IMAGE_CATALOG: Image was created in image catalog.","enum":["VIRTUAL_CENTER","IMAGE_CATALOG"]},"name":{"type":"string","example":"sales-pool1","description":"Name of the Desktop Pool. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.
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":"#/definitions/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"description":"Applicable To: Automated desktop pools.
Pattern naming settings.","$ref":"#/definitions/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"description":"Applicable To: Automated desktop pools.
Virtual center entities used for provisioning.","$ref":"#/definitions/DesktopPoolProvisioningSettings"},"provisioning_status_data":{"description":"Applicable To: Automated desktop pools.
Provisioning status data about this desktop pool.","$ref":"#/definitions/DesktopPoolProvisioningStatusData"},"session_settings":{"description":"Includes machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare.","$ref":"#/definitions/DesktopPoolSessionSettingsV2"},"session_type":{"type":"string","example":"DESKTOP","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.
Supported Filters: 'Equals'.\n* DESKTOP: Only desktop sessions are supported.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","enum":["DESKTOP","APPLICATION","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"type":"array","example":["Desktop"],"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.","items":{"type":"string"}},"source":{"type":"string","example":"INSTANT_CLONE","description":"Source of the Machines in this Desktop Pool.
Supported Filters: 'Equals'.\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* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL 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.","enum":["INSTANT_CLONE","LINKED_CLONE","VIRTUAL_CENTER","RDS","UNMANAGED"]},"specific_naming_settings":{"description":"Applicable To: Automated desktop pools.
Specified name settings.","$ref":"#/definitions/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools.
Whether provisioning on all machines stops on error."},"storage_settings":{"description":"Applicable To: Automated desktop pools.
Virtual Center storage settings.","$ref":"#/definitions/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Applicable To: Manual and automated desktop pools.
The transparent page sharing scope.\n* VM: Inter-VM page sharing is not permitted.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","DESKTOP_POOL","POD","GLOBAL"]},"type":{"type":"string","example":"AUTOMATED","description":"Type of the desktop pool.
Supported Filters: 'Equals'.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","example":"DEDICATED","description":"Applicable To: Manual and automated desktop pools.
User assignment scheme.
Supported Filters: 'Equals'.\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.","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"Applicable To: Manual and automated desktop pools.
Virtual Center that manages the machines of the desktop pool.
Supported Filters: 'Equals'."},"view_storage_accelerator_settings":{"description":"Applicable To: Manual and automated desktop pools.
View Storage Accelerator settings.","$ref":"#/definitions/DesktopPoolViewStorageAcceleratorSettings"}},"title":"DesktopPoolInfoV3","description":"Information related to Desktop Pool.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"DesktopPoolInfoV4":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'."},"allow_multiple_user_assignments":{"type":"boolean","example":true,"description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.
Whether assignment of multiple users to a single machine is allowed.
Supported Filters: 'Equals'."},"allow_rds_pool_multi_session_per_user":{"type":"boolean","example":false,"description":"Applicable To: RDS desktop pools.
Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable."},"automatic_user_assignment":{"type":"boolean","example":false,"description":"Applicable To: Dedicated manual and automated desktop pools.
Automatic assignment of a user the first time they access the machine.
Supported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1","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."},"cloud_assigned":{"type":"boolean","example":false,"description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
Supported Filters: 'Equals'."},"cloud_brokered":{"type":"boolean","example":false,"description":"Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.
Supported Filters: 'Equals'."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.
Supported Filters: 'Equals'."},"cs_restriction_tags":{"type":"array","example":["CS1_TAG1"],"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.","items":{"type":"string"}},"customization_settings":{"description":"Applicable To: Automated desktop pools.
Customization settings for this desktop pool.","$ref":"#/definitions/DesktopPoolCustomizationSettings"},"delete_in_progress":{"type":"boolean","example":false,"description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.
Supported Filters: 'Equals'."},"description":{"type":"string","example":"Desktop pool description","description":"Description of the Desktop Pool. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_assigned_machine_name":{"type":"boolean","example":false,"description":"Applicable To: Dedicated manual and automated desktop pools.
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.
Supported Filters: 'Equals'."},"display_machine_alias":{"type":"boolean","example":true,"description":"Decides the visibility of the machine alias to the user."},"display_name":{"type":"string","example":"pool","description":"Display name of the Desktop Pool. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_protocol_settings":{"description":"Remote display protocol settings. These relate to RDP/PCoIP/BLAST.","$ref":"#/definitions/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Client restrictions to be applied to the desktop pool.
Supported Filters: 'Equals'."},"enable_provisioning":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools.
Whether provisioning is enabled.
Supported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the Desktop Pool is enabled for brokering.
Supported Filters: 'Equals'."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"Applicable To: RDS desktop pools.
Farm needed to create RDS desktop pool.
Supported Filters: 'Equals'."},"global_desktop_entitlement_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","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.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing Desktop Pool.
Supported Filters: 'Equals'."},"image_source":{"type":"string","example":"VIRTUAL_CENTER","description":"Applicable To: Automated desktop pools.
Source of image used in the desktop pool.
Supported Filters: 'Equals'.\n* VIRTUAL_CENTER: Image was created in virtual center.\n* IMAGE_CATALOG: Image was created in image catalog.","enum":["VIRTUAL_CENTER","IMAGE_CATALOG"]},"name":{"type":"string","example":"sales-pool1","description":"Name of the Desktop Pool. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.
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":"#/definitions/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"description":"Applicable To: Automated desktop pools.
Pattern naming settings.","$ref":"#/definitions/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"description":"Applicable To: Automated desktop pools.
Virtual center entities used for provisioning.","$ref":"#/definitions/DesktopPoolProvisioningSettings"},"provisioning_status_data":{"description":"Applicable To: Automated desktop pools.
Provisioning status data about this desktop pool.","$ref":"#/definitions/DesktopPoolProvisioningStatusData"},"session_settings":{"description":"Includes machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare.","$ref":"#/definitions/DesktopPoolSessionSettingsV2"},"session_type":{"type":"string","example":"DESKTOP","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.
Supported Filters: 'Equals'.\n* DESKTOP: Only desktop sessions are supported.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","enum":["DESKTOP","APPLICATION","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"type":"array","example":["Desktop"],"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.","items":{"type":"string"}},"source":{"type":"string","example":"INSTANT_CLONE","description":"Source of the Machines in this Desktop Pool.
Supported Filters: 'Equals'.\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* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL 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.","enum":["INSTANT_CLONE","LINKED_CLONE","VIRTUAL_CENTER","RDS","UNMANAGED"]},"specific_naming_settings":{"description":"Applicable To: Automated desktop pools.
Specified name settings.","$ref":"#/definitions/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools.
Whether provisioning on all machines stops on error."},"storage_settings":{"description":"Applicable To: Automated desktop pools.
Virtual Center storage settings.","$ref":"#/definitions/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Applicable To: Manual and automated desktop pools.
The transparent page sharing scope.\n* VM: Inter-VM page sharing is not permitted.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","DESKTOP_POOL","POD","GLOBAL"]},"type":{"type":"string","example":"AUTOMATED","description":"Type of the desktop pool.
Supported Filters: 'Equals'.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","example":"DEDICATED","description":"Applicable To: Manual and automated desktop pools.
User assignment scheme.
Supported Filters: 'Equals'.\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.","enum":["DEDICATED","FLOATING"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"Applicable To: Manual and automated desktop pools.
Virtual Center that manages the machines of the desktop pool.
Supported Filters: 'Equals'."},"view_storage_accelerator_settings":{"description":"Applicable To: Manual and automated desktop pools.
View Storage Accelerator settings.","$ref":"#/definitions/DesktopPoolViewStorageAcceleratorSettings"}},"title":"DesktopPoolInfoV4","description":"Information related to Desktop Pool.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"DesktopPoolInfoV5":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'."},"allow_multiple_user_assignments":{"type":"boolean","example":true,"description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.
Whether assignment of multiple users to a single machine is allowed.
Supported Filters: 'Equals'."},"allow_rds_pool_multi_session_per_user":{"type":"boolean","example":false,"description":"Applicable To: RDS desktop pools.
Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable."},"automatic_user_assignment":{"type":"boolean","example":false,"description":"Applicable To: Dedicated manual and automated desktop pools.
Automatic assignment of a user the first time they access the machine.
Supported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1","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."},"cloud_assigned":{"type":"boolean","example":false,"description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
Supported Filters: 'Equals'."},"cloud_brokered":{"type":"boolean","example":false,"description":"Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.
Supported Filters: 'Equals'."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.
Supported Filters: 'Equals'."},"cs_restriction_tags":{"type":"array","example":["CS1_TAG1"],"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.","items":{"type":"string"}},"customization_settings":{"description":"Applicable To: Automated desktop pools.
Customization settings for this desktop pool.","$ref":"#/definitions/DesktopPoolCustomizationSettings"},"delete_in_progress":{"type":"boolean","example":false,"description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.
Supported Filters: 'Equals'."},"description":{"type":"string","example":"Desktop pool description","description":"Description of the Desktop Pool. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_assigned_machine_name":{"type":"boolean","example":false,"description":"Applicable To: Dedicated manual and automated desktop pools.
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.
Supported Filters: 'Equals'."},"display_machine_alias":{"type":"boolean","example":true,"description":"Decides the visibility of the machine alias to the user."},"display_name":{"type":"string","example":"pool","description":"Display name of the Desktop Pool. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_protocol_settings":{"description":"Remote display protocol settings. These relate to RDP/PCoIP/BLAST.","$ref":"#/definitions/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Client restrictions to be applied to the desktop pool.
Supported Filters: 'Equals'."},"enable_provisioning":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools.
Whether provisioning is enabled.
Supported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the Desktop Pool is enabled for brokering.
Supported Filters: 'Equals'."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"Applicable To: RDS desktop pools.
Farm needed to create RDS desktop pool.
Supported Filters: 'Equals'."},"global_desktop_entitlement_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","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.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing Desktop Pool.
Supported Filters: 'Equals'."},"image_source":{"type":"string","example":"VIRTUAL_CENTER","description":"Applicable To: Automated desktop pools.
Source of image used in the desktop pool.
Supported Filters: 'Equals'.\n* VIRTUAL_CENTER: Image was created in virtual center.\n* IMAGE_CATALOG: Image was created in image catalog.","enum":["VIRTUAL_CENTER","IMAGE_CATALOG"]},"name":{"type":"string","example":"sales-pool1","description":"Name of the Desktop Pool. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"naming_method":{"type":"string","example":"SPECIFIED","description":"Naming method for the desktop pool.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.
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":"#/definitions/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"description":"Applicable To: Automated desktop pools.
Pattern naming settings.","$ref":"#/definitions/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"description":"Applicable To: Automated desktop pools.
Virtual center entities used for provisioning.","$ref":"#/definitions/DesktopPoolProvisioningSettings"},"provisioning_status_data":{"description":"Applicable To: Automated desktop pools.
Provisioning status data about this desktop pool.","$ref":"#/definitions/DesktopPoolProvisioningStatusData"},"session_settings":{"description":"Includes machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare.","$ref":"#/definitions/DesktopPoolSessionSettingsV3"},"session_type":{"type":"string","example":"DESKTOP","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.
Supported Filters: 'Equals'.\n* DESKTOP: Only desktop sessions are supported.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","enum":["DESKTOP","APPLICATION","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","example":"INSTANT_CLONE","description":"Source of the Machines in this Desktop Pool.
Supported Filters: 'Equals'.\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* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL 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.","enum":["INSTANT_CLONE","LINKED_CLONE","VIRTUAL_CENTER","RDS","UNMANAGED"]},"specific_naming_settings":{"description":"Applicable To: Automated desktop pools.
Specified name settings.","$ref":"#/definitions/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools.
Whether provisioning on all machines stops on error."},"storage_settings":{"description":"Applicable To: Automated desktop pools.
Virtual Center storage settings.","$ref":"#/definitions/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Applicable To: Manual and automated desktop pools.
The transparent page sharing scope.\n* VM: Inter-VM page sharing is not permitted.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","DESKTOP_POOL","POD","GLOBAL"]},"type":{"type":"string","example":"AUTOMATED","description":"Type of the desktop pool.
Supported Filters: 'Equals'.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","example":"DEDICATED","description":"Applicable To: Manual and automated desktop pools.
User assignment scheme.
Supported Filters: 'Equals'.\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.","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","format":"int32","example":1,"description":"Count of user or group entitlements present for the desktop pool."},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"Applicable To: Manual and automated desktop pools.
Virtual Center that manages the machines of the desktop pool.
Supported Filters: 'Equals'."},"view_storage_accelerator_settings":{"description":"Applicable To: Manual and automated desktop pools.
View Storage Accelerator settings.","$ref":"#/definitions/DesktopPoolViewStorageAcceleratorSettings"}},"title":"DesktopPoolInfoV5","description":"Information related to Desktop Pool.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"DesktopPoolInfoV6":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'."},"allow_multiple_user_assignments":{"type":"boolean","example":true,"description":"Applicable To: Dedicated manual and automated desktop pools (except linked clone pools) with manual user assignment.
Whether assignment of multiple users to a single machine is allowed.
Supported Filters: 'Equals'."},"allow_rds_pool_multi_session_per_user":{"type":"boolean","example":false,"description":"Applicable To: RDS desktop pools.
Whether multiple sessions are allowed per user for this pool.For other desktop pools, allow_multiple_sessions_per_user in sessionSettings will be applicable."},"automatic_user_assignment":{"type":"boolean","example":false,"description":"Applicable To: Dedicated manual and automated desktop pools.
Automatic assignment of a user the first time they access the machine.
Supported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1","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."},"cloud_assigned":{"type":"boolean","example":false,"description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
Supported Filters: 'Equals'."},"cloud_brokered":{"type":"boolean","example":false,"description":"Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.
Supported Filters: 'Equals'."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.
Supported Filters: 'Equals'."},"cs_restriction_tags":{"type":"array","example":["CS1_TAG1"],"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.","items":{"type":"string"}},"customization_settings":{"description":"Applicable To: Automated desktop pools.
Customization settings for this desktop pool.","$ref":"#/definitions/DesktopPoolCustomizationSettings"},"delete_in_progress":{"type":"boolean","example":false,"description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false.
Supported Filters: 'Equals'."},"description":{"type":"string","example":"Desktop pool description","description":"Description of the Desktop Pool. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_assigned_machine_name":{"type":"boolean","example":false,"description":"Applicable To: Dedicated manual and automated desktop pools.
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.
Supported Filters: 'Equals'."},"display_machine_alias":{"type":"boolean","example":true,"description":"Decides the visibility of the machine alias to the user."},"display_name":{"type":"string","example":"pool","description":"Display name of the Desktop Pool. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_protocol_settings":{"description":"Remote display protocol settings. These relate to RDP/PCoIP/BLAST.","$ref":"#/definitions/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Client restrictions to be applied to the desktop pool.
Supported Filters: 'Equals'."},"enable_provisioning":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools.
Whether provisioning is enabled.
Supported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the Desktop Pool is enabled for brokering.
Supported Filters: 'Equals'."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"Applicable To: RDS desktop pools.
Farm needed to create RDS desktop pool.
Supported Filters: 'Equals'."},"global_desktop_entitlement_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","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.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing Desktop Pool.
Supported Filters: 'Equals'."},"image_source":{"type":"string","example":"VIRTUAL_CENTER","description":"Applicable To: Automated desktop pools.
Source of image used in the desktop pool.
Supported Filters: 'Equals'.\n* VIRTUAL_CENTER: Image was created in virtual center.\n* IMAGE_CATALOG: Image was created in image catalog.","enum":["VIRTUAL_CENTER","IMAGE_CATALOG"]},"name":{"type":"string","example":"sales-pool1","description":"Name of the Desktop Pool. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"naming_method":{"type":"string","example":"SPECIFIED","description":"Naming method for the desktop pool.\n* SPECIFIED: List of specified names. All provisioning is done up-front.\n* PATTERN: Naming pattern.","enum":["SPECIFIED","PATTERN"]},"nics":{"type":"array","description":"Applicable To: Automated desktop pools.
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":"#/definitions/DesktopPoolNetworkInterfaceCardSettings"}},"pattern_naming_settings":{"description":"Applicable To: Automated desktop pools.
Pattern naming settings.","$ref":"#/definitions/DesktopPoolVirtualMachinePatternNamingSettings"},"provisioning_settings":{"description":"Applicable To: Automated desktop pools.
Virtual center entities used for provisioning.","$ref":"#/definitions/DesktopPoolProvisioningSettingsV2"},"provisioning_status_data":{"description":"Applicable To: Automated desktop pools.
Provisioning status data about this desktop pool.","$ref":"#/definitions/DesktopPoolProvisioningStatusDataV2"},"session_settings":{"description":"Includes machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare.","$ref":"#/definitions/DesktopPoolSessionSettingsV3"},"session_type":{"type":"string","example":"DESKTOP","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.
Supported Filters: 'Equals'.\n* DESKTOP: Only desktop sessions are supported.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","enum":["DESKTOP","APPLICATION","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"description":"Locations of the category folder in the user's OS containing a shortcut to the desktop pool.\n","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"source":{"type":"string","example":"INSTANT_CLONE","description":"Source of the Machines in this Desktop Pool.
Supported Filters: 'Equals'.\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* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL 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.","enum":["INSTANT_CLONE","LINKED_CLONE","VIRTUAL_CENTER","RDS","UNMANAGED"]},"specific_naming_settings":{"description":"Applicable To: Automated desktop pools.
Specified name settings.","$ref":"#/definitions/DesktopPoolVirtualMachineSpecifiedNamingSettings"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools.
Whether provisioning on all machines stops on error."},"storage_settings":{"description":"Applicable To: Automated desktop pools.
Virtual Center storage settings.","$ref":"#/definitions/DesktopPoolStorageSettings"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Applicable To: Manual and automated desktop pools.
The transparent page sharing scope.\n* VM: Inter-VM page sharing is not permitted.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","DESKTOP_POOL","POD","GLOBAL"]},"type":{"type":"string","example":"AUTOMATED","description":"Type of the desktop pool.
Supported Filters: 'Equals'.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","enum":["AUTOMATED","MANUAL","RDS"]},"user_assignment":{"type":"string","example":"DEDICATED","description":"Applicable To: Manual and automated desktop pools.
User assignment scheme.
Supported Filters: 'Equals'.\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.","enum":["DEDICATED","FLOATING"]},"user_group_count":{"type":"integer","format":"int32","example":1,"description":"Count of user or group entitlements present for the desktop pool."},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"Applicable To: Manual and automated desktop pools.
Virtual Center that manages the machines of the desktop pool.
Supported Filters: 'Equals'."},"view_storage_accelerator_settings":{"description":"Applicable To: Manual and automated desktop pools.
View Storage Accelerator settings.","$ref":"#/definitions/DesktopPoolViewStorageAcceleratorSettings"}},"title":"DesktopPoolInfoV6","description":"Information related to Desktop Pool.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"DesktopPoolInstantClonePushImageSettings":{"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","example":false,"description":"Whether to add Virtual TPM device."},"logoff_policy":{"type":"string","example":"WAIT_FOR_LOGOFF","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.","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"start_time":{"type":"integer","format":"int64","example":1587081283000,"description":"When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time."},"stop_on_first_error":{"type":"boolean","example":true,"description":"Indicates that the operation should stop on first error."}},"title":"DesktopPoolInstantClonePushImageSettings","description":"Settings for the push image operation."},"DesktopPoolMetricsInfo":{"type":"object","properties":{"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the desktop pool."},"num_connected_sessions":{"type":"integer","format":"int32","example":50,"description":"Number of connected sessions of the desktop pool."},"num_machines":{"type":"integer","format":"int32","example":100,"description":"Number of machines in the desktop pool."},"occupancy_count":{"type":"integer","format":"int32","example":60,"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."}},"title":"DesktopPoolMetricsInfo","description":"Metrics related to desktop pool."},"DesktopPoolNetworkInterfaceCardSettings":{"type":"object","properties":{"network_interface_card_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","description":"The network interface card id for these settings."},"network_interface_card_name":{"type":"string","example":"Network adapter 1","description":"The network interface card name."},"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.
If this is unset, the feature is disabled.
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.
","items":{"$ref":"#/definitions/NetworkLabelAssignmentSettings"}}},"title":"DesktopPoolNetworkInterfaceCardSettings","description":"Network interface card settings for machines provisioned for this desktop pool."},"DesktopPoolNetworkInterfaceCardSettingsCreateSpec":{"type":"object","required":["network_interface_card_id"],"properties":{"network_interface_card_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","description":"The network interface card id for these settings."},"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.
If this is unset, the feature is disabled.
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.
","items":{"$ref":"#/definitions/DesktopPoolNetworkLabelAssignmentSettingsCreateSpec"}}},"title":"DesktopPoolNetworkInterfaceCardSettingsCreateSpec","description":"Applicable To: Instant clone desktop pool.
Network interface card settings for machines provisioned for the instant clone desktop pool."},"DesktopPoolNetworkInterfaceCardSettingsUpdateSpec":{"type":"object","required":["network_interface_card_id"],"properties":{"network_interface_card_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","description":"The network interface card id for these settings."},"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.
If this is unset, the feature is disabled.
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.
","items":{"$ref":"#/definitions/DesktopPoolNetworkLabelAssignmentSettingsUpdateSpec"}}},"title":"DesktopPoolNetworkInterfaceCardSettingsUpdateSpec","description":"Applicable To: Instant Clone desktop pool.
Network interface card settings for machines provisioned for Instant Clone desktop pool."},"DesktopPoolNetworkLabelAssignmentSettingsCreateSpec":{"type":"object","required":["max_label_type","network_label_name"],"properties":{"enabled":{"type":"boolean","example":true,"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.
Default value is true.
"},"max_label":{"type":"integer","format":"int32","example":1,"description":"The maximum number of times this network label can be assigned to a machine.
"},"max_label_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","example":"vm-network","description":"The network label name.
"}},"title":"DesktopPoolNetworkLabelAssignmentSettingsCreateSpec","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":{"type":"object","required":["enabled","max_label","max_label_type","network_label_name"],"properties":{"enabled":{"type":"boolean","example":true,"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."},"max_label":{"type":"integer","format":"int32","example":1,"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."},"max_label_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","example":"vm-network","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."}},"title":"DesktopPoolNetworkLabelAssignmentSettingsUpdateSpec","description":"Specification for an individual network label assignment, stipulating the label and how many times it may be assigned to machines with this spec."},"DesktopPoolProvisioningSettings":{"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","example":false,"description":"Whether to add Virtual TPM device."},"base_snapshot_id":{"type":"string","example":"snapshot-1","description":"Applicable To: Linked/instant clone automated desktop pools.
Base image snapshot for linked clone desktop pool and current image snapshot for instant clone desktop pool."},"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter within which the desktop pool is configured."},"host_or_cluster_id":{"type":"string","example":"domain-s425","description":"Host or cluster where the machines are deployed in."},"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To: Full/instant clone automated desktop pools.
Image management stream used in desktop pool when Image Management feature is enabled.
Supported Filters: 'Equals'."},"im_tag_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To: Full/instant clone automated desktop pools.
Image management tag associated with the selected image management stream which is used in desktop pool when Image Management feature is enabled.
Supported Filters: 'Equals'."},"min_ready_vms_on_vcomposer_maintenance":{"type":"integer","format":"int32","example":10,"description":"Applicable To: Linked clone automated desktop pools.
Minimum number of ready (provisioned) machines during View Composer maintenance operations."},"parent_vm_id":{"type":"string","example":"vm-2","description":"Applicable To: Linked/instant clone automated desktop pools.
Base image VM for linked clone desktop pool and current image for instant clone desktop pool."},"resource_pool_id":{"type":"string","example":"resgroup-1","description":"Resource pool to deploy the machines."},"vm_folder_id":{"type":"string","example":"group-v1","description":"VM folder where the machines are deployed to."},"vm_template_id":{"type":"string","example":"vm-1","description":"Applicable To: Full clone automated desktop pools.
Template from which full clone machines are deployed."}},"title":"DesktopPoolProvisioningSettings","description":"Virtual Center provisioning settings for the automated desktop pool."},"DesktopPoolProvisioningSettingsCreateSpec":{"type":"object","required":["host_or_cluster_id","resource_pool_id","vm_folder_id"],"properties":{"add_virtual_tpm":{"type":"boolean","example":false,"description":"Indicates whether to add Virtual TPM device.
Default value is false."},"base_snapshot_id":{"type":"string","example":"snapshot-1","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."},"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter within which the desktop pool is configured."},"host_or_cluster_id":{"type":"string","example":"domain-s425","description":"Host or cluster where the machines are deployed in.
For Instant clone desktops it can only be set to a cluster id.
"},"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To: Automated desktop pools.
This is required when vm_template_id, parent_vm_id and base_snapshot_id are not set."},"im_tag_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To: Automated desktop pools.
This is required when im_stream_Id is set."},"parent_vm_id":{"type":"string","example":"vm-2","description":"This property can be set only when source is set to INSTANT_CLONE."},"resource_pool_id":{"type":"string","example":"resgroup-1","description":"Resource pool to deploy the machines."},"vm_folder_id":{"type":"string","example":"group-v1","description":"VM folder where the machines are deployed to."},"vm_template_id":{"type":"string","example":"vm-1","description":"Applicable To: Full clone desktop pools.
This is required if parent_vm_id and base_snapshot_id are not set.
"}},"title":"DesktopPoolProvisioningSettingsCreateSpec","description":"Applicable To: Automated desktop pool.
Virtual center provisioning settings for Automated desktop pool."},"DesktopPoolProvisioningSettingsCreateSpecV2":{"type":"object","required":["host_or_cluster_id","resource_pool_id","vm_folder_id"],"properties":{"add_virtual_tpm":{"type":"boolean","example":false,"description":"Indicates whether to add Virtual TPM device.
Default value is false."},"base_snapshot_id":{"type":"string","example":"snapshot-1","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."},"compute_profile_num_cores_per_socket":{"type":"integer","format":"int32","example":1,"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. ","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"compute_profile_num_cpus":{"type":"integer","format":"int32","example":4,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"compute_profile_ram_mb":{"type":"integer","format":"int32","example":4096,"description":"Indicates the RAM in MB in the compute profile to be configured on clones.","minimum":1024,"exclusiveMinimum":false,"exclusiveMaximum":false},"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter within which the desktop pool is configured."},"host_or_cluster_id":{"type":"string","example":"domain-s425","description":"Host or cluster where the machines are deployed in.
For Instant clone desktops it can only be set to a cluster id.
"},"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To: Automated desktop pools.
This is required when vm_template_id, parent_vm_id and base_snapshot_id are not set."},"im_tag_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To: Automated desktop pools.
This is required when im_stream_Id is set."},"parent_vm_id":{"type":"string","example":"vm-2","description":"This property can be set only when source is set to INSTANT_CLONE."},"resource_pool_id":{"type":"string","example":"resgroup-1","description":"Resource pool to deploy the machines."},"vm_folder_id":{"type":"string","example":"group-v1","description":"VM folder where the machines are deployed to."},"vm_template_id":{"type":"string","example":"vm-1","description":"Applicable To: Full clone desktop pools.
This is required if parent_vm_id and base_snapshot_id are not set.
"}},"title":"DesktopPoolProvisioningSettingsCreateSpecV2","description":"Virtual center provisioning settings for automated desktop pool"},"DesktopPoolProvisioningSettingsUpdateSpec":{"type":"object","required":["host_or_cluster_id","resource_pool_id"],"properties":{"host_or_cluster_id":{"type":"string","example":"domain-s425","description":"Host or cluster where the machines are deployed in."},"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To: Full clone desktop pools.
This is required when vm_template_id is not set."},"im_tag_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To: Full clone desktop pools.
This is required when im_stream_id is set."},"resource_pool_id":{"type":"string","example":"resgroup-1","description":"Resource pool to deploy the machines."},"vm_template_id":{"type":"string","example":"vm-1","description":"Applicable To: Full clone desktop pools.
Template from which full clone machines are deployed."}},"title":"DesktopPoolProvisioningSettingsUpdateSpec","description":"Applicable To: Automated desktop pool.
Virtual Center provisioning settings for automated desktop pool."},"DesktopPoolProvisioningSettingsV2":{"type":"object","properties":{"add_virtual_tpm":{"type":"boolean","example":false,"description":"Whether to add Virtual TPM device."},"base_snapshot_id":{"type":"string","example":"snapshot-1","description":"Applicable To: Linked/instant clone automated desktop pools.
Base image snapshot for linked clone desktop pool and current image snapshot for instant clone desktop pool."},"compute_profile_num_cores_per_socket":{"type":"integer","format":"int32","example":1,"description":"Indicates the number of cores per socket for the CPU in the compute profile configured on clones."},"compute_profile_num_cpus":{"type":"integer","format":"int32","example":4,"description":"Indicates the number of CPUs in the compute profile configured on clones."},"compute_profile_ram_mb":{"type":"integer","format":"int32","example":4096,"description":"Indicates the RAM in MB in the compute profile configured on clones."},"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter within which the desktop pool is configured."},"host_or_cluster_id":{"type":"string","example":"domain-s425","description":"Host or cluster where the machines are deployed in."},"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To: Full/instant clone automated desktop pools.
Image management stream used in desktop pool when Image Management feature is enabled.
Supported Filters: 'Equals'."},"im_tag_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Applicable To: Full/instant clone automated desktop pools.
Image management tag associated with the selected image management stream which is used in desktop pool when Image Management feature is enabled.
Supported Filters: 'Equals'."},"min_ready_vms_on_vcomposer_maintenance":{"type":"integer","format":"int32","example":10,"description":"Applicable To: Linked clone automated desktop pools.
Minimum number of ready (provisioned) machines during View Composer maintenance operations."},"parent_vm_id":{"type":"string","example":"vm-2","description":"Applicable To: Linked/instant clone automated desktop pools.
Base image VM for linked clone desktop pool and current image for instant clone desktop pool."},"resource_pool_id":{"type":"string","example":"resgroup-1","description":"Resource pool to deploy the machines."},"vm_folder_id":{"type":"string","example":"group-v1","description":"VM folder where the machines are deployed to."},"vm_template_id":{"type":"string","example":"vm-1","description":"Applicable To: Full clone automated desktop pools.
Template from which full clone machines are deployed."}},"title":"DesktopPoolProvisioningSettingsV2","description":"Virtual Center provisioning settings for the automated desktop pool."},"DesktopPoolProvisioningStatusData":{"type":"object","properties":{"instant_clone_current_image_state":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","description":"Applicable To: instant clone automated desktop pools.
This represents the state of the current image of this instant clone desktop pool.\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* 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* 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.","enum":["READY","FAILED","PENDING_UNPUBLISH","UNPUBLISHING"]},"instant_clone_operation":{"type":"string","example":"NONE","description":"Applicable To: instant clone automated desktop pools.
The operation that this instant clone desktop pool is undergoing.\n* NONE: There is no current operation on the desktop pool.\n* INITIAL_PUBLISH: The desktop pool has just been created and is undergoing initial publishing.\n* SCHEDULE_PUSH_IMAGE: The push operation is scheduled on the desktop pool.\n* CANCEL_SCHEDULED_PUSH_IMAGE: The scheduled push operation on the desktop pool is being cancelled.\n* INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the desktop pool.\n* FINAL_UNPUBLISH: A desktop pool has been deleted and is undergoing final unpublishing.","enum":["NONE","INITIAL_PUBLISH","SCHEDULE_PUSH_IMAGE","CANCEL_SCHEDULED_PUSH_IMAGE","INFRASTRUCTURE_CHANGE","FINAL_UNPUBLISH"]},"instant_clone_pending_im_stream_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","description":"Applicable To: instant clone automated desktop pools.
Pending image management stream for instant clone desktop pools.
Supported Filters: 'Equals'."},"instant_clone_pending_im_tag_id":{"type":"string","example":"e9896e51-48a2-4d82-ae9e-a0246981b484","description":"Applicable To: instant clone automated desktop pools.
Pending image management tag for instant clone desktop pools
Supported Filters: 'Equals'."},"instant_clone_pending_image_error":{"type":"string","example":"Could not authenticate with domain administrator credentials","description":"Applicable To: instant clone automated desktop pools.
This represents the error message if publishing of push image operation is failed."},"instant_clone_pending_image_parent_vm_id":{"type":"string","example":"vm-1","description":"Applicable To: instant clone automated desktop pools.
Pending base image VM for instant clone desktop pools. This is used to return the information about the parent VM of the pending Image."},"instant_clone_pending_image_progress":{"type":"integer","format":"int32","example":10,"description":"Applicable To: instant clone automated desktop pools.
This represents the pending image publish progress in percentage for an instant clone desktop pool."},"instant_clone_pending_image_snapshot_id":{"type":"string","example":"snapshot-1","description":"Applicable To: instant clone automated desktop pools.
Pending base image snapshot for instant clone desktop pools. This is used to return the information about the snapshot of the pending image."},"instant_clone_pending_image_state":{"type":"string","example":"FAILED","description":"Applicable To: instant clone automated desktop pools.
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.\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* 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.\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* FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.\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.","enum":["PENDING_PUBLISH","PUBLISHING","UNPUBLISHING","READY","FAILED","READY_HELD"]},"instant_clone_push_image_settings":{"description":"Applicable To: instant clone automated desktop pools.
If the current operation is a push image, the settings for that operation.","$ref":"#/definitions/DesktopPoolInstantClonePushImageSettings"},"last_provisioning_error":{"type":"string","example":"Initial publish failed: Could not authenticate with domain administrator credentials","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."},"last_provisioning_error_time":{"type":"integer","format":"int64","example":1587081283000,"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."}},"title":"DesktopPoolProvisioningStatusData","description":"Provisioning status data about this automated desktop pool."},"DesktopPoolProvisioningStatusDataV2":{"type":"object","properties":{"instant_clone_current_image_state":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","description":"Applicable To: instant clone automated desktop pools.
This represents the state of the current image of this instant clone desktop pool.\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* 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* 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.","enum":["READY","FAILED","PENDING_UNPUBLISH","UNPUBLISHING"]},"instant_clone_operation":{"type":"string","example":"NONE","description":"Applicable To: instant clone automated desktop pools.
The operation that this instant clone desktop pool is undergoing.\n* NONE: There is no current operation on the desktop pool.\n* INITIAL_PUBLISH: The desktop pool has just been created and is undergoing initial publishing.\n* SCHEDULE_PUSH_IMAGE: The push operation is scheduled on the desktop pool.\n* CANCEL_SCHEDULED_PUSH_IMAGE: The scheduled push operation on the desktop pool is being cancelled.\n* INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the desktop pool.\n* FINAL_UNPUBLISH: A desktop pool has been deleted and is undergoing final unpublishing.","enum":["NONE","INITIAL_PUBLISH","SCHEDULE_PUSH_IMAGE","CANCEL_SCHEDULED_PUSH_IMAGE","INFRASTRUCTURE_CHANGE","FINAL_UNPUBLISH"]},"instant_clone_pending_im_stream_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","description":"Applicable To: instant clone automated desktop pools.
Pending image management stream for instant clone desktop pools.
Supported Filters: 'Equals'."},"instant_clone_pending_im_tag_id":{"type":"string","example":"e9896e51-48a2-4d82-ae9e-a0246981b484","description":"Applicable To: instant clone automated desktop pools.
Pending image management tag for instant clone desktop pools
Supported Filters: 'Equals'."},"instant_clone_pending_image_error":{"type":"string","example":"Could not authenticate with domain administrator credentials","description":"Applicable To: instant clone automated desktop pools.
This represents the error message if publishing of push image operation is failed."},"instant_clone_pending_image_parent_vm_id":{"type":"string","example":"vm-1","description":"Applicable To: instant clone automated desktop pools.
Pending base image VM for instant clone desktop pools. This is used to return the information about the parent VM of the pending Image."},"instant_clone_pending_image_progress":{"type":"integer","format":"int32","example":10,"description":"Applicable To: instant clone automated desktop pools.
This represents the pending image publish progress in percentage for an instant clone desktop pool."},"instant_clone_pending_image_snapshot_id":{"type":"string","example":"snapshot-1","description":"Applicable To: instant clone automated desktop pools.
Pending base image snapshot for instant clone desktop pools. This is used to return the information about the snapshot of the pending image."},"instant_clone_pending_image_state":{"type":"string","example":"FAILED","description":"Applicable To: instant clone automated desktop pools.
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.\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* 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.\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* FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.\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.","enum":["PENDING_PUBLISH","PUBLISHING","UNPUBLISHING","READY","FAILED","READY_HELD"]},"instant_clone_push_image_settings":{"description":"Applicable To: instant clone automated desktop pools.
If the current operation is a push image, the settings for that operation.","$ref":"#/definitions/DesktopPoolInstantClonePushImageSettings"},"last_provisioning_error":{"type":"string","example":"Initial publish failed: Could not authenticate with domain administrator credentials","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."},"last_provisioning_error_time":{"type":"integer","format":"int64","example":1587081283000,"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."},"pending_compute_profile_num_cores_per_socket":{"type":"integer","format":"int32","example":1,"description":"Indicates the pending number of cores per socket for the CPU in the compute profile configured on clones."},"pending_compute_profile_num_cpus":{"type":"integer","format":"int32","example":4,"description":"Indicates the pending number of CPUs in the compute profile configured on clones."},"pending_compute_profile_ram_mb":{"type":"integer","format":"int32","example":4096,"description":"Indicates the pending RAM in MB in the compute profile configured on clones."}},"title":"DesktopPoolProvisioningStatusDataV2","description":"Provisioning status data about this automated desktop pool."},"DesktopPoolPushImageSpec":{"type":"object","required":["logoff_policy"],"properties":{"add_virtual_tpm":{"type":"boolean","example":false,"description":"Indicates whether to add Virtual TPM device. Default: false"},"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"New image management stream for the desktop pool.
Either parent VM and snapshot or image management stream and tag are to be specified."},"im_tag_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"New image management tag for the desktop pool. This must be a tag of the image management stream."},"logoff_policy":{"type":"string","example":"WAIT_FOR_LOGOFF","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.","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"parent_vm_id":{"type":"string","example":"vm-1","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.
Either parent VM and snapshot or image management stream and tag are to be specified."},"snapshot_id":{"type":"string","example":"snapshot-1","description":"New base image snapshot for the desktop pool. This must be a snapshot of the parent VM."},"start_time":{"type":"integer","format":"int64","example":1587081283000,"description":"When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time."},"stop_on_first_error":{"type":"boolean","example":true,"description":"Indicates that the operation should stop on first error. Default: true"}},"title":"DesktopPoolPushImageSpec","description":"Information required to schedule push image operation on a desktop pool."},"DesktopPoolPushImageSpecV2":{"type":"object","required":["logoff_policy"],"properties":{"add_virtual_tpm":{"type":"boolean","example":false,"description":"Indicates whether to add Virtual TPM device. Default: false"},"compute_profile_num_cores_per_socket":{"type":"integer","format":"int32","example":1,"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. ","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"compute_profile_num_cpus":{"type":"integer","format":"int32","example":4,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"compute_profile_ram_mb":{"type":"integer","format":"int32","example":4096,"description":"Indicates the RAM in MB in the compute profile to be configured on clones.","minimum":1024,"exclusiveMinimum":false,"exclusiveMaximum":false},"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"New image management stream for the desktop pool.
Either parent VM and snapshot or image management stream and tag are to be specified."},"im_tag_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"New image management tag for the desktop pool. This must be a tag of the image management stream."},"logoff_policy":{"type":"string","example":"WAIT_FOR_LOGOFF","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.","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"machine_ids":{"type":"array","example":["816d44cb-b486-3c97-adcb-cf3806d53657", "414927f3-1a3b-3e4c-81b3-d39602f634dc"],"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.","items":{"type":"string"}},"parent_vm_id":{"type":"string","example":"vm-1","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.
Either parent VM and snapshot or image management stream and tag are to be specified."},"selective_push_image":{"type":"boolean","example":true,"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."},"snapshot_id":{"type":"string","example":"snapshot-1","description":"New base image snapshot for the desktop pool. This must be a snapshot of the parent VM."},"start_time":{"type":"integer","format":"int64","example":1587081283000,"description":"When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time."},"stop_on_first_error":{"type":"boolean","example":true,"description":"Indicates that the operation should stop on first error. Default: true"}},"title":"DesktopPoolPushImageSpecV2","description":"Information required to schedule push image operation on a desktop pool."},"DesktopPoolQuickprepCustomizationSettings":{"type":"object","properties":{"post_synchronization_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Post synchronization script parameters."},"post_synchronization_script_path":{"type":"string","example":"quickprep_postsync_script","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."},"power_off_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Power off script parameters."},"power_off_script_path":{"type":"string","example":"quickprep_poweroff_script","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."}},"title":"DesktopPoolQuickprepCustomizationSettings","description":"Settings for QuickPrep customization."},"DesktopPoolSessionSettings":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","example":false,"description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false."},"allow_users_to_reset_machines":{"type":"boolean","example":false,"description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false."},"delete_or_refresh_machine_after_logoff":{"type":"string","example":"NEVER","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.\n* NEVER: Never delete or refresh the machine in the desktop pool.\n* DELETE: Delete the machine after user logoff.\n* REFRESH: Refresh the machine after user logoff.","enum":["NEVER","DELETE","REFRESH"]},"disconnected_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"description":"Disconnected sessions timeout (in minutes). Will be set when disconnected_session_timeout_policy is set to AFTER.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"disconnected_session_timeout_policy":{"type":"string","example":"NEVER","description":"Log-off policy after disconnected session. Default value is NEVER.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* NEVER: Do not logoff after user disconnect.","enum":["IMMEDIATELY","AFTER","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"empty_session_timeout_policy":{"type":"string","example":"AFTER","description":"Application empty session timeout policy. Default value is AFTER.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.\n* AFTER: Empty session will be disconnected after specified number of minutes.","enum":["IMMEDIATE","NEVER","AFTER"]},"logoff_after_timeout":{"type":"boolean","example":false,"description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.Default value is false."},"power_policy":{"type":"string","example":"ALWAYS_POWERED_ON","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.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\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* 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* 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.","enum":["TAKE_NO_POWER_ACTION","ALWAYS_POWERED_ON","SUSPEND","POWER_OFF"]},"refresh_os_disk_after_logoff":{"type":"string","example":"NEVER","description":"Whether and when to refresh the OS disks for dedicated-assignment, linked-clone and instant-clone machines.Default value is NEVER.\n* NEVER: The OS disk is never refreshed.\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* 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.","enum":["NEVER","ALWAYS","EVERY","AT_SIZE"]},"refresh_period_days_for_replica_os_disk":{"type":"integer","format":"int32","example":20,"description":"Regular interval at which to refresh the OS disk. Will be set when refresh_os_disk_after_logoff set to EVERY.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"refresh_threshold_percentage_for_replica_os_disk":{"type":"integer","format":"int32","example":30,"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.","minimum":1,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"DesktopPoolSessionSettings","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","example":false,"description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false."},"allow_users_to_reset_machines":{"type":"boolean","example":false,"description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false."},"delete_or_refresh_machine_after_logoff":{"type":"string","example":"NEVER","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* NEVER: Never delete or refresh the machine in the desktop pool.\n* DELETE: Delete the machine after user logoff.\n* REFRESH: Refresh the machine after user logoff.","enum":["NEVER","DELETE","REFRESH"]},"disconnected_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"description":"Disconnected sessions timeout (in minutes). This is required if disconnected_session_timeout_policy is set to AFTER.
","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"disconnected_session_timeout_policy":{"type":"string","example":"NEVER","description":"Log-off policy after disconnected session. Default value is NEVER.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* NEVER: Do not logoff after user disconnect.","enum":["IMMEDIATELY","AFTER","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"empty_session_timeout_policy":{"type":"string","example":"AFTER","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION.
Application empty session timeout policy. Default value is AFTER.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.\n* AFTER: Empty session will be disconnected after specified number of minutes.","enum":["IMMEDIATE","NEVER","AFTER"]},"logoff_after_timeout":{"type":"boolean","example":false,"description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION.
Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. Default value is false."},"power_policy":{"type":"string","example":"TAKE_NO_POWER_ACTION","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* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\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* 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* 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.","enum":["TAKE_NO_POWER_ACTION","ALWAYS_POWERED_ON","SUSPEND","POWER_OFF"]},"pre_launch_session_timeout_minutes":{"type":"integer","format":"int32","example":10,"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.","minimum":10,"exclusiveMinimum":false,"exclusiveMaximum":false},"pre_launch_session_timeout_policy":{"type":"string","example":"AFTER","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION.
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.","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","example":"NEVER","description":"Indicates whether and when to refresh the OS disks. Applicable To: dedicated instant-clone desktop pools with default value as NEVER.\n* NEVER: The OS disk is never refreshed.\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* 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.","enum":["NEVER","ALWAYS","EVERY","AT_SIZE"]},"refresh_period_days_for_replica_os_disk":{"type":"integer","format":"int32","example":20,"description":"Regular interval at which to refresh the OS disk. This is required if refresh_os_disk_after_logoff is set to EVERY.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"refresh_threshold_percentage_for_replica_os_disk":{"type":"integer","format":"int32","example":30,"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.","minimum":1,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"session_timeout_policy":{"type":"string","example":"DEFAULT","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.","enum":["DEFAULT","NEVER"]}},"title":"DesktopPoolSessionSettingsCreateSpec","description":"Applicable To: Automated and Manual desktop pool.
Session related settings for Automated and Manual desktop pool."},"DesktopPoolSessionSettingsUpdateSpec":{"type":"object","required":["allow_multiple_sessions_per_user","disconnected_session_timeout_policy"],"properties":{"allow_multiple_sessions_per_user":{"type":"boolean","example":false,"description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment."},"allow_users_to_reset_machines":{"type":"boolean","example":false,"description":"Indicates whether the user can be allowed to reset or restart their machines."},"delete_or_refresh_machine_after_logoff":{"type":"string","example":"NEVER","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* NEVER: Never delete or refresh the machine in the desktop pool.\n* DELETE: Delete the machine after user logoff.\n* REFRESH: Refresh the machine after user logoff.","enum":["NEVER","DELETE","REFRESH"]},"disconnected_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"description":"Disconnected sessions timeout (in minutes). This is required if disconnected_session_timeout_policy is set to AFTER.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"disconnected_session_timeout_policy":{"type":"string","example":"NEVER","description":"Log-off policy after disconnected session.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* NEVER: Do not logoff after user disconnect.","enum":["IMMEDIATELY","AFTER","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"empty_session_timeout_policy":{"type":"string","example":"AFTER","description":"Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION.
Desktop Pool empty session timeout policy.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.\n* AFTER: Empty session will be disconnected after specified number of minutes.","enum":["IMMEDIATE","NEVER","AFTER"]},"logoff_after_timeout":{"type":"boolean","example":false,"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."},"power_policy":{"type":"string","example":"ALWAYS_POWERED_ON","description":"Power policy for the machines in the desktop pool after logoff. This setting is only relevant for managed machines. \n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\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* 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* 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.","enum":["TAKE_NO_POWER_ACTION","ALWAYS_POWERED_ON","SUSPEND","POWER_OFF"]},"pre_launch_session_timeout_minutes":{"type":"integer","format":"int32","example":10,"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.","minimum":10,"exclusiveMinimum":false,"exclusiveMaximum":false},"pre_launch_session_timeout_policy":{"type":"string","example":"AFTER","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.","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","example":"NEVER","description":"Indicates whether and when to refresh the OS disks for dedicated instant-clone desktop pools.\n* NEVER: The OS disk is never refreshed.\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* 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.","enum":["NEVER","ALWAYS","EVERY","AT_SIZE"]},"refresh_period_days_for_replica_os_disk":{"type":"integer","format":"int32","example":20,"description":"Regular interval at which to refresh the OS disk. This is required if when refresh_os_disk_after_logoff set to EVERY.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"refresh_threshold_percentage_for_replica_os_disk":{"type":"integer","format":"int32","example":30,"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.","minimum":1,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"session_timeout_policy":{"type":"string","example":"DEFAULT","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.","enum":["DEFAULT","NEVER"]}},"title":"DesktopPoolSessionSettingsUpdateSpec","description":"Applicable To: Automated and Manual desktop pool.
Session related setting for Automated and Manual desktop pool."},"DesktopPoolSessionSettingsV2":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","example":false,"description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false."},"allow_users_to_reset_machines":{"type":"boolean","example":false,"description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false."},"delete_or_refresh_machine_after_logoff":{"type":"string","example":"NEVER","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.\n* NEVER: Never delete or refresh the machine in the desktop pool.\n* DELETE: Delete the machine after user logoff.\n* REFRESH: Refresh the machine after user logoff.","enum":["NEVER","DELETE","REFRESH"]},"disconnected_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"description":"Disconnected sessions timeout (in minutes). Will be set when disconnected_session_timeout_policy is set to AFTER.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"disconnected_session_timeout_policy":{"type":"string","example":"NEVER","description":"Log-off policy after disconnected session. Default value is NEVER.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* NEVER: Do not logoff after user disconnect.","enum":["IMMEDIATELY","AFTER","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"empty_session_timeout_policy":{"type":"string","example":"AFTER","description":"Application empty session timeout policy. Default value is AFTER.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.\n* AFTER: Empty session will be disconnected after specified number of minutes.","enum":["IMMEDIATE","NEVER","AFTER"]},"logoff_after_timeout":{"type":"boolean","example":false,"description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.Default value is false."},"power_policy":{"type":"string","example":"ALWAYS_POWERED_ON","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.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\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* 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* 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.","enum":["TAKE_NO_POWER_ACTION","ALWAYS_POWERED_ON","SUSPEND","POWER_OFF"]},"pre_launch_session_timeout_minutes":{"type":"integer","format":"int32","example":10,"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.","minimum":10,"exclusiveMinimum":false,"exclusiveMaximum":false},"pre_launch_session_timeout_policy":{"type":"string","example":"AFTER","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.","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","example":"NEVER","description":"Whether and when to refresh the OS disks for dedicated-assignment, linked-clone and instant-clone machines.Default value is NEVER.\n* NEVER: The OS disk is never refreshed.\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* 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.","enum":["NEVER","ALWAYS","EVERY","AT_SIZE"]},"refresh_period_days_for_replica_os_disk":{"type":"integer","format":"int32","example":20,"description":"Regular interval at which to refresh the OS disk. Will be set when refresh_os_disk_after_logoff set to EVERY.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"refresh_threshold_percentage_for_replica_os_disk":{"type":"integer","format":"int32","example":30,"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.","minimum":1,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"DesktopPoolSessionSettingsV2","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","example":false,"description":"Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false."},"allow_users_to_reset_machines":{"type":"boolean","example":false,"description":"Indicates whether the user can be allowed to reset or restart their machines. Default value is false."},"delete_or_refresh_machine_after_logoff":{"type":"string","example":"NEVER","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.\n* NEVER: Never delete or refresh the machine in the desktop pool.\n* DELETE: Delete the machine after user logoff.\n* REFRESH: Refresh the machine after user logoff.","enum":["NEVER","DELETE","REFRESH"]},"disconnected_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"description":"Disconnected sessions timeout (in minutes). Will be set when disconnected_session_timeout_policy is set to AFTER.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"disconnected_session_timeout_policy":{"type":"string","example":"NEVER","description":"Log-off policy after disconnected session. Default value is NEVER.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* NEVER: Do not logoff after user disconnect.","enum":["IMMEDIATELY","AFTER","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"empty_session_timeout_policy":{"type":"string","example":"AFTER","description":"Application empty session timeout policy. Default value is AFTER.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.\n* AFTER: Empty session will be disconnected after specified number of minutes.","enum":["IMMEDIATE","NEVER","AFTER"]},"logoff_after_timeout":{"type":"boolean","example":false,"description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.Default value is false."},"power_policy":{"type":"string","example":"ALWAYS_POWERED_ON","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.\n* TAKE_NO_POWER_ACTION: No action will be taken when user logs off.\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* 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* 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.","enum":["TAKE_NO_POWER_ACTION","ALWAYS_POWERED_ON","SUSPEND","POWER_OFF"]},"pre_launch_session_timeout_minutes":{"type":"integer","format":"int32","example":10,"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.","minimum":10,"exclusiveMinimum":false,"exclusiveMaximum":false},"pre_launch_session_timeout_policy":{"type":"string","example":"AFTER","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.","enum":["AFTER","NEVER"]},"refresh_os_disk_after_logoff":{"type":"string","example":"NEVER","description":"Whether and when to refresh the OS disks for dedicated-assignment, linked-clone and instant-clone machines.Default value is NEVER.\n* NEVER: The OS disk is never refreshed.\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* 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.","enum":["NEVER","ALWAYS","EVERY","AT_SIZE"]},"refresh_period_days_for_replica_os_disk":{"type":"integer","format":"int32","example":20,"description":"Regular interval at which to refresh the OS disk. Will be set when refresh_os_disk_after_logoff set to EVERY.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"refresh_threshold_percentage_for_replica_os_disk":{"type":"integer","format":"int32","example":30,"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.","minimum":1,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"session_timeout_policy":{"type":"string","example":"DEFAULT","description":"Session timeout policy.\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.","enum":["DEFAULT","NEVER"]}},"title":"DesktopPoolSessionSettingsV3","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","example":false,"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."},"category_folder_name":{"type":"string","example":"dir1","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."},"cloud_assigned":{"type":"boolean","example":false,"description":"Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services. Default value is false."},"cloud_managed":{"type":"boolean","example":false,"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."},"cs_restriction_tags":{"type":"array","example":["CS1_TAG1"],"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.","items":{"type":"string"}},"delete_in_progress":{"type":"boolean","example":false,"description":"Indicates whether the desktop pool is in the process of being deleted.Default value is false."},"display_protocol_settings":{"description":"Remote display protocol settings. These relate to RDP/PCoIP/BLAST.","$ref":"#/definitions/DesktopPoolDisplayProtocolSettings"},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Client restrictions to be applied to the desktop pool.Currently it is valid for RDS desktop pools only. Default value is false."},"session_settings":{"description":"Includes machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare.","$ref":"#/definitions/DesktopPoolSessionSettings"},"session_type":{"type":"string","example":"DESKTOP","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* DESKTOP: Only desktop sessions are supported.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","enum":["DESKTOP","APPLICATION","DESKTOP_AND_APPLICATION"]},"shortcut_locations":{"type":"array","example":["Desktop"],"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.","items":{"type":"string"}}},"title":"DesktopPoolSettings","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":"#/definitions/DesktopPoolDatastoreSettings"}},"non_persistent_disk_drive_letter":{"type":"string","example":"Auto","description":"Non persistent disk drive letter."},"non_persistent_disk_size_mb":{"type":"integer","format":"int32","example":4096,"description":"Size of the non persistent disk in MB."},"non_persistent_redirect_disposable_files":{"type":"boolean","example":true,"description":"Redirect disposable files to a non-persistent disk that will be deleted automatically when a user's session ends."},"persistent_disk_datastores":{"type":"array","description":"Datastores to store persistent disks for linked clone machines.","items":{"$ref":"#/definitions/DesktopPoolDatastoreSettings"}},"persistent_disk_drive_letter":{"type":"string","example":"D","description":"Persistent disk drive letter."},"persistent_disk_size_mb":{"type":"integer","format":"int32","example":2048,"description":"Size of the persistent disk in MB."},"reclaim_vm_disk_space":{"type":"boolean","example":false,"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."},"reclamation_threshold_mb":{"type":"integer","format":"int64","example":1024,"description":"Initiate reclamation when unused space on virtual machine exceeds the threshold in MB."},"redirect_windows_profile":{"type":"boolean","example":false,"description":"Windows profiles will be redirected to persistent disks, which are not affected by View Composer operations such as refresh, recompose and rebalance."},"replica_disk_datastore_id":{"type":"string","example":"datastore-1","description":"Datastore to store replica disks for linked clone and instant clone machines."},"use_native_snapshots":{"type":"boolean","example":false,"description":"Applicable To: Linked/instant clone automated desktop pool.
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."},"use_separate_datastores_persistent_and_os_disks":{"type":"boolean","example":false,"description":"Whether to use separate datastores for persistent and OS disks."},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","example":false,"description":"Whether to use separate datastores for replica and OS disks."},"use_vsan":{"type":"boolean","example":false,"description":"Whether to use vSphere vSAN."}},"title":"DesktopPoolStorageSettings","description":"Virtual Center storage settings for the automated desktop pool."},"DesktopPoolStorageSettingsCreateSpec":{"type":"object","required":["datastores"],"properties":{"datastores":{"type":"array","description":"Datastores to store the machine.","items":{"$ref":"#/definitions/DesktopPoolDatastoreSettingsCreateSpec"}},"reclaim_vm_disk_space":{"type":"boolean","example":false,"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.
Default value is false."},"reclamation_threshold_mb":{"type":"integer","format":"int64","example":1024,"description":"Initiate reclamation when unused space on virtual machine exceeds the threshold in MB.
This property is required if reclaim_vm_disk_space is set to true."},"replica_disk_datastore_id":{"type":"string","example":"datastore-1","description":"Datastore to store replica disks for instant clone machines.
This property is required if use_separate_datastores_replica_and_os_disks is set to true.
"},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","example":false,"description":"Indicates whether to use separate datastores for replica and OS disks.
Default value is false."},"use_vsan":{"type":"boolean","example":false,"description":"Indicates whether to use vSphere vSAN.
Default value is false."}},"title":"DesktopPoolStorageSettingsCreateSpec","description":"Applicable To: Automated desktop pool.
Virtual center storage settings for Automated desktop pool."},"DesktopPoolStorageSettingsUpdateSpec":{"type":"object","required":["datastores","use_vsan"],"properties":{"datastores":{"type":"array","description":"Datastores to store the machine (or the OS disk using other options for instant clone machine storage)","items":{"$ref":"#/definitions/DesktopPoolDatastoreSettingsUpdateSpec"}},"reclaim_vm_disk_space":{"type":"boolean","example":false,"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."},"reclamation_threshold_mb":{"type":"integer","format":"int64","example":1024,"description":"Initiate reclamation when unused space on virtual machine exceeds the threshold in MB. Default value is 1."},"replica_disk_datastore_id":{"type":"string","example":"datastore-1","description":"Datastore to store replica disks for instant clone machines."},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","example":false,"description":"Indicates whether to use separate datastores for replica and OS disks."},"use_vsan":{"type":"boolean","example":false,"description":"Indicates whether to use vSphere vSAN."}},"title":"DesktopPoolStorageSettingsUpdateSpec","description":"Applicable To: Automated desktop pool.
Virtual Center storage settings for Automated desktop pool."},"DesktopPoolTaskInfo":{"type":"object","properties":{"cancelled_vmtask_count":{"type":"integer","format":"int32","example":3,"description":"Number of VMs whose task is in cancelled state."},"description":{"type":"string","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.","description":"Description of the desktop pool task."},"error_vmtask_count":{"type":"integer","format":"int32","example":2,"description":"Number of VMs whose task is in fault state."},"halted_vmtask_count":{"type":"integer","format":"int32","example":1,"description":"Number of VMs whose task is in holding state."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing Desktop Pool Task."},"operation":{"type":"string","example":"PUSH_IMAGE","description":"The current desktop pool operation.\n* PUSH_IMAGE: A push image operation.\n* ARCHIVE: An archive operation.\n* TAGGING: A tagging operation.","enum":["PUSH_IMAGE","ARCHIVE","TAGGING"]},"remaining_vmtask_count":{"type":"integer","format":"int32","example":10,"description":"Number of VMs whose task is scheduled or running."},"schedule_time":{"type":"integer","format":"int64","example":1587081283000,"description":"Time at which desktop pool task is scheduled to start."}},"title":"DesktopPoolTaskInfo","description":"Information related to Desktop Pool Task."},"DesktopPoolUpdateSpec":{"type":"object","required":["cloud_assigned","cloud_managed","display_assigned_machine_name","display_machine_alias","display_name","enable_client_restrictions","enabled"],"properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as desktop pools in the organization. They can also be used for delegated administration.
This property is required for all the pools except for RDS desktop pool, which will be inherited from the corresponding Farm."},"allow_multiple_user_assignments":{"type":"boolean","example":true,"description":"Applicable To: Dedicated manual and automated desktop pools. with manual user assignment.
Indicates whether assignment of multiple users to a single machine is allowed. This is required for Dedicated manual and automated desktop pools
"},"allow_rds_pool_multi_session_per_user":{"type":"boolean","example":false,"description":"Applicable To: RDS desktop pools.
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."},"automatic_user_assignment":{"type":"boolean","example":false,"description":"Applicable To: Dedicated desktop pools.
Automatic assignment of a user the first time they access the machine.
"},"category_folder_name":{"type":"string","example":"dir1","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."},"cloud_assigned":{"type":"boolean","example":false,"description":"Indicates whether this desktop pool is assigned to a workspace in Horizon Cloud Services.
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."},"cloud_brokered":{"type":"boolean","example":false,"description":"Applicable To: RDS Desktop Pools.
This is required for RDS Desktop Pools."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this desktop pool is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.
This cannot be set to true, if any of the conditions are satisfied:
1. user is provided.
2. enabled is false.
3. session_type is not DESKTOP.
4. global_entitlement is set.
5. user_assignment is DEDICATED.
6. automatic_user_assignment is false.
7. Local entitlements are configured.
8. Any of the machines in the pool have users assigned.
9. cs_restriction_tags is not set.
10. type is MANUAL.
"},"cs_restriction_tags":{"type":"array","example":["CS1_TAG1"],"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.","items":{"type":"string"}},"customization_settings":{"description":"Applicable To: Automated desktop pools.
Customization settings for this desktop pool.","$ref":"#/definitions/DesktopPoolCustomizationSettingsUpdateSpec"},"description":{"type":"string","example":"Desktop Pool Description","description":"Description of the desktop pool.","maxLength":1024},"display_assigned_machine_name":{"type":"boolean","example":false,"description":"Applicable To: Dedicated desktop pools.
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."},"display_machine_alias":{"type":"boolean","example":true,"description":"Applicable To: Dedicated desktop pools.
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."},"display_name":{"type":"string","example":"pool","description":"Display name of the desktop pool.","minLength":1,"maxLength":256},"display_protocol_settings":{"description":"Applicable To: Automated and Manual desktop pools.
Remote display protocol settings for desktop pool. For RDS Desktop Pools, it's Farm's FarmDisplayProtocolSettings will be used ","$ref":"#/definitions/DesktopPoolDisplayProtocolSettingsUpdateSpec"},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions are to be applied to desktop pool. "},"enable_provisioning":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools.
Indicates whether provisioning is enabled. This is required for Automated desktop pools."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the desktop pool is enabled for brokering."},"nics":{"type":"array","description":"Applicable To: Instant Clone desktop pools.
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":"#/definitions/DesktopPoolNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"description":"Applicable To: Automated desktop pools.
Specifies the naming scheme.
This property is required if naming_method is set to PATTERN.","$ref":"#/definitions/DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec"},"provisioning_settings":{"description":"Applicable To: Automated desktop pools.
Virtual center entities used for provisioning.","$ref":"#/definitions/DesktopPoolProvisioningSettingsUpdateSpec"},"session_settings":{"description":"Applicable To: Automated and Manual desktop pools.
Includes machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare. For RDS Desktop Pools, it's Farm's FarmSessionSettings will be used","$ref":"#/definitions/DesktopPoolSessionSettingsUpdateSpec"},"session_type":{"type":"string","example":"DESKTOP","description":"Applicable To: Managed desktop pools.
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* DESKTOP: Only desktop sessions are supported.\n* APPLICATION: Only application sessions are supported.\n* DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.","enum":["DESKTOP","APPLICATION","DESKTOP_AND_APPLICATION"]},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"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.","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"specific_naming_settings":{"description":"Applicable To: Automated desktop pools.
Specifies the naming scheme.
This property is required if naming_method is set to SPECIFIED.","$ref":"#/definitions/DesktopPoolVirtualMachineSpecifiedNamingSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Applicable To: Automated desktop pools.
Indicates whether provisioning on all machines stops on error. This is required for Automated desktop pools."},"storage_settings":{"description":"Applicable To: Automated desktop pools.
Virtual Center storage settings.","$ref":"#/definitions/DesktopPoolStorageSettingsUpdateSpec"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Applicable To: Managed Manual and Automated desktop pools.
The transparent page sharing scope. This is required for Manual and Automated desktop pools.\n* VM: Inter-VM page sharing is not permitted.\n* DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","DESKTOP_POOL","POD","GLOBAL"]},"view_storage_accelerator_settings":{"description":"Applicable To: Manual and automated desktop pools.
View Storage Accelerator settings.","$ref":"#/definitions/DesktopPoolViewStorageAcceleratorSettingsUpdateSpec"}},"title":"DesktopPoolUpdateSpec","description":"Information required to update a desktop pool."},"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":"#/definitions/ViewStorageAcceleratorBlackoutTimeSettings"}},"regenerate_view_storage_accelerator_days":{"type":"integer","format":"int32","example":7,"description":"How often to regenerate the View Storage Accelerator cache. Measured in Days."},"use_view_storage_accelerator":{"type":"boolean","example":false,"description":"Whether to use View Storage Accelerator."},"view_storage_accelerator_disk_types":{"type":"string","example":"OS_DISKS","description":"Disk types to enable for the View Storage Accelerator feature. This is only applicable to linked clone desktop pools.\n* OS_DISKS: OS disks.\n* OS_AND_PERSISTENT_DISKS: OS and persistent disks.","enum":["OS_DISKS","OS_AND_PERSISTENT_DISKS"]}},"title":"DesktopPoolViewStorageAcceleratorSettings","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":"#/definitions/ViewStorageAcceleratorBlackoutTimeSettingsCreateSpec"}},"regenerate_view_storage_accelerator_days":{"type":"integer","format":"int32","example":7,"description":"How often to regenerate the View Storage Accelerator cache. Measured in Days.
This property is required if useViewStorageAccelerator is set to true.
Default value is 7.","minimum":1,"maximum":999,"exclusiveMinimum":false,"exclusiveMaximum":false},"use_view_storage_accelerator":{"type":"boolean","example":false,"description":"Indicates whether to use View Storage Accelerator.
Default value is false."}},"title":"DesktopPoolViewStorageAcceleratorSettingsCreateSpec","description":"Applicable To: Managed Desktop Pool.
View Storage Accelerator settings for Managed desktop pool."},"DesktopPoolViewStorageAcceleratorSettingsUpdateSpec":{"type":"object","properties":{"blackout_times":{"type":"array","description":"A list of blackout times.","items":{"$ref":"#/definitions/ViewStorageAcceleratorBlackoutTimeSettingsUpdateSpec"}},"regenerate_view_storage_accelerator_days":{"type":"integer","format":"int32","example":7,"description":"How often to regenerate the View Storage Accelerator cache. Measured in Days. This property has a default value of 7.","minimum":1,"maximum":999,"exclusiveMinimum":false,"exclusiveMaximum":false},"use_view_storage_accelerator":{"type":"boolean","example":false,"description":"Indicates whether to use View Storage Accelerator."}},"title":"DesktopPoolViewStorageAcceleratorSettingsUpdateSpec","description":"Applicable To: Managed desktop pool.
Settings related to the View Storage Accelerator for Managed desktop pool. "},"DesktopPoolVirtualMachinePatternNamingSettings":{"type":"object","properties":{"max_number_of_machines":{"type":"integer","format":"int32","example":100,"description":"Maximum number of machines in the desktop pool."},"min_number_of_machines":{"type":"integer","format":"int32","example":10,"description":"The minimum number of machines to have provisioned if on demand provisioning is selected."},"naming_pattern":{"type":"string","example":"vm-{n}-sales","description":"Virtual machines will be named according to the specified naming pattern.
Supported Filters: 'Equals'."},"number_of_spare_machines":{"type":"integer","format":"int32","example":10,"description":"Number of spare powered on machines."},"provisioning_time":{"type":"string","example":"ON_DEMAND","description":"Determines when the machines are provisioned.\n* ON_DEMAND: Provision machines on demand.\n* UP_FRONT: Provision all machines up-front.","enum":["ON_DEMAND","UP_FRONT"]}},"title":"DesktopPoolVirtualMachinePatternNamingSettings","description":"Settings related to specification of VMs with a naming pattern."},"DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec":{"type":"object","required":["naming_pattern"],"properties":{"max_number_of_machines":{"type":"integer","format":"int32","example":100,"description":"Maximum number of machines in the desktop pool.
Default value is 1.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"min_number_of_machines":{"type":"integer","format":"int32","example":10,"description":"This is applicable if provisioning_time is set to ON_DEMAND with default value of 0.
","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"naming_pattern":{"type":"string","example":"vm-{n}-sales","description":"Virtual machines will be named according to the specified naming pattern.
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).
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\".
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."},"number_of_spare_machines":{"type":"integer","format":"int32","example":10,"description":"Number of spare powered on machines.
Default value is 1.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"provisioning_time":{"type":"string","example":"UP_FRONT","description":"Determines when the machines are provisioned.
Default value is UP_FRONT\n* ON_DEMAND: Provision machines on demand.\n* UP_FRONT: Provision all machines up-front.","enum":["ON_DEMAND","UP_FRONT"]}},"title":"DesktopPoolVirtualMachinePatternNamingSettingsCreateSpec","description":"Applicable To: Automated desktop pool.
Naming pattern settings for Automated desktop pool."},"DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec":{"type":"object","required":["max_number_of_machines","naming_pattern","number_of_spare_machines","provisioning_time"],"properties":{"max_number_of_machines":{"type":"integer","format":"int32","example":100,"description":"Maximum number of machines in the desktop pool."},"min_number_of_machines":{"type":"integer","format":"int32","example":10,"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\" ."},"naming_pattern":{"type":"string","example":"vm-{n}-sales","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. Therefore, care must be taken when choosing a pattern. 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."},"number_of_spare_machines":{"type":"integer","format":"int32","example":10,"description":"Number of spare powered on machines."},"provisioning_time":{"type":"string","example":"ON_DEMAND","description":"Determines when the machines are provisioned.\n* ON_DEMAND: Provision machines on demand.\n* UP_FRONT: Provision all machines up-front.","enum":["ON_DEMAND","UP_FRONT"]}},"title":"DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec","description":"Applicable To: Automated desktop pool.
Naming pattern settings for Automated desktop pool."},"DesktopPoolVirtualMachineSpecifiedNamingSettings":{"type":"object","properties":{"num_machines":{"type":"integer","format":"int32","example":10,"description":"Number of machines in the pool."},"num_unassigned_machines_kept_powered_on":{"type":"integer","format":"int32","example":1,"description":"Number of unassigned machines kept powered on. This value must be less than or equal to the number of specified names."},"start_machines_in_maintenance_mode":{"type":"boolean","example":false,"description":"Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited manually."}},"title":"DesktopPoolVirtualMachineSpecifiedNamingSettings","description":"Settings related to specified naming of machines."},"DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec":{"type":"object","properties":{"num_unassigned_machines_kept_powered_on":{"type":"integer","format":"int32","example":1,"description":"Number of unassigned machines kept powered on. This property must be lesser than or equal to the number of specified names.
Default value is 1.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"specified_names":{"type":"array","description":"Specified names for the virtual machines.","items":{"$ref":"#/definitions/MachineSpecifiedName"}},"start_machines_in_maintenance_mode":{"type":"boolean","example":false,"description":"Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited manually.
Default value is false."}},"title":"DesktopPoolVirtualMachineSpecifiedNamingSettingsCreateSpec","description":"Applicable To: Automated Desktop Pool.
Settings related to specified naming of machines for Automated desktop pool."},"DesktopPoolVirtualMachineSpecifiedNamingSettingsUpdateSpec":{"type":"object","required":["num_unassigned_machines_kept_powered_on","start_machines_in_maintenance_mode"],"properties":{"num_unassigned_machines_kept_powered_on":{"type":"integer","format":"int32","example":1,"description":"Number of unassigned machines kept powered on. This value must be lesser than or equal to the number of specified names."},"specified_names":{"type":"array","description":"Initial specified names of machines in the desktop pool.","items":{"$ref":"#/definitions/MachineSpecifiedName"}},"start_machines_in_maintenance_mode":{"type":"boolean","example":false,"description":"Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited manually."}},"title":"DesktopPoolVirtualMachineSpecifiedNamingSettingsUpdateSpec","description":"Applicable To: Automated desktop pool.
Specified naming setting for Automated desktop pool."},"EndsWithFilter":{"title":"EndsWithFilter","allOf":[{"$ref":"#/definitions/BaseFilter"},{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["And","Or","Not","NotEquals","Equals","Contains","StartsWith","EndsWith","Between"]},"value":{"type":"object"}},"title":"EndsWithFilter"}]},"EnrollmentServerDetails":{"type":"object","properties":{"dns_name":{"type":"string","example":"enrollment-server.example.com","description":"Enrollment server dns name."},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the Enrollment Server."},"status":{"type":"string","example":"OK","description":"Enrollment server status.\n* OK: The state of enrollment server is OK.\n* ERROR: The enrollment server has an error.","enum":["OK","ERROR"]}},"title":"EnrollmentServerDetails"},"EntitlementInfo":{"type":"object","properties":{"ad_user_or_group_ids":{"type":"array","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"description":"List of ad-user-or-group SIDs which are entitled to the given resource.","items":{"type":"string"}},"id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"Unique ID representing the resource.
Supported Filters : 'Equals'."}},"title":"EntitlementInfo","description":"Entitlement Information related to the resource.
List API returning this summary information can use search filter queryto filter on specific fields supported by filters.
Supported Filters : 'Or','Equals'.
See the field description to know the filter types it supports."},"EntitlementResponseInfo":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","example":"S-1-5-21-2898529287-1016622242-505487308-500","description":"Unique SID representing the ad-user-or-group"},"error_messages":{"type":"array","example":["Entity does not exists.", "Property is mandatory."],"description":"Reasons for the failure of the operation. This field is deprecated since 2203 release.","items":{"type":"string"}},"errors":{"type":"array","description":"List of error objects containing error key and error message.","items":{"$ref":"#/definitions/APIError"}},"status_code":{"type":"integer","format":"int32","example":200,"description":"Response HTTP status code of the operation."},"timestamp":{"type":"integer","format":"int64","example":1561939200000,"description":"Timestamp in milliseconds when the operation failed. Measured as epoch time."}},"title":"EntitlementResponseInfo","description":"Entitlement response info object corresponding to the given ad-user-or-group SID for the entitlement operation."},"EntitlementSpec":{"type":"object","properties":{"ad_user_or_group_ids":{"type":"array","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"description":"List of ad-user-or-group SIDs for the entitlement operations on the given resource.","items":{"type":"string"}},"id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"Unique ID representing the resource."}},"title":"EntitlementSpec","description":"Specification for entitlement operations on a given resource id."},"EnvironmentInfo":{"type":"object","properties":{"cluster_guid":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"The GUID of a group of Connection Servers sharing the same configuration."},"cluster_name":{"type":"string","example":"master-cluster","description":"The name of a group of Connection Servers sharing the same configuration."},"fips_mode_enabled":{"type":"boolean","example":false,"description":"Indicates if FIPS mode is enabled."},"ip_mode":{"type":"string","example":"IPv4","description":"Indicates the IP mode of the environment.\n* IPv4: The ip mode is IPv4.\n* IPv6: The ip mode is IPv6.","enum":["IPv4","IPv6"]},"local_pod_name":{"type":"string","example":"master-pod","description":"The name of the current pod in the Multi-DataCenter Horizon Pod, the value will be null when PodFederation is not initialized."},"timezone_offset":{"type":"integer","format":"int32","example":19800,"description":"Represents the clusters time zone offset from UTC in seconds."}},"title":"EnvironmentInfo","description":"Information related to Environment Settings."},"EnvironmentInfoV2":{"type":"object","properties":{"cluster_guid":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"The GUID of a group of Connection Servers sharing the same configuration."},"cluster_name":{"type":"string","example":"master-cluster","description":"The name of a group of Connection Servers sharing the same configuration."},"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","example":false,"description":"Indicates if FIPS mode is enabled."},"ip_mode":{"type":"string","example":"IPv4","description":"Indicates the IP mode of the environment.\n* IPv4: The ip mode is IPv4.\n* IPv6: The ip mode is IPv6.","enum":["IPv4","IPv6"]},"local_connection_server_build":{"type":"string","example":12345678,"description":"Local connection Server build number."},"local_connection_server_version":{"type":"string","example":"8.1.0","description":"Local connection Server version number."},"local_pod_name":{"type":"string","example":"master-pod","description":"The name of the current pod in the Multi-DataCenter Horizon Pod, the value will be null when PodFederation is not initialized."},"timezone_offset":{"type":"integer","format":"int32","example":19800,"description":"Represents the clusters time zone offset from UTC in seconds."}},"title":"EnvironmentInfoV2","description":"Information related to Environment Settings."},"EqualsFilter":{"title":"EqualsFilter","allOf":[{"$ref":"#/definitions/BaseFilter"},{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["And","Or","Not","NotEquals","Equals","Contains","StartsWith","EndsWith","Between"]},"value":{"type":"object"}},"title":"EqualsFilter"}]},"EventDatabaseInfo":{"type":"object","properties":{"admin_events_count":{"type":"integer","format":"int32","example":2000,"description":"The number of events administrator can see in the admin console."},"classify_events_as_new_for_days":{"type":"integer","format":"int32","example":3,"description":"Events will be marked as new for a time based on the value."},"database_name":{"type":"string","example":"eventdb","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."},"event_database_configured":{"type":"boolean","example":true,"description":"Indicates if the event database has been configured or not."},"port":{"type":"integer","format":"int32","example":1443,"description":"Port number on the database server to which Horizon will send events."},"query_timeout_seconds":{"type":"integer","format":"int32","example":120,"description":"Query execution timeout in seconds."},"server_name":{"type":"string","example":"eventdb.horizon.com","description":"The server that hosts the database which will be used to store events."},"show_events_for_time":{"type":"string","example":"THREE_MONTHS","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.","enum":["ONE_WEEK","TWO_WEEKS","THREE_WEEKS","ONE_MONTH","TWO_MONTHS","THREE_MONTHS","SIX_MONTHS"]},"table_prefix":{"type":"string","example":"tab_","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."},"timing_profiler_data_longevity_days":{"type":"integer","format":"int32","example":7,"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."},"type":{"type":"string","example":"SQL_SERVER","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.","enum":["ORACLE","SQL_SERVER","POSTGRESQL"]},"username":{"type":"string","example":"administrator","description":"Username to use for the connection to the event database."}},"title":"EventDatabaseInfo","description":"Information about event database."},"EventDatabaseMonitorDetails":{"type":"object","properties":{"database_name":{"type":"string","example":"HorizonEventDB","description":"The name of the database."},"port":{"type":"integer","format":"int32","example":1433,"description":"The port of the database server."},"prefix":{"type":"string","example":"view_","description":"The prefix for event tables in the database."},"server_name":{"type":"string","example":"event-db.example.com","description":"The name or ip address of the database server."},"type":{"type":"string","example":"SQL_SERVER","description":"The type of the database.\n* ORACLE: An Oracle database.\n* SQL_SERVER: A SQL server database.\n* POSTGRESQL: A PostgreSQL database.","enum":["ORACLE","SQL_SERVER","POSTGRESQL"]},"user_name":{"type":"string","example":"sa","description":"The username used to connect to the database."}},"title":"EventDatabaseMonitorDetails"},"EventDatabaseMonitorInfo":{"type":"object","properties":{"details":{"description":"The basic details of the event database","$ref":"#/definitions/EventDatabaseMonitorDetails"},"event_count":{"type":"integer","format":"int32","example":10000,"description":"Number of events recorded in the database"},"status":{"type":"string","example":"CONNECTED","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.","enum":["CONNECTED","CONNECTING","DISCONNECTED","RECONNECTING","ERROR","NOT_CONFIGURED","UNKNOWN"]}},"title":"EventDatabaseMonitorInfo","description":"Event Database Monitor Information"},"EventDatabaseUpdateSpec":{"type":"object","required":["database_name","password","port","server_name","type","username"],"properties":{"admin_events_count":{"type":"integer","format":"int32","example":2000,"description":"The number of events administrator can see in the admin console. It has a default value of 2000."},"classify_events_as_new_for_days":{"type":"integer","format":"int32","example":3,"description":"Events will be marked as new for a time based on the value. Must be between 1 and 3 days."},"database_name":{"type":"string","example":"eventdb","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."},"password":{"type":"array","example":"","description":"Password to use for the event database connection.","items":{"type":"string"}},"port":{"type":"integer","format":"int32","example":1443,"description":"Port number on the database server to which Horizon will send events."},"query_timeout_seconds":{"type":"integer","format":"int32","example":120,"description":"Query execution timeout in seconds. It has a default value of 120 seconds."},"server_name":{"type":"string","example":"eventdb.horizon.com","description":"The server that hosts the database which will be used to store events."},"show_events_for_time":{"type":"string","example":"THREE_MONTHS","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.","enum":["ONE_WEEK","TWO_WEEKS","THREE_WEEKS","ONE_MONTH","TWO_MONTHS","THREE_MONTHS","SIX_MONTHS"]},"table_prefix":{"type":"string","example":"tab_","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."},"timing_profiler_data_longevity_days":{"type":"integer","format":"int32","example":7,"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."},"type":{"type":"string","example":"SQL_SERVER","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.","enum":["ORACLE","SQL_SERVER","POSTGRESQL"]},"username":{"type":"string","example":"administrator","description":"Username to use for the connection to the event database."}},"title":"EventDatabaseUpdateSpec","description":"Information required to update an event database."},"FarmAutomatedSettingsCreateSpec":{"type":"object","required":["customization_settings","max_session_type","pattern_naming_settings","provisioning_settings","storage_settings","vcenter_id"],"properties":{"customization_settings":{"description":"Customization settings for this automated farm.","$ref":"#/definitions/FarmCustomizationSettingsCreateSpec"},"enable_provisioning":{"type":"boolean","example":true,"description":"Indicates whether to enable provisioning immediately. Default value is true."},"max_session_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","format":"int32","example":50,"description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"min_ready_vms":{"type":"integer","format":"int32","example":0,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"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":"#/definitions/FarmNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"description":"Specifies the naming scheme for the RDS Servers in the automated farm.","$ref":"#/definitions/FarmRDSServersPatternNamingSettingsCreateSpec"},"provisioning_settings":{"description":"Virtual center entities used for provisioning.","$ref":"#/definitions/FarmProvisioningSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Indicates whether provisioning on all VMs stops on error. Default value is true."},"storage_settings":{"description":"Virtual Center storage settings.","$ref":"#/definitions/FarmStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Transparent page sharing scope for the farm. Default value is VM.\n* VM: Inter-VM page sharing is not permitted.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","FARM","POD","GLOBAL"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"ID of the virtual center server."}},"title":"FarmAutomatedSettingsCreateSpec","description":"Settings for Automated farm. This is required if type is set to AUTOMATED."},"FarmAutomatedSettingsCreateSpecV2":{"type":"object","required":["customization_settings","max_session_type","pattern_naming_settings","provisioning_settings","storage_settings","vcenter_id"],"properties":{"customization_settings":{"description":"Customization settings for this automated farm.","$ref":"#/definitions/FarmCustomizationSettingsCreateSpecV2"},"enable_provisioning":{"type":"boolean","example":true,"description":"Indicates whether to enable provisioning immediately. Default value is true."},"max_session_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","format":"int32","example":50,"description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"min_ready_vms":{"type":"integer","format":"int32","example":0,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"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":"#/definitions/FarmNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"description":"Specifies the naming scheme for the RDS Servers in the automated farm.","$ref":"#/definitions/FarmRDSServersPatternNamingSettingsCreateSpec"},"provisioning_settings":{"description":"Virtual center entities used for provisioning.","$ref":"#/definitions/FarmProvisioningSettingsCreateSpec"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Indicates whether provisioning on all VMs stops on error. Default value is true."},"storage_settings":{"description":"Virtual Center storage settings.","$ref":"#/definitions/FarmStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Transparent page sharing scope for the farm. Default value is VM.\n* VM: Inter-VM page sharing is not permitted.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","FARM","POD","GLOBAL"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"ID of the virtual center server."}},"title":"FarmAutomatedSettingsCreateSpecV2","description":"Settings for Automated farm."},"FarmAutomatedSettingsCreateSpecV3":{"type":"object","required":["customization_settings","max_session_type","pattern_naming_settings","provisioning_settings","storage_settings","vcenter_id"],"properties":{"customization_settings":{"description":"Customization settings for this automated farm.","$ref":"#/definitions/FarmCustomizationSettingsCreateSpecV2"},"enable_provisioning":{"type":"boolean","example":true,"description":"Indicates whether to enable provisioning immediately. Default value is true."},"max_session_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","format":"int32","example":50,"description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"min_ready_vms":{"type":"integer","format":"int32","example":0,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"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":"#/definitions/FarmNetworkInterfaceCardSettingsCreateSpec"}},"pattern_naming_settings":{"description":"Specifies the naming scheme for the RDS Servers in the automated farm.","$ref":"#/definitions/FarmRDSServersPatternNamingSettingsCreateSpec"},"provisioning_settings":{"description":"Virtual center entities used for provisioning.","$ref":"#/definitions/FarmProvisioningSettingsCreateSpecV2"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Indicates whether provisioning on all VMs stops on error. Default value is true."},"storage_settings":{"description":"Virtual Center storage settings.","$ref":"#/definitions/FarmStorageSettingsCreateSpec"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Transparent page sharing scope for the farm. Default value is VM.\n* VM: Inter-VM page sharing is not permitted.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","FARM","POD","GLOBAL"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"ID of the virtual center server."}},"title":"FarmAutomatedSettingsCreateSpecV3","description":"Settings for Automated farm."},"FarmAutomatedSettingsInfo":{"type":"object","properties":{"customization_settings":{"description":"Customization settings for this automated farm.","$ref":"#/definitions/FarmCustomizationSettingsInfo"},"enable_provisioning":{"type":"boolean","example":true,"description":"Indicates whether to enable provisioning immediately.
Supported Filters: 'Equals'."},"image_source":{"type":"string","example":"VIRTUAL_CENTER","description":"Source of image used in the farm.
Supported Filters: 'Equals'.\n* VIRTUAL_CENTER: Image was created in virtual center.\n* IMAGE_CATALOG: Image was created in image catalog.","enum":["VIRTUAL_CENTER","IMAGE_CATALOG"]},"max_session_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","format":"int32","example":50,"description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED."},"min_ready_vms":{"type":"integer","format":"int32","example":0,"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."},"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":"#/definitions/FarmNetworkInterfaceCardSettingsInfo"}},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2016","description":"The guest operating system.\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\n* LINUX_SERVER_OTHER: Linux Server (other)","enum":["UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_SERVER_OTHER"]},"operating_system_architecture":{"type":"string","example":"BIT_64","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.","enum":["UNKNOWN","BIT_32","BIT_64"]},"pattern_naming_settings":{"description":"Specifies the naming scheme for the RDS Servers in the automated farm.","$ref":"#/definitions/FarmRDSServersPatternNamingSettingsInfo"},"provisioning_settings":{"description":"Virtual center entities used for provisioning.","$ref":"#/definitions/FarmProvisioningSettingsInfo"},"provisioning_status_data":{"description":"Provisioning status data about this automated farm.","$ref":"#/definitions/FarmProvisioningStatusInfo"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Indicates whether provisioning on all VMs stops on error."},"storage_settings":{"description":"Virtual Center storage settings.","$ref":"#/definitions/FarmStorageSettingsInfo"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Transparent page sharing scope for the farm.\n* VM: Inter-VM page sharing is not permitted.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","FARM","POD","GLOBAL"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"ID of the virtual center server.
Supported Filters: 'Equals'."}},"title":"FarmAutomatedSettingsInfo","description":"Settings for Automated farm."},"FarmAutomatedSettingsInfoV2":{"type":"object","properties":{"customization_settings":{"description":"Customization settings for this automated farm.","$ref":"#/definitions/FarmCustomizationSettingsInfoV2"},"enable_provisioning":{"type":"boolean","example":true,"description":"Indicates whether to enable provisioning immediately.
Supported Filters: 'Equals'."},"image_source":{"type":"string","example":"VIRTUAL_CENTER","description":"Source of image used in the farm.
Supported Filters: 'Equals'.\n* VIRTUAL_CENTER: Image was created in virtual center.\n* IMAGE_CATALOG: Image was created in image catalog.","enum":["VIRTUAL_CENTER","IMAGE_CATALOG"]},"max_session_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","format":"int32","example":50,"description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED."},"min_ready_vms":{"type":"integer","format":"int32","example":0,"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."},"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":"#/definitions/FarmNetworkInterfaceCardSettingsInfo"}},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2016","description":"The guest operating system.\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\n* LINUX_SERVER_OTHER: Linux Server (other)","enum":["UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_SERVER_OTHER"]},"operating_system_architecture":{"type":"string","example":"BIT_64","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.","enum":["UNKNOWN","BIT_32","BIT_64"]},"pattern_naming_settings":{"description":"Specifies the naming scheme for the RDS Servers in the automated farm.","$ref":"#/definitions/FarmRDSServersPatternNamingSettingsInfo"},"provisioning_settings":{"description":"Virtual center entities used for provisioning.","$ref":"#/definitions/FarmProvisioningSettingsInfo"},"provisioning_status_data":{"description":"Provisioning status data about this automated farm.","$ref":"#/definitions/FarmProvisioningStatusInfo"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Indicates whether provisioning on all VMs stops on error."},"storage_settings":{"description":"Virtual Center storage settings.","$ref":"#/definitions/FarmStorageSettingsInfo"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Transparent page sharing scope for the farm.\n* VM: Inter-VM page sharing is not permitted.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","FARM","POD","GLOBAL"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"ID of the virtual center server.
Supported Filters: 'Equals'."}},"title":"FarmAutomatedSettingsInfoV2","description":"Settings for Automated farm."},"FarmAutomatedSettingsInfoV3":{"type":"object","properties":{"customization_settings":{"description":"Customization settings for this automated farm.","$ref":"#/definitions/FarmCustomizationSettingsInfoV2"},"enable_provisioning":{"type":"boolean","example":true,"description":"Indicates whether to enable provisioning immediately.
Supported Filters: 'Equals'."},"image_source":{"type":"string","example":"VIRTUAL_CENTER","description":"Source of image used in the farm.
Supported Filters: 'Equals'.\n* VIRTUAL_CENTER: Image was created in virtual center.\n* IMAGE_CATALOG: Image was created in image catalog.","enum":["VIRTUAL_CENTER","IMAGE_CATALOG"]},"max_session_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","format":"int32","example":50,"description":"Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED."},"min_ready_vms":{"type":"integer","format":"int32","example":0,"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."},"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":"#/definitions/FarmNetworkInterfaceCardSettingsInfo"}},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2016","description":"The guest operating system.\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\n* LINUX_SERVER_OTHER: Linux Server (other)","enum":["UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_SERVER_OTHER"]},"operating_system_architecture":{"type":"string","example":"BIT_64","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.","enum":["UNKNOWN","BIT_32","BIT_64"]},"pattern_naming_settings":{"description":"Specifies the naming scheme for the RDS Servers in the automated farm.","$ref":"#/definitions/FarmRDSServersPatternNamingSettingsInfo"},"provisioning_settings":{"description":"Virtual center entities used for provisioning.","$ref":"#/definitions/FarmProvisioningSettingsInfoV2"},"provisioning_status_data":{"description":"Provisioning status data about this automated farm.","$ref":"#/definitions/FarmProvisioningStatusInfoV2"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Indicates whether provisioning on all VMs stops on error."},"storage_settings":{"description":"Virtual Center storage settings.","$ref":"#/definitions/FarmStorageSettingsInfo"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Transparent page sharing scope for the farm.\n* VM: Inter-VM page sharing is not permitted.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","FARM","POD","GLOBAL"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"ID of the virtual center server.
Supported Filters: 'Equals'."}},"title":"FarmAutomatedSettingsInfoV3","description":"Settings for Automated farm."},"FarmAutomatedSettingsUpdateSpec":{"type":"object","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"],"properties":{"customization_settings":{"description":"Customization settings for this automated farm.","$ref":"#/definitions/FarmCustomizationSettingsUpdateSpec"},"enable_provisioning":{"type":"boolean","example":true,"description":"Indicates whether to enable provisioning immediately."},"max_session_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","format":"int32","example":50,"description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"min_ready_vms":{"type":"integer","format":"int32","example":0,"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. ","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"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":"#/definitions/FarmNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"description":"Specifies the naming scheme for the RDS Servers in the automated farm.","$ref":"#/definitions/FarmRDSServersPatternNamingSettingsUpdateSpec"},"provisioning_settings":{"description":"Virtual center entities used for provisioning.","$ref":"#/definitions/FarmProvisioningSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Indicates whether provisioning on all VMs stops on error."},"storage_settings":{"description":"Virtual Center storage settings.","$ref":"#/definitions/FarmStorageSettingsUpdateSpec"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Transparent page sharing scope for the farm.\n* VM: Inter-VM page sharing is not permitted.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","FARM","POD","GLOBAL"]}},"title":"FarmAutomatedSettingsUpdateSpec","description":"Settings for Automated farm. This is required if type is set to AUTOMATED."},"FarmAutomatedSettingsUpdateSpecV2":{"type":"object","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"],"properties":{"customization_settings":{"description":"Customization settings for this automated farm.","$ref":"#/definitions/FarmCustomizationSettingsUpdateSpecV2"},"enable_provisioning":{"type":"boolean","example":true,"description":"Indicates whether to enable provisioning immediately."},"max_session_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"max_sessions":{"type":"integer","format":"int32","example":50,"description":"Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"min_ready_vms":{"type":"integer","format":"int32","example":0,"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. ","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"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":"#/definitions/FarmNetworkInterfaceCardSettingsUpdateSpec"}},"pattern_naming_settings":{"description":"Specifies the naming scheme for the RDS Servers in the automated farm.","$ref":"#/definitions/FarmRDSServersPatternNamingSettingsUpdateSpec"},"provisioning_settings":{"description":"Virtual center entities used for provisioning.","$ref":"#/definitions/FarmProvisioningSettingsUpdateSpec"},"stop_provisioning_on_error":{"type":"boolean","example":true,"description":"Indicates whether provisioning on all VMs stops on error."},"storage_settings":{"description":"Virtual Center storage settings.","$ref":"#/definitions/FarmStorageSettingsUpdateSpec"},"transparent_page_sharing_scope":{"type":"string","example":"VM","description":"Transparent page sharing scope for the farm.\n* VM: Inter-VM page sharing is not permitted.\n* FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.\n* POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.\n* GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.","enum":["VM","FARM","POD","GLOBAL"]}},"title":"FarmAutomatedSettingsUpdateSpecV2","description":"Settings for Automated farm."},"FarmCancelMaintenanceSpec":{"type":"object","required":["maintenance_mode"],"properties":{"maintenance_mode":{"type":"string","example":"IMMEDIATE","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","enum":["IMMEDIATE","RECURRING"]}},"title":"FarmCancelMaintenanceSpec","description":"Information required to cancel the farm scheduled maintenance operation."},"FarmCloneprepCustomizationSettingsCreateSpec":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","example":"cloneprep_postsync_script","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."},"post_synchronization_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Post synchronization script parameters."},"power_off_script_name":{"type":"string","example":"cloneprep_poweroff_script","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."},"power_off_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Power off script parameters."},"priming_computer_account":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","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."}},"title":"FarmCloneprepCustomizationSettingsCreateSpec","description":"Settings for ClonePrep customization for the farm."},"FarmCloneprepCustomizationSettingsInfo":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","example":"cloneprep_postsync_script","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."},"post_synchronization_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Post synchronization script parameters."},"power_off_script_name":{"type":"string","example":"cloneprep_poweroff_script","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."},"power_off_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Power off script parameters."},"priming_computer_account":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","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."}},"title":"FarmCloneprepCustomizationSettingsInfo","description":"Settings for ClonePrep customization for the farm."},"FarmCloneprepCustomizationSettingsUpdateSpec":{"type":"object","properties":{"post_synchronization_script_name":{"type":"string","example":"cloneprep_postsync_script","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."},"post_synchronization_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Post synchronization script parameters."},"power_off_script_name":{"type":"string","example":"cloneprep_poweroff_script","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."},"power_off_script_parameters":{"type":"string","example":"p1 p2 p3","description":"Power off script parameters."},"priming_computer_account":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","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."}},"title":"FarmCloneprepCustomizationSettingsUpdateSpec","description":"Settings for ClonePrep customization for the farm."},"FarmCreateSpec":{"type":"object","required":["access_group_id","name","type"],"properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration."},"automated_farm_settings":{"description":"Settings for Automated farm. This is required if type is set to AUTOMATED.","$ref":"#/definitions/FarmAutomatedSettingsCreateSpec"},"description":{"type":"string","example":"Farm Description","description":"Description of the farm.","maxLength":1024},"display_name":{"type":"string","example":"ManualFarm","description":"Display name of the farm. If the display name is left blank, it defaults to name.","maxLength":256},"display_protocol_settings":{"description":"Display protocol settings for the farm.","$ref":"#/definitions/FarmDisplayProtocolSettingsCreateSpec"},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the farm is enabled for brokering. Default value is true."},"load_balancer_settings":{"description":"RDSH load balancer settings for the farm. This is required if use_custom_script_for_load_balancing is false.","$ref":"#/definitions/RDSHLoadBalancerSettingsCreateSpec"},"name":{"type":"string","example":"ManualFarm","description":"Name of the farm. This property must contain only alphanumerics, underscores, and dashes.","minLength":1,"maxLength":64},"rds_server_ids":{"type":"array","example":["5134796a-322g-5fe5-343f-4daa5d25ebfe","2a43f96c-102b-4ed3-953f-35deg43d43b0ge"],"description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","items":{"type":"string"}},"server_error_threshold":{"type":"integer","format":"int32","example":0,"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."},"session_settings":{"description":"Session related settings for the Farm.","$ref":"#/definitions/FarmSessionSettingsCreateSpec"},"type":{"type":"string","example":"MANUAL","description":"Type of the farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","example":false,"description":"Indicates whether to use custom scripts for load balancing or not. Default value is false."}},"title":"FarmCreateSpec","description":"Information required to create a farm."},"FarmCreateSpecV2":{"type":"object","required":["access_group_id","name","type"],"properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration."},"automated_farm_settings":{"description":"Settings for Automated farm. This is required if type is set to AUTOMATED.","$ref":"#/definitions/FarmAutomatedSettingsCreateSpecV2"},"description":{"type":"string","example":"Farm Description","description":"Description of the farm.","maxLength":1024},"display_name":{"type":"string","example":"ManualFarm","description":"Display name of the farm. If the display name is left blank, it defaults to name.","maxLength":256},"display_protocol_settings":{"description":"Display protocol settings for the farm.","$ref":"#/definitions/FarmDisplayProtocolSettingsCreateSpec"},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the farm is enabled for brokering. Default value is true."},"load_balancer_settings":{"description":"RDSH load balancer settings for the farm. This is required if use_custom_script_for_load_balancing is false.","$ref":"#/definitions/RDSHLoadBalancerSettingsCreateSpec"},"name":{"type":"string","example":"ManualFarm","description":"Name of the farm. This property must contain only alphanumerics, underscores, and dashes.","minLength":1,"maxLength":64},"rds_server_ids":{"type":"array","example":["5134796a-322g-5fe5-343f-4daa5d25ebfe","2a43f96c-102b-4ed3-953f-35deg43d43b0ge"],"description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","items":{"type":"string"}},"server_error_threshold":{"type":"integer","format":"int32","example":0,"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."},"session_settings":{"description":"Session related settings for the Farm.","$ref":"#/definitions/FarmSessionSettingsCreateSpec"},"type":{"type":"string","example":"MANUAL","description":"Type of the farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","example":false,"description":"Indicates whether to use custom scripts for load balancing or not. Default value is false."}},"title":"FarmCreateSpecV2","description":"Information required to create a farm."},"FarmCreateSpecV3":{"type":"object","required":["access_group_id","name","type"],"properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration."},"automated_farm_settings":{"description":"Settings for Automated farm. This is required if type is set to AUTOMATED.","$ref":"#/definitions/FarmAutomatedSettingsCreateSpecV3"},"description":{"type":"string","example":"Farm Description","description":"Description of the farm.","maxLength":1024},"display_name":{"type":"string","example":"ManualFarm","description":"Display name of the farm. If the display name is left blank, it defaults to name.","maxLength":256},"display_protocol_settings":{"description":"Display protocol settings for the farm.","$ref":"#/definitions/FarmDisplayProtocolSettingsCreateSpec"},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the farm is enabled for brokering. Default value is true."},"load_balancer_settings":{"description":"RDSH load balancer settings for the farm. This is required if use_custom_script_for_load_balancing is false.","$ref":"#/definitions/RDSHLoadBalancerSettingsCreateSpecV2"},"name":{"type":"string","example":"ManualFarm","description":"Name of the farm. This property must contain only alphanumerics, underscores, and dashes.","minLength":1,"maxLength":64},"rds_server_ids":{"type":"array","example":["5134796a-322g-5fe5-343f-4daa5d25ebfe","2a43f96c-102b-4ed3-953f-35deg43d43b0ge"],"description":"List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.","items":{"type":"string"}},"server_error_threshold":{"type":"integer","format":"int32","example":0,"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."},"session_settings":{"description":"Session related settings for the Farm.","$ref":"#/definitions/FarmSessionSettingsCreateSpecV2"},"type":{"type":"string","example":"MANUAL","description":"Type of the farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","example":false,"description":"Indicates whether to use custom scripts for load balancing or not. Default value is false."}},"title":"FarmCreateSpecV3","description":"Information required to create a farm."},"FarmCustomizationSettingsCreateSpec":{"type":"object","required":["instant_clone_domain_account_id"],"properties":{"ad_container_rdn":{"type":"string","example":"CN=Computers","description":"Instant Clone Engine Active Directory container for clone prep. Default value is CN=Computers"},"cloneprep_customization_settings":{"description":"Clone prep customization settings for the farm.","$ref":"#/definitions/FarmCloneprepCustomizationSettingsCreateSpec"},"instant_clone_domain_account_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Instant clone domain account. This is the administrator which will add the machines to its domain upon creation."},"reuse_pre_existing_accounts":{"type":"boolean","example":false,"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."}},"title":"FarmCustomizationSettingsCreateSpec","description":"Customization settings for the automated farm."},"FarmCustomizationSettingsCreateSpecV2":{"type":"object","required":["customization_type","instant_clone_domain_account_id"],"properties":{"ad_container_rdn":{"type":"string","example":"CN=Computers","description":"Instant Clone Engine Active Directory container for clone prep. Default value is CN=Computers"},"cloneprep_customization_settings":{"description":"Clone prep customization settings for the farm.","$ref":"#/definitions/FarmCloneprepCustomizationSettingsCreateSpec"},"customization_type":{"type":"string","example":"CLONE_PREP","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.
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.
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.","enum":["SYS_PREP","CLONE_PREP"]},"instant_clone_domain_account_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Instant clone domain account. This is the administrator which will add the machines to its domain upon creation."},"reuse_pre_existing_accounts":{"type":"boolean","example":false,"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."},"sysprep_customization_spec_id":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","description":"Customization specification to use when Sysprep customization is requested. This is required if customization_type is set to SYS_PREP"}},"title":"FarmCustomizationSettingsCreateSpecV2","description":"Customization settings for the automated farm."},"FarmCustomizationSettingsInfo":{"type":"object","properties":{"ad_container_rdn":{"type":"string","example":"CN=Computers","description":"Instant Clone Engine Active Directory container for clone prep."},"cloneprep_customization_settings":{"description":"Clone prep customization settings for the farm.","$ref":"#/definitions/FarmCloneprepCustomizationSettingsInfo"},"instant_clone_domain_account_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Instant clone domain account. This is the administrator which will add the machines to its domain upon creation."},"reuse_pre_existing_accounts":{"type":"boolean","example":false,"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."}},"title":"FarmCustomizationSettingsInfo","description":"Customization settings for the automated farm."},"FarmCustomizationSettingsInfoV2":{"type":"object","properties":{"ad_container_rdn":{"type":"string","example":"CN=Computers","description":"Instant Clone Engine Active Directory container for clone prep."},"cloneprep_customization_settings":{"description":"Clone prep customization settings for the farm.","$ref":"#/definitions/FarmCloneprepCustomizationSettingsInfo"},"customization_type":{"type":"string","example":"CLONE_PREP","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.
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.
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.","enum":["SYS_PREP","CLONE_PREP"]},"instant_clone_domain_account_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Instant clone domain account. This is the administrator which will add the machines to its domain upon creation."},"reuse_pre_existing_accounts":{"type":"boolean","example":false,"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."},"sysprep_customization_spec_id":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","description":"Customization specification used when Sysprep customization is requested. This will be set if customization_type is set to SYS_PREP "}},"title":"FarmCustomizationSettingsInfoV2","description":"Customization settings for the automated farm."},"FarmCustomizationSettingsUpdateSpec":{"type":"object","required":["ad_container_rdn","cloneprep_customization_settings","reuse_pre_existing_accounts"],"properties":{"ad_container_rdn":{"type":"string","example":"CN=Computers","description":"Instant Clone Engine Active Directory container for clone prep."},"cloneprep_customization_settings":{"description":"Clone prep customization settings for the farm.","$ref":"#/definitions/FarmCloneprepCustomizationSettingsUpdateSpec"},"reuse_pre_existing_accounts":{"type":"boolean","example":false,"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."}},"title":"FarmCustomizationSettingsUpdateSpec","description":"Customization settings for the automated farm."},"FarmCustomizationSettingsUpdateSpecV2":{"type":"object","required":["ad_container_rdn","cloneprep_customization_settings","customization_type","instant_clone_domain_account_id","reuse_pre_existing_accounts"],"properties":{"ad_container_rdn":{"type":"string","example":"CN=Computers","description":"Instant Clone Engine Active Directory container for clone prep."},"cloneprep_customization_settings":{"description":"Clone prep customization settings for the farm.","$ref":"#/definitions/FarmCloneprepCustomizationSettingsUpdateSpec"},"customization_type":{"type":"string","example":"CLONE_PREP","description":"Type of customization to use.\n* SYS_PREP: Applicable To: Instant clone automated Farms.
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.
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.","enum":["SYS_PREP","CLONE_PREP"]},"instant_clone_domain_account_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Instant clone domain account. This is the administrator which will add the machines to its domain."},"reuse_pre_existing_accounts":{"type":"boolean","example":false,"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."},"sysprep_customization_spec_id":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","description":"Customization specification to use when Sysprep customization is requested. This is required if customization_type is set to SYS_PREP"}},"title":"FarmCustomizationSettingsUpdateSpecV2","description":"Customization settings for the automated farm."},"FarmDatastoreSettingsCreateSpec":{"type":"object","required":["datastore_id"],"properties":{"datastore_id":{"type":"string","example":"datastore-1","description":"Id of the datastore."}},"title":"FarmDatastoreSettingsCreateSpec","description":"Datastore settings for the automated farm."},"FarmDatastoreSettingsInfo":{"type":"object","properties":{"datastore_id":{"type":"string","example":"datastore-1","description":"Id of the datastore."},"storage_overcommit":{"type":"string","example":"CONSERVATIVE","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.","enum":["NONE","CONSERVATIVE","MODERATE","AGGRESSIVE","UNBOUNDED"]}},"title":"FarmDatastoreSettingsInfo","description":"Datastore settings for the automated farm."},"FarmDatastoreSettingsUpdateSpec":{"type":"object","required":["datastore_id"],"properties":{"datastore_id":{"type":"string","example":"datastore-1","description":"Id of the datastore."}},"title":"FarmDatastoreSettingsUpdateSpec","description":"Datastore settings for the automated farm."},"FarmDisplayProtocolSettings":{"type":"object","properties":{"allow_display_protocol_override":{"type":"boolean","example":true,"description":"Indicates whether the display protocol settings could be overridden.If set to false, then default_display_protocol is used.Default value is true."},"default_display_protocol":{"type":"string","example":"PCOIP","description":"The default server display protocol. Default value is PCOIP.\n* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"grid_vgpus_enabled":{"type":"boolean","example":false,"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."},"html_access_enabled":{"type":"boolean","example":true,"description":"This property is no longer in use for Horizon Components. It is always set to true. HTML Access, enabled by VMware 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."},"session_collaboration_enabled":{"type":"boolean","example":false,"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."},"vgpu_grid_profile":{"type":"string","example":"instant-profile","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."}},"title":"FarmDisplayProtocolSettings","description":"Display protocol settings for the Farm."},"FarmDisplayProtocolSettingsCreateSpec":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","example":true,"description":"Indicates whether the users can choose the protocol. Default value is true."},"default_display_protocol":{"type":"string","example":"PCOIP","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* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"grid_vgpus_enabled":{"type":"boolean","example":true,"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."},"session_collaboration_enabled":{"type":"boolean","example":false,"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."}},"title":"FarmDisplayProtocolSettingsCreateSpec","description":"Display protocol settings for the farm."},"FarmDisplayProtocolSettingsInfo":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","example":true,"description":"Indicates whether the users can choose the protocol."},"default_display_protocol":{"type":"string","example":"PCOIP","description":"Indicates default server display protocol, when user is not allowed to choose protocol.Farms support PCOIP, RDP and BLAST.\n* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"grid_vgpus_enabled":{"type":"boolean","example":false,"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."},"session_collaboration_enabled":{"type":"boolean","example":false,"description":"Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users."},"vgpu_grid_profile":{"type":"string","example":"instant-profile","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."}},"title":"FarmDisplayProtocolSettingsInfo","description":"Display protocol settings for the farm."},"FarmDisplayProtocolSettingsUpdateSpec":{"type":"object","required":["allow_users_to_choose_protocol","default_display_protocol","session_collaboration_enabled"],"properties":{"allow_users_to_choose_protocol":{"type":"boolean","example":true,"description":"Indicates whether the users can choose the protocol."},"default_display_protocol":{"type":"string","example":"PCOIP","description":"Indicates default server display protocol, when user is not allowed to choose protocol.Farms support PCOIP, RDP and BLAST.\n* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"session_collaboration_enabled":{"type":"boolean","example":false,"description":"Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users."}},"title":"FarmDisplayProtocolSettingsUpdateSpec","description":"Display protocol settings for the farm."},"FarmInfo":{"type":"object","properties":{"description":{"type":"string","example":"Farm description","description":"Farm description. The maximum length is 1024 characters."},"display_name":{"type":"string","example":"Farm-display-1","description":"Display name of the Farm. The maximum length is 256 characters."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the Farm is enabled for brokering. Default value is true."},"id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"Unique ID representing Farm."},"name":{"type":"string","example":"ManualFarm1","description":"Name of the Farm. The maximum length is 64 characters."},"settings":{"description":"Settings related to the Farm.","$ref":"#/definitions/FarmSettings"},"source":{"type":"string","example":"INSTANT_CLONE","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.","enum":["INSTANT_CLONE","LINKED_CLONE"]},"type":{"type":"string","example":"AUTOMATED","description":"Type of the Farm.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","enum":["AUTOMATED","MANUAL"]}},"title":"FarmInfo","description":"Information related to Farm."},"FarmInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'."},"automated_farm_settings":{"description":"Settings for Automated farm. This is set when type is AUTOMATED.","$ref":"#/definitions/FarmAutomatedSettingsInfo"},"delete_in_progress":{"type":"boolean","example":false,"description":"Indicates whether the farm is in the process of being deleted.
Supported Filters: 'Equals'."},"description":{"type":"string","example":"Farm Description","description":"Description of the farm. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"desktop_pool_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"ID of RDS desktop pool associated with the farm.
Supported Filters: 'Equals'."},"display_name":{"type":"string","example":"ManualFarm","description":"Display name of the farm. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_protocol_settings":{"description":"Display protocol settings for the farm.","$ref":"#/definitions/FarmDisplayProtocolSettingsInfo"},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the farm is enabled for brokering.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4","description":"Unique ID representing farm.
Supported Filters: 'Equals'."},"load_balancer_settings":{"description":"RDSH load balancer settings for the farm. This is set when use_custom_script_for_load_balancing is false.","$ref":"#/definitions/RDSHLoadBalancerSettingsInfo"},"name":{"type":"string","example":"ManualFarm","description":"Name of the farm. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"server_error_threshold":{"type":"integer","format":"int32","example":0,"description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. "},"session_settings":{"description":"Session related settings for the Farm.","$ref":"#/definitions/FarmSessionSettingsInfo"},"type":{"type":"string","example":"MANUAL","description":"Type of the farm.
Supported Filters: 'Equals'.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","example":false,"description":"Indicates whether to use custom scripts for load balancing or not."}},"title":"FarmInfoV2","description":"Information related to Farm.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"FarmInfoV3":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'."},"automated_farm_settings":{"description":"Settings for Automated farm. This is set when type is AUTOMATED.","$ref":"#/definitions/FarmAutomatedSettingsInfoV2"},"delete_in_progress":{"type":"boolean","example":false,"description":"Indicates whether the farm is in the process of being deleted.
Supported Filters: 'Equals'."},"description":{"type":"string","example":"Farm Description","description":"Description of the farm. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"desktop_pool_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"ID of RDS desktop pool associated with the farm.
Supported Filters: 'Equals'."},"display_name":{"type":"string","example":"ManualFarm","description":"Display name of the farm. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_protocol_settings":{"description":"Display protocol settings for the farm.","$ref":"#/definitions/FarmDisplayProtocolSettingsInfo"},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the farm is enabled for brokering.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4","description":"Unique ID representing farm.
Supported Filters: 'Equals'."},"load_balancer_settings":{"description":"RDSH load balancer settings for the farm. This is set when use_custom_script_for_load_balancing is false.","$ref":"#/definitions/RDSHLoadBalancerSettingsInfo"},"name":{"type":"string","example":"ManualFarm","description":"Name of the farm. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"server_error_threshold":{"type":"integer","format":"int32","example":0,"description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. "},"session_settings":{"description":"Session related settings for the Farm.","$ref":"#/definitions/FarmSessionSettingsInfo"},"type":{"type":"string","example":"MANUAL","description":"Type of the farm.
Supported Filters: 'Equals'.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","example":false,"description":"Indicates whether to use custom scripts for load balancing or not."}},"title":"FarmInfoV3","description":"Information related to Farm.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"FarmInfoV4":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'."},"automated_farm_settings":{"description":"Settings for Automated farm. This is set when type is AUTOMATED.","$ref":"#/definitions/FarmAutomatedSettingsInfoV3"},"delete_in_progress":{"type":"boolean","example":false,"description":"Indicates whether the farm is in the process of being deleted.
Supported Filters: 'Equals'."},"description":{"type":"string","example":"Farm Description","description":"Description of the farm. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"desktop_pool_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"ID of RDS desktop pool associated with the farm.
Supported Filters: 'Equals'."},"display_name":{"type":"string","example":"ManualFarm","description":"Display name of the farm. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_protocol_settings":{"description":"Display protocol settings for the farm.","$ref":"#/definitions/FarmDisplayProtocolSettingsInfo"},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the farm is enabled for brokering.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4","description":"Unique ID representing farm.
Supported Filters: 'Equals'."},"load_balancer_settings":{"description":"RDSH load balancer settings for the farm. This is set when use_custom_script_for_load_balancing is false.","$ref":"#/definitions/RDSHLoadBalancerSettingsInfoV2"},"name":{"type":"string","example":"ManualFarm","description":"Name of the farm. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"server_error_threshold":{"type":"integer","format":"int32","example":0,"description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. "},"session_settings":{"description":"Session related settings for the Farm.","$ref":"#/definitions/FarmSessionSettingsInfoV2"},"type":{"type":"string","example":"MANUAL","description":"Type of the farm.
Supported Filters: 'Equals'.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","example":false,"description":"Indicates whether to use custom scripts for load balancing or not."}},"title":"FarmInfoV4","description":"Information related to Farm.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"FarmInfoV5":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'."},"app_volumes_manager_guid":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"Associated app volumes manager id for the Farm."},"automated_farm_settings":{"description":"Settings for Automated farm. This is set when type is AUTOMATED.","$ref":"#/definitions/FarmAutomatedSettingsInfoV3"},"delete_in_progress":{"type":"boolean","example":false,"description":"Indicates whether the farm is in the process of being deleted.
Supported Filters: 'Equals'."},"description":{"type":"string","example":"Farm Description","description":"Description of the farm. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"desktop_pool_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"ID of RDS desktop pool associated with the farm.
Supported Filters: 'Equals'."},"display_name":{"type":"string","example":"ManualFarm","description":"Display name of the farm. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_protocol_settings":{"description":"Display protocol settings for the farm.","$ref":"#/definitions/FarmDisplayProtocolSettingsInfo"},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the farm is enabled for brokering.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"50d77b95-fcc0-448a-a478-ec4f3b657ca4","description":"Unique ID representing farm.
Supported Filters: 'Equals'."},"load_balancer_settings":{"description":"RDSH load balancer settings for the farm. This is set when use_custom_script_for_load_balancing is false.","$ref":"#/definitions/RDSHLoadBalancerSettingsInfoV2"},"name":{"type":"string","example":"ManualFarm","description":"Name of the farm. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'."},"server_error_threshold":{"type":"integer","format":"int32","example":0,"description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. "},"session_settings":{"description":"Session related settings for the Farm.","$ref":"#/definitions/FarmSessionSettingsInfoV2"},"type":{"type":"string","example":"MANUAL","description":"Type of the farm.
Supported Filters: 'Equals'.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual Farm.","enum":["AUTOMATED","MANUAL"]},"use_custom_script_for_load_balancing":{"type":"boolean","example":false,"description":"Indicates whether to use custom scripts for load balancing or not."}},"title":"FarmInfoV5","description":"Information related to Farm.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"FarmLoadBalancerSettings":{"type":"object","properties":{"custom_script_in_use":{"type":"boolean","example":false,"description":"Indicates whether to use custom scripts for Load Balancing.Default is false."},"lb_metric_settings":{"description":"Metrics used for load balancing. Will be set only when custom_script_in_use is set to false.","$ref":"#/definitions/LoadBalancerMetricSettings"}},"title":"FarmLoadBalancerSettings","description":"Settings for load balancing the session requests across the RDS servers in the farm."},"FarmMaintenanceSpec":{"type":"object","required":["logoff_policy","maintenance_mode"],"properties":{"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","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."},"im_tag_id":{"type":"string","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51","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."},"logoff_policy":{"type":"string","example":"FORCE_LOGOFF","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.","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"maintenance_mode":{"type":"string","example":"IMMEDIATE","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","enum":["IMMEDIATE","RECURRING"]},"next_scheduled_time":{"type":"integer","format":"int64","example":1237081283000,"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."},"parent_vm_id":{"type":"string","example":"vm-2","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."},"recurring_maintenance_settings":{"description":"Settings for recurring maintenance operation for the farm. This is required only if maintenance_mode is set to RECURRING","$ref":"#/definitions/FarmRecurringMaintenanceSettingsSpec"},"snapshot_id":{"type":"string","example":"snapshot-1","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."},"stop_on_first_error":{"type":"boolean","example":false,"description":"Indicates whether the operation should stop on first error. Default value is true."}},"title":"FarmMaintenanceSpec","description":"Information required to schedule maintenance operation on farm."},"FarmMaintenanceSpecV2":{"type":"object","required":["logoff_policy","maintenance_mode"],"properties":{"compute_profile_num_cores_per_socket":{"type":"integer","format":"int32","example":1,"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. ","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"compute_profile_num_cpus":{"type":"integer","format":"int32","example":4,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"compute_profile_ram_mb":{"type":"integer","format":"int32","example":4096,"description":"Indicates the RAM in MB in the compute profile to be configured on clones.","minimum":1024,"exclusiveMinimum":false,"exclusiveMaximum":false},"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","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."},"im_tag_id":{"type":"string","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51","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."},"logoff_policy":{"type":"string","example":"FORCE_LOGOFF","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.","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"maintenance_mode":{"type":"string","example":"IMMEDIATE","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","enum":["IMMEDIATE","RECURRING"]},"next_scheduled_time":{"type":"integer","format":"int64","example":1237081283000,"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."},"parent_vm_id":{"type":"string","example":"vm-2","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."},"rds_server_ids":{"type":"array","example":["816d44cb-b486-3c97-adcb-cf3806d53657", "414927f3-1a3b-3e4c-81b3-d39602f634dc"],"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.","items":{"type":"string"}},"recurring_maintenance_settings":{"description":"Settings for recurring maintenance operation for the farm. This is required only if maintenance_mode is set to RECURRING","$ref":"#/definitions/FarmRecurringMaintenanceSettingsSpec"},"selective_schedule_maintenance":{"type":"boolean","example":true,"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."},"snapshot_id":{"type":"string","example":"snapshot-1","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."},"stop_on_first_error":{"type":"boolean","example":false,"description":"Indicates whether the operation should stop on first error. Default value is true."}},"title":"FarmMaintenanceSpecV2","description":"Information required to schedule maintenance operation on farm."},"FarmMonitorDetails":{"type":"object","properties":{"source":{"type":"string","example":"LINKED_CLONE","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.","enum":["LINKED_CLONE","INSTANT_CLONE"]},"type":{"type":"string","example":"AUTOMATED","description":"Farm type.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual farm.","enum":["AUTOMATED","MANUAL"]}},"title":"FarmMonitorDetails","description":"Details of the Farm."},"FarmMonitorInfo":{"type":"object","properties":{"application_count":{"type":"integer","format":"int32","example":12,"description":"Number of Applications published from the farm."},"details":{"description":"Details of Farm.","$ref":"#/definitions/FarmMonitorDetails"},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the Farm."},"name":{"type":"string","example":"farm1","description":"Farm name."},"rds_server_count":{"type":"integer","format":"int32","example":123,"description":"Number of RDS Servers in the farm."},"status":{"type":"string","example":"OK","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.","enum":["OK","WARNING","ERROR","DISABLED"]}},"title":"FarmMonitorInfo","description":"Monitoring information related to Farm."},"FarmNetworkInterfaceCardSettingsCreateSpec":{"type":"object","required":["network_interface_card_id"],"properties":{"network_interface_card_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","description":"ID of the network interface card for these settings."},"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.
If this is not set, the feature is disabled.
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":"#/definitions/FarmNetworkLabelAssignmentSettingsCreateSpec"}}},"title":"FarmNetworkInterfaceCardSettingsCreateSpec","description":"Network interface card settings for RDS Servers provisioned for the farm."},"FarmNetworkInterfaceCardSettingsInfo":{"type":"object","properties":{"network_interface_card_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","description":"ID of the network interface card for these settings."},"network_interface_card_name":{"type":"string","example":"Network adapter 1","description":"Name of the network interface card for these settings."},"network_label_assignment_specs":{"type":"array","description":"Automatic network label assignment feature settings for this NIC.","items":{"$ref":"#/definitions/NetworkLabelAssignmentSettingsInfo"}}},"title":"FarmNetworkInterfaceCardSettingsInfo","description":"Network interface card settings for RDS Servers provisioned for the farm."},"FarmNetworkInterfaceCardSettingsUpdateSpec":{"type":"object","required":["network_interface_card_id"],"properties":{"network_interface_card_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","description":"ID of the network interface card for these settings."},"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.
If this is not set, the feature is disabled.
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.
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":"#/definitions/FarmNetworkLabelAssignmentSettingsUpdateSpec"}}},"title":"FarmNetworkInterfaceCardSettingsUpdateSpec","description":"Network interface card settings for RDS Servers provisioned for the farm."},"FarmNetworkLabelAssignmentSettingsCreateSpec":{"type":"object","required":["max_label_type","network_label_name"],"properties":{"enabled":{"type":"boolean","example":true,"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."},"max_label":{"type":"integer","format":"int32","example":1,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"max_label_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","example":"vm-network","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."}},"title":"FarmNetworkLabelAssignmentSettingsCreateSpec","description":"Network label assignment settings for the farm."},"FarmNetworkLabelAssignmentSettingsUpdateSpec":{"type":"object","required":["enabled","max_label_type","network_label_name"],"properties":{"enabled":{"type":"boolean","example":true,"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."},"max_label":{"type":"integer","format":"int32","example":1,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"max_label_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","example":"vm-network","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."}},"title":"FarmNetworkLabelAssignmentSettingsUpdateSpec","description":"Network label assignment settings for the farm."},"FarmProvisioningSettingsCreateSpec":{"type":"object","required":["datacenter_id","host_or_cluster_id","resource_pool_id","vm_folder_id"],"properties":{"base_snapshot_id":{"type":"string","example":"snapshot-1","description":"Current image snapshot for instant clone farm."},"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter within which the farm is configured"},"host_or_cluster_id":{"type":"string","example":"domain-s425","description":"Host or cluster where the machines are deployed in. For Instant clone farms it can be only be a cluster id."},"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Image management stream used in the farm. This is required if parent_vm_id and base_snapshot_id are not set."},"im_tag_id":{"type":"string","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Image management tag used in the farm. This is required if im_stream_id is set."},"parent_vm_id":{"type":"string","example":"vm-2","description":"Current VM image for instant clone farm."},"resource_pool_id":{"type":"string","example":"resgroup-1","description":"Resource pool to deploy the RDS Servers."},"vm_folder_id":{"type":"string","example":"group-v1","description":"VM folder to deploy the RDS Servers to."}},"title":"FarmProvisioningSettingsCreateSpec","description":"Virtual center provisioning settings for the farm."},"FarmProvisioningSettingsCreateSpecV2":{"type":"object","required":["datacenter_id","host_or_cluster_id","resource_pool_id","vm_folder_id"],"properties":{"base_snapshot_id":{"type":"string","example":"snapshot-1","description":"Current image snapshot for instant clone farm."},"compute_profile_num_cores_per_socket":{"type":"integer","format":"int32","example":1,"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. ","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"compute_profile_num_cpus":{"type":"integer","format":"int32","example":4,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"compute_profile_ram_mb":{"type":"integer","format":"int32","example":4096,"description":"Indicates the RAM in MB in the compute profile to be configured on clones.","minimum":1024,"exclusiveMinimum":false,"exclusiveMaximum":false},"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter within which the farm is configured"},"host_or_cluster_id":{"type":"string","example":"domain-s425","description":"Host or cluster where the machines are deployed in. For Instant clone farms it can be only be a cluster id."},"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Image management stream used in the farm. This is required if parent_vm_id and base_snapshot_id are not set."},"im_tag_id":{"type":"string","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Image management tag used in the farm. This is required if im_stream_id is set."},"parent_vm_id":{"type":"string","example":"vm-2","description":"Current VM image for instant clone farm."},"resource_pool_id":{"type":"string","example":"resgroup-1","description":"Resource pool to deploy the RDS Servers."},"vm_folder_id":{"type":"string","example":"group-v1","description":"VM folder to deploy the RDS Servers to."}},"title":"FarmProvisioningSettingsCreateSpecV2","description":"Virtual center provisioning settings for the farm."},"FarmProvisioningSettingsInfo":{"type":"object","properties":{"base_snapshot_id":{"type":"string","example":"snapshot-1","description":"Current image snapshot for instant clone farm."},"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter within which the farm is configured"},"host_or_cluster_id":{"type":"string","example":"domain-s425","description":"Host or cluster where the machines are deployed in."},"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Image management stream used in the farm.
Supported Filters: 'Equals'."},"im_tag_id":{"type":"string","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Image management tag used in the farm.
Supported Filters: 'Equals'."},"parent_vm_id":{"type":"string","example":"vm-2","description":"Current VM image for instant clone farm."},"resource_pool_id":{"type":"string","example":"resgroup-1","description":"Resource pool to deploy the RDS Servers."},"vm_folder_id":{"type":"string","example":"group-v1","description":"VM folder to deploy the RDS Servers to."}},"title":"FarmProvisioningSettingsInfo","description":"Virtual center provisioning settings for the farm."},"FarmProvisioningSettingsInfoV2":{"type":"object","properties":{"base_snapshot_id":{"type":"string","example":"snapshot-1","description":"Current image snapshot for instant clone farm."},"compute_profile_num_cores_per_socket":{"type":"integer","format":"int32","example":1,"description":"Indicates the number of cores per socket for the CPU in the compute profile configured on clones."},"compute_profile_num_cpus":{"type":"integer","format":"int32","example":4,"description":"Indicates the number of CPUs in the compute profile configured on clones."},"compute_profile_ram_mb":{"type":"integer","format":"int32","example":4096,"description":"Indicates the RAM in MB in the compute profile configured on clones."},"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter within which the farm is configured"},"host_or_cluster_id":{"type":"string","example":"domain-s425","description":"Host or cluster where the machines are deployed in."},"im_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Image management stream used in the farm.
Supported Filters: 'Equals'."},"im_tag_id":{"type":"string","example":"3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Image management tag used in the farm.
Supported Filters: 'Equals'."},"parent_vm_id":{"type":"string","example":"vm-2","description":"Current VM image for instant clone farm."},"resource_pool_id":{"type":"string","example":"resgroup-1","description":"Resource pool to deploy the RDS Servers."},"vm_folder_id":{"type":"string","example":"group-v1","description":"VM folder to deploy the RDS Servers to."}},"title":"FarmProvisioningSettingsInfoV2","description":"Virtual center provisioning settings for the farm."},"FarmProvisioningSettingsUpdateSpec":{"type":"object","required":["host_or_cluster_id","resource_pool_id"],"properties":{"host_or_cluster_id":{"type":"string","example":"domain-s425","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)."},"resource_pool_id":{"type":"string","example":"resgroup-1","description":"Resource pool to deploy the RDS Servers."}},"title":"FarmProvisioningSettingsUpdateSpec","description":"Virtual center provisioning settings for the farm."},"FarmProvisioningStatusInfo":{"type":"object","properties":{"instant_clone_current_image_state":{"type":"string","example":"READY","description":"This represents the state of the current image of this instant clone farms.\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* 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* 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.","enum":["READY","FAILED","PENDING_UNPUBLISH","UNPUBLISHING"]},"instant_clone_operation":{"type":"string","example":"INITIAL_PUBLISH","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.","enum":["NONE","INITIAL_PUBLISH","RECURRING_SCHEDULED_MAINTENANCE","CANCEL_SCHEDULED_MAINTENANCE","INFRASTRUCTURE_CHANGE","FINAL_UNPUBLISH"]},"instant_clone_operation_time":{"type":"integer","format":"int64","example":1587081283000,"description":"Time of the operation that instant clone farm is undergoing."},"instant_clone_pending_im_stream_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","description":"Pending image management stream for instant clone farms.
Supported Filters: 'Equals'."},"instant_clone_pending_im_tag_id":{"type":"string","example":"e9896e51-48a2-4d82-ae9e-a0246981b484","description":"Pending image management tag for instant clone farms.
Supported Filters: 'Equals'."},"instant_clone_pending_image_error":{"type":"string","example":"Could not authenticate with domain administrator credentials","description":"This represents the error message if publishing of push image operation is failed."},"instant_clone_pending_image_parent_vm_id":{"type":"string","example":"vm-1","description":"Pending base image VM for instant clone farms. This is used to return the information about the parent VM of the pending Image."},"instant_clone_pending_image_progress":{"type":"integer","format":"int32","example":10,"description":"This represents the pending image publish progress in percentage for an instant clone farm."},"instant_clone_pending_image_snapshot_id":{"type":"string","example":"snapshot-1","description":"Pending base image snapshot for instant clone farms. This is used to return the information about the snapshot of the pending image."},"instant_clone_pending_image_state":{"type":"string","example":"FAILED","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.\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* 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.\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* FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.\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.","enum":["PENDING_PUBLISH","PUBLISHING","UNPUBLISHING","READY","FAILED","READY_HELD"]},"instant_clone_scheduled_maintenance_data":{"description":"Scheduled maintenance settings for automated instant clone farm.","$ref":"#/definitions/FarmScheduledMaintenanceInfo"},"last_provisioning_error":{"type":"string","example":"Initial publish failed: Could not authenticate with domain administrator credentials","description":"String message detailing the last provisioning error on this farm while stop_provisioning_on_error is enabled."},"last_provisioning_error_time":{"type":"integer","format":"int64","example":1587081283000,"description":"Time the last provisioning error occurred on this farm while stop_provisioning_on_error is enabled. Measured as epoch time."}},"title":"FarmProvisioningStatusInfo","description":"Provisioning status data about this automated farm."},"FarmProvisioningStatusInfoV2":{"type":"object","properties":{"instant_clone_current_image_state":{"type":"string","example":"READY","description":"This represents the state of the current image of this instant clone farms.\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* 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* 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.","enum":["READY","FAILED","PENDING_UNPUBLISH","UNPUBLISHING"]},"instant_clone_operation":{"type":"string","example":"INITIAL_PUBLISH","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.","enum":["NONE","INITIAL_PUBLISH","RECURRING_SCHEDULED_MAINTENANCE","CANCEL_SCHEDULED_MAINTENANCE","INFRASTRUCTURE_CHANGE","FINAL_UNPUBLISH"]},"instant_clone_operation_time":{"type":"integer","format":"int64","example":1587081283000,"description":"Time of the operation that instant clone farm is undergoing."},"instant_clone_pending_im_stream_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b473","description":"Pending image management stream for instant clone farms.
Supported Filters: 'Equals'."},"instant_clone_pending_im_tag_id":{"type":"string","example":"e9896e51-48a2-4d82-ae9e-a0246981b484","description":"Pending image management tag for instant clone farms.
Supported Filters: 'Equals'."},"instant_clone_pending_image_error":{"type":"string","example":"Could not authenticate with domain administrator credentials","description":"This represents the error message if publishing of push image operation is failed."},"instant_clone_pending_image_parent_vm_id":{"type":"string","example":"vm-1","description":"Pending base image VM for instant clone farms. This is used to return the information about the parent VM of the pending Image."},"instant_clone_pending_image_progress":{"type":"integer","format":"int32","example":10,"description":"This represents the pending image publish progress in percentage for an instant clone farm."},"instant_clone_pending_image_snapshot_id":{"type":"string","example":"snapshot-1","description":"Pending base image snapshot for instant clone farms. This is used to return the information about the snapshot of the pending image."},"instant_clone_pending_image_state":{"type":"string","example":"FAILED","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.\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* 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.\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* FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.\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.","enum":["PENDING_PUBLISH","PUBLISHING","UNPUBLISHING","READY","FAILED","READY_HELD"]},"instant_clone_scheduled_maintenance_data":{"description":"Scheduled maintenance settings for automated instant clone farm.","$ref":"#/definitions/FarmScheduledMaintenanceInfo"},"last_provisioning_error":{"type":"string","example":"Initial publish failed: Could not authenticate with domain administrator credentials","description":"String message detailing the last provisioning error on this farm while stop_provisioning_on_error is enabled."},"last_provisioning_error_time":{"type":"integer","format":"int64","example":1587081283000,"description":"Time the last provisioning error occurred on this farm while stop_provisioning_on_error is enabled. Measured as epoch time."},"pending_compute_profile_num_cores_per_socket":{"type":"integer","format":"int32","example":1,"description":"Indicates the pending number of cores per socket for the CPU in the compute profile configured on clones."},"pending_compute_profile_num_cpus":{"type":"integer","format":"int32","example":4,"description":"Indicates the pending number of CPUs in the compute profile configured on clones."},"pending_compute_profile_ram_mb":{"type":"integer","format":"int32","example":4096,"description":"Indicates the pending RAM in MB in the compute profile configured on clones."}},"title":"FarmProvisioningStatusInfoV2","description":"Provisioning status data about this automated farm."},"FarmRDSServersPatternNamingSettingsCreateSpec":{"type":"object","required":["naming_pattern"],"properties":{"max_number_of_rds_servers":{"type":"integer","format":"int32","example":5,"description":"Maximum number of RDS Servers in the farm. Default value is 1.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"naming_pattern":{"type":"string","example":"vm-{n}-sales","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).
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.
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."}},"title":"FarmRDSServersPatternNamingSettingsCreateSpec","description":"RDS server naming Pattern settings for the farm."},"FarmRDSServersPatternNamingSettingsInfo":{"type":"object","properties":{"max_number_of_rds_servers":{"type":"integer","format":"int32","example":5,"description":"Maximum number of RDS Servers in the farm."},"naming_pattern":{"type":"string","example":"vm-{n}-sales","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.
Supported Filters: 'Equals'."}},"title":"FarmRDSServersPatternNamingSettingsInfo","description":"RDS server naming Pattern settings for the farm."},"FarmRDSServersPatternNamingSettingsUpdateSpec":{"type":"object","required":["max_number_of_rds_servers","naming_pattern"],"properties":{"max_number_of_rds_servers":{"type":"integer","format":"int32","example":5,"description":"Maximum number of RDS Servers in the farm.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"naming_pattern":{"type":"string","example":"vm-{n}-sales","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).
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.
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."}},"title":"FarmRDSServersPatternNamingSettingsUpdateSpec","description":"RDS server naming Pattern settings for the farm."},"FarmRecurringMaintenanceSettingsInfo":{"type":"object","properties":{"maintenance_period":{"type":"string","example":"WEEKLY","description":"Settings for recurring maintenance operations.\n* DAILY: Daily recurring maintenance\n* WEEKLY: Weekly recurring maintenance\n* MONTHLY: Monthly recurring maintenance","enum":["DAILY","WEEKLY","MONTHLY"]},"maintenance_period_frequency":{"type":"integer","format":"int32","example":10,"description":"Indicates frequency of repeating maintenance and is expressed as a multiple of the maintenance_period. "},"start_index":{"type":"integer","format":"int32","example":1,"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."},"start_time":{"type":"string","example":"10:00","description":"Start time configured for the recurring maintenance. This is in the form hh:mm in 24 hours format"}},"title":"FarmRecurringMaintenanceSettingsInfo","description":"Settings for recurring maintenance operation for the farm."},"FarmRecurringMaintenanceSettingsSpec":{"type":"object","required":["maintenance_period","start_time"],"properties":{"maintenance_period":{"type":"string","example":"MONTHLY","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","enum":["DAILY","WEEKLY","MONTHLY"]},"maintenance_period_frequency":{"type":"integer","format":"int32","example":10,"description":"Indicates how frequently to repeat maintenance, expressed as multiple of the maintenance period. e.g. Every 2 weeks. Default value is 1.","minimum":1,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"start_index":{"type":"integer","format":"int32","example":2,"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","minimum":1,"maximum":31,"exclusiveMinimum":false,"exclusiveMaximum":false},"start_time":{"type":"string","example":"10:00","description":"Start time configured for the recurring maintenance. This should be in the form hh:mm in 24 hours format."}},"title":"FarmRecurringMaintenanceSettingsSpec","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","example":true,"description":"Indicates whether immediate maintenance is scheduled."},"logoff_policy":{"type":"string","example":"WAIT_FOR_LOGOFF","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.","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"next_scheduled_time":{"type":"integer","format":"int64","example":1237081283000,"description":"Time when next scheduled maintenance would happen."},"recurring_maintenance_settings":{"description":"Settings for recurring maintenance operation for the farm.","$ref":"#/definitions/FarmRecurringMaintenanceSettingsInfo"},"stop_on_first_error":{"type":"boolean","example":true,"description":"Indicates whether the operation should stop on first error."}},"title":"FarmScheduledMaintenanceInfo","description":"Scheduled maintenance settings for the automated farm."},"FarmSessionSettings":{"type":"object","properties":{"disconnected_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"description":"Disconnected sessions timeout (in minutes).Will be set when disconnected_session_timeout_policy is set to AFTER.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"disconnected_session_timeout_policy":{"type":"string","example":"NEVER","description":"Log-off policy after disconnected session. Default value is NEVER.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* NEVER: Do not logoff after user disconnect.","enum":["IMMEDIATELY","AFTER","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"empty_session_timeout_policy":{"type":"string","example":"AFTER","description":"Application empty session timeout policy. Default value is AFTER.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.\n* AFTER: Empty session will be disconnected after specified number of minutes.","enum":["IMMEDIATE","NEVER","AFTER"]},"logoff_after_timeout":{"type":"boolean","example":false,"description":"After timeout, empty application sessions are logged off when set to true. Otherwise sessions are disconnected.Default value is false."},"pre_launch_session_timeout_minutes":{"type":"integer","format":"int32","example":10,"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.","minimum":10,"exclusiveMinimum":false,"exclusiveMaximum":false},"pre_launch_session_timeout_policy":{"type":"string","example":"AFTER","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.","enum":["AFTER","NEVER"]}},"title":"FarmSessionSettings","description":"Session related settings for the Farm."},"FarmSessionSettingsCreateSpec":{"type":"object","properties":{"disconnected_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"disconnected_session_timeout_policy":{"type":"string","example":"NEVER","description":"Log-off policy after disconnected session. Default value is NEVER. \n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* NEVER: Do not logoff after user disconnect.","enum":["IMMEDIATELY","AFTER","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"empty_session_timeout_policy":{"type":"string","example":"AFTER","description":"Application empty session timeout policy. Default value is AFTER\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.\n* AFTER: Empty session will be disconnected after specified number of minutes.","enum":["IMMEDIATE","NEVER","AFTER"]},"logoff_after_timeout":{"type":"boolean","example":false,"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."},"pre_launch_session_timeout_minutes":{"type":"integer","format":"int32","example":10,"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.","minimum":10,"exclusiveMinimum":false,"exclusiveMaximum":false},"pre_launch_session_timeout_policy":{"type":"string","example":"AFTER","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.","enum":["AFTER","NEVER"]}},"title":"FarmSessionSettingsCreateSpec","description":"Session settings related to the Farm."},"FarmSessionSettingsCreateSpecV2":{"type":"object","properties":{"disconnected_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"disconnected_session_timeout_policy":{"type":"string","example":"NEVER","description":"Log-off policy after disconnected session. Default value is NEVER. \n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* NEVER: Do not logoff after user disconnect.","enum":["IMMEDIATELY","AFTER","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"empty_session_timeout_policy":{"type":"string","example":"AFTER","description":"Application empty session timeout policy. Default value is AFTER\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.\n* AFTER: Empty session will be disconnected after specified number of minutes.","enum":["IMMEDIATE","NEVER","AFTER"]},"logoff_after_timeout":{"type":"boolean","example":false,"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."},"pre_launch_session_timeout_minutes":{"type":"integer","format":"int32","example":10,"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.","minimum":10,"exclusiveMinimum":false,"exclusiveMaximum":false},"pre_launch_session_timeout_policy":{"type":"string","example":"AFTER","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.","enum":["AFTER","NEVER"]},"session_timeout_policy":{"type":"string","example":"DEFAULT","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.","enum":["DEFAULT","NEVER"]}},"title":"FarmSessionSettingsCreateSpecV2","description":"Session settings related to the Farm."},"FarmSessionSettingsInfo":{"type":"object","properties":{"disconnected_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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."},"disconnected_session_timeout_policy":{"type":"string","example":"NEVER","description":"Log-off policy after disconnected session.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* NEVER: Do not logoff after user disconnect.","enum":["IMMEDIATELY","AFTER","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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."},"empty_session_timeout_policy":{"type":"string","example":"AFTER","description":"Application empty session timeout policy.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.\n* AFTER: Empty session will be disconnected after specified number of minutes.","enum":["IMMEDIATE","NEVER","AFTER"]},"logoff_after_timeout":{"type":"boolean","example":false,"description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout."},"pre_launch_session_timeout_minutes":{"type":"integer","format":"int32","example":10,"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."},"pre_launch_session_timeout_policy":{"type":"string","example":"AFTER","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.","enum":["AFTER","NEVER"]}},"title":"FarmSessionSettingsInfo","description":"Session settings related to the Farm."},"FarmSessionSettingsInfoV2":{"type":"object","properties":{"disconnected_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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."},"disconnected_session_timeout_policy":{"type":"string","example":"NEVER","description":"Log-off policy after disconnected session.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* NEVER: Do not logoff after user disconnect.","enum":["IMMEDIATELY","AFTER","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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."},"empty_session_timeout_policy":{"type":"string","example":"AFTER","description":"Application empty session timeout policy.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.\n* AFTER: Empty session will be disconnected after specified number of minutes.","enum":["IMMEDIATE","NEVER","AFTER"]},"logoff_after_timeout":{"type":"boolean","example":false,"description":"Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout."},"pre_launch_session_timeout_minutes":{"type":"integer","format":"int32","example":10,"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."},"pre_launch_session_timeout_policy":{"type":"string","example":"AFTER","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.","enum":["AFTER","NEVER"]},"session_timeout_policy":{"type":"string","example":"DEFAULT","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.","enum":["DEFAULT","NEVER"]}},"title":"FarmSessionSettingsInfoV2","description":"Session settings related to the Farm."},"FarmSessionSettingsUpdateSpec":{"type":"object","required":["disconnected_session_timeout_policy","empty_session_timeout_policy"],"properties":{"disconnected_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"disconnected_session_timeout_policy":{"type":"string","example":"NEVER","description":"Log-off policy after disconnected session.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* NEVER: Do not logoff after user disconnect.","enum":["IMMEDIATELY","AFTER","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"empty_session_timeout_policy":{"type":"string","example":"AFTER","description":"Application empty session timeout policy.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.\n* AFTER: Empty session will be disconnected after specified number of minutes.","enum":["IMMEDIATE","NEVER","AFTER"]},"logoff_after_timeout":{"type":"boolean","example":false,"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 "},"pre_launch_session_timeout_minutes":{"type":"integer","format":"int32","example":10,"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.","minimum":10,"exclusiveMinimum":false,"exclusiveMaximum":false},"pre_launch_session_timeout_policy":{"type":"string","example":"AFTER","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.","enum":["AFTER","NEVER"]}},"title":"FarmSessionSettingsUpdateSpec","description":"Session settings related to the Farm."},"FarmSessionSettingsUpdateSpecV2":{"type":"object","required":["disconnected_session_timeout_policy","empty_session_timeout_policy","session_timeout_policy"],"properties":{"disconnected_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"disconnected_session_timeout_policy":{"type":"string","example":"NEVER","description":"Log-off policy after disconnected session.\n* IMMEDIATELY: Immediately Logoff after user disconnect.\n* AFTER: Logoff after the specified number of minutes after user disconnect.\n* NEVER: Do not logoff after user disconnect.","enum":["IMMEDIATELY","AFTER","NEVER"]},"empty_session_timeout_minutes":{"type":"integer","format":"int32","example":5,"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.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"empty_session_timeout_policy":{"type":"string","example":"AFTER","description":"Application empty session timeout policy.\n* IMMEDIATE: Empty session will be disconnected immediately.\n* NEVER: Empty session will never disconnected.\n* AFTER: Empty session will be disconnected after specified number of minutes.","enum":["IMMEDIATE","NEVER","AFTER"]},"logoff_after_timeout":{"type":"boolean","example":false,"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 "},"pre_launch_session_timeout_minutes":{"type":"integer","format":"int32","example":10,"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.","minimum":10,"exclusiveMinimum":false,"exclusiveMaximum":false},"pre_launch_session_timeout_policy":{"type":"string","example":"AFTER","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.","enum":["AFTER","NEVER"]},"session_timeout_policy":{"type":"string","example":"DEFAULT","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.","enum":["DEFAULT","NEVER"]}},"title":"FarmSessionSettingsUpdateSpecV2","description":"Session settings related to the Farm."},"FarmSettings":{"type":"object","properties":{"delete_in_progess":{"type":"boolean","example":false,"description":"Indicates whether the Farm is in the process of being deleted. Default value is false."},"desktop_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Desktop pool Id representing the RDS Desktop pool to which this Farm belongs."},"display_protocol_settings":{"description":"Display protocol settings for session related to the Farm.","$ref":"#/definitions/FarmDisplayProtocolSettings"},"load_balancer_settings":{"description":"Settings for load balancing the session requests across the RDS servers in the farm.","$ref":"#/definitions/FarmLoadBalancerSettings"},"server_error_threshold":{"type":"integer","format":"int32","example":5,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"session_settings":{"description":"Session related settings for the Farm.","$ref":"#/definitions/FarmSessionSettings"}},"title":"FarmSettings","description":"Settings related to the Farm."},"FarmStorageSettingsCreateSpec":{"type":"object","required":["datastores"],"properties":{"datastores":{"type":"array","description":"List of IDs of the datastore used to store the RDS Server.","items":{"$ref":"#/definitions/FarmDatastoreSettingsCreateSpec"}},"replica_disk_datastore_id":{"type":"string","example":"datastore-1","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."},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","example":false,"description":"Indicates whether to use separate datastores for replica and OS disks. Default value is false."},"use_view_storage_accelerator":{"type":"boolean","example":false,"description":"Indicates whether to use view storage accelerator. Default value is false."},"use_vsan":{"type":"boolean","example":false,"description":"Indicates whether to use vSphere VSAN. Default value is false."}},"title":"FarmStorageSettingsCreateSpec","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":"#/definitions/FarmDatastoreSettingsInfo"}},"replica_disk_datastore_id":{"type":"string","example":"datastore-1","description":"Datastore to store replica disks for instant clone machines. This is set when use_separate_datastores_replica_and_os_disks is true."},"use_separate_datastores_replica_and_os_disks":{"type":"boolean","example":false,"description":"Indicates whether to use separate datastores for replica and OS disks."},"use_view_storage_accelerator":{"type":"boolean","example":false,"description":"Indicates whether to use view storage accelerator."},"use_vsan":{"type":"boolean","example":false,"description":"Indicates whether to use vSphere VSAN."}},"title":"FarmStorageSettingsInfo","description":"Virtual center storage settings for the farm."},"FarmStorageSettingsUpdateSpec":{"type":"object","required":["datastores"],"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":"#/definitions/FarmDatastoreSettingsUpdateSpec"}},"replica_disk_datastore_id":{"type":"string","example":"datastore-1","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)."}},"title":"FarmStorageSettingsUpdateSpec","description":"Virtual center storage settings for the farm."},"FarmUpdateSpec":{"type":"object","required":["access_group_id","display_name","display_protocol_settings","enabled","server_error_threshold","session_settings","use_custom_script_for_load_balancing"],"properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration."},"automated_farm_settings":{"description":"Settings for Automated farm. This is required if type is set to AUTOMATED.","$ref":"#/definitions/FarmAutomatedSettingsUpdateSpec"},"description":{"type":"string","example":"Farm Description","description":"Description of the farm.","maxLength":1024},"display_name":{"type":"string","example":"ManualFarm","description":"Display name of the farm.","minLength":1,"maxLength":256},"display_protocol_settings":{"description":"Display protocol settings for the farm.","$ref":"#/definitions/FarmDisplayProtocolSettingsUpdateSpec"},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the farm is enabled for brokering."},"load_balancer_settings":{"description":"RDSH load balancer settings for the farm. This is required if use_custom_script_for_load_balancing is false.","$ref":"#/definitions/RDSHLoadBalancerSettingsUpdateSpec"},"server_error_threshold":{"type":"integer","format":"int32","example":0,"description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. "},"session_settings":{"description":"Session related settings for the Farm.","$ref":"#/definitions/FarmSessionSettingsUpdateSpec"},"use_custom_script_for_load_balancing":{"type":"boolean","example":false,"description":"Indicates whether to use custom scripts for load balancing or not. "}},"title":"FarmUpdateSpec","description":"Information required to update a farm."},"FarmUpdateSpecV2":{"type":"object","required":["access_group_id","display_name","display_protocol_settings","enabled","server_error_threshold","session_settings","use_custom_script_for_load_balancing"],"properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration."},"automated_farm_settings":{"description":"Settings for Automated farm. This is required when type is set to AUTOMATED.","$ref":"#/definitions/FarmAutomatedSettingsUpdateSpecV2"},"description":{"type":"string","example":"Farm Description","description":"Description of the farm.","maxLength":1024},"display_name":{"type":"string","example":"ManualFarm","description":"Display name of the farm.","minLength":1,"maxLength":256},"display_protocol_settings":{"description":"Display protocol settings for the farm.","$ref":"#/definitions/FarmDisplayProtocolSettingsUpdateSpec"},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the farm is enabled for brokering."},"load_balancer_settings":{"description":"RDSH load balancer settings for the farm. This is required if use_custom_script_for_load_balancing is false.","$ref":"#/definitions/RDSHLoadBalancerSettingsUpdateSpec"},"server_error_threshold":{"type":"integer","format":"int32","example":0,"description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. "},"session_settings":{"description":"Session related settings for the Farm.","$ref":"#/definitions/FarmSessionSettingsUpdateSpec"},"use_custom_script_for_load_balancing":{"type":"boolean","example":false,"description":"Indicates whether to use custom scripts for load balancing or not. "}},"title":"FarmUpdateSpecV2","description":"Information required to update a farm."},"FarmUpdateSpecV3":{"type":"object","required":["access_group_id","display_name","display_protocol_settings","enabled","load_balancer_settings","server_error_threshold","session_settings","use_custom_script_for_load_balancing"],"properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration."},"automated_farm_settings":{"description":"Settings for Automated farm. This is required when type is set to AUTOMATED.","$ref":"#/definitions/FarmAutomatedSettingsUpdateSpecV2"},"description":{"type":"string","example":"Farm Description","description":"Description of the farm.","maxLength":1024},"display_name":{"type":"string","example":"ManualFarm","description":"Display name of the farm.","minLength":1,"maxLength":256},"display_protocol_settings":{"description":"Display protocol settings for the farm.","$ref":"#/definitions/FarmDisplayProtocolSettingsUpdateSpec"},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the farm is enabled for brokering."},"load_balancer_settings":{"description":"RDSH load balancer settings for the farm.","$ref":"#/definitions/RDSHLoadBalancerSettingsUpdateSpecV2"},"server_error_threshold":{"type":"integer","format":"int32","example":0,"description":"The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. "},"session_settings":{"description":"Session related settings for the Farm.","$ref":"#/definitions/FarmSessionSettingsUpdateSpecV2"},"use_custom_script_for_load_balancing":{"type":"boolean","example":false,"description":"Indicates whether to use custom scripts for load balancing or not. "}},"title":"FarmUpdateSpecV3","description":"Information required to update a farm."},"FeatureSettings":{"type":"object","properties":{"cloud_managed":{"type":"boolean","example":true,"description":"Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines."},"enable_helpdesk":{"type":"boolean","example":true,"description":"Determines whether Helpdesk feature is enabled or not. By default Helpdesk is enabled."},"enable_image_management":{"type":"boolean","example":true,"description":"Determines whether Image Management feature is enabled or not. By default Image Management is disabled."}},"title":"FeatureSettings","description":"Information related to Feature Settings."},"FeatureSettingsUpdateSpec":{"type":"object","properties":{"cloud_managed":{"type":"boolean","example":true,"description":"Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines."}},"title":"FeatureSettingsUpdateSpec","description":"Information related to Feature Settings."},"FederationAccessGroupCreateSpec":{"type":"object","required":["name"],"properties":{"description":{"type":"string","example":"This access group can be used to delegate administration of sales team inventories to specific administrators.","description":"Federation Access Group Description.","maxLength":400},"name":{"type":"string","example":"Sales","description":"Federation Access Group Name. This property must contain only alphanumerics, underscores, and dashes.","minLength":1,"maxLength":32}},"title":"FederationAccessGroupCreateSpec","description":"Information related to Federation Access Group."},"FederationAccessGroupInfo":{"type":"object","properties":{"deletable":{"type":"boolean","example":true,"description":"Indicates whether this federation access group can be deleted."},"description":{"type":"string","example":"This Federation access group can be used to delegate administration of global sales team inventories to specific administrators.","description":"Federation Access group description."},"id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"Unique ID representing this Federation Access Group."},"name":{"type":"string","example":"Sales","description":"Federation Access group name."}},"title":"FederationAccessGroupInfo","description":"Information about Federation Access Group"},"FederationAccessGroupInfoV2":{"type":"object","properties":{"deletable":{"type":"boolean","example":true,"description":"Indicates whether this federation access group can be deleted."},"description":{"type":"string","example":"This Federation access group can be used to delegate administration of global sales team inventories to specific administrators.","description":"Federation Access group description."},"id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"Unique ID representing this Federation Access Group."},"name":{"type":"string","example":"Sales","description":"Federation Access group name."},"permission_ids":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","6fd4638a-381f-4518-aed6-042aa3d9f14c"],"description":"List of permission ids associated with federation access group.","items":{"type":"string"}}},"title":"FederationAccessGroupInfoV2","description":"Information about Federation Access Group"},"GSSAPIAuthenticatorCreateSpec":{"type":"object","required":["allow_legacy_clients","allow_ntlm_fallback","connection_server_ids","enable_login_as_current_user","enforce_channel_bindings","trigger_mode"],"properties":{"allow_legacy_clients":{"type":"boolean","example":true,"description":"Indicates whether the legacy Horizon clients will be allowed to use login as current user."},"allow_ntlm_fallback":{"type":"boolean","example":true,"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."},"connection_server_ids":{"type":"array","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9", "d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"description":"The list of Connection Servers for which this GSSAPI authenticator is enabled.","items":{"type":"string"}},"enable_login_as_current_user":{"type":"boolean","example":true,"description":"Indicates whether the login as current user is enabled or not."},"enforce_channel_bindings":{"type":"boolean","example":true,"description":"Indicates whether channel bindings is supported or not."},"trigger_mode":{"type":"string","example":"ENABLED","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.","enum":["DISABLED","OPTIONAL","ENABLED"]}},"title":"GSSAPIAuthenticatorCreateSpec","description":"Information required to create GSSAPI Authenticator."},"GSSAPIAuthenticatorInfo":{"type":"object","properties":{"allow_legacy_clients":{"type":"boolean","example":true,"description":"Indicates whether the legacy Horizon clients will be allowed to use login as current user."},"allow_ntlm_fallback":{"type":"boolean","example":true,"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."},"connection_servers":{"type":"array","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9", "d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"description":"The list of Connection Servers for which this GSSAPI authenticator is enabled.","items":{"type":"string"}},"enable_login_as_current_user":{"type":"boolean","example":true,"description":"Indicates whether the login as current user is enabled or not."},"enforce_channel_bindings":{"type":"boolean","example":true,"description":"Indicates whether channel bindings is supported or not."},"id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"Unique ID representing this GSSAPI Authenticator."},"trigger_mode":{"type":"string","example":"ENABLED","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.","enum":["DISABLED","OPTIONAL","ENABLED"]}},"title":"GSSAPIAuthenticatorInfo","description":"Information about to GSSAPI Authenticator."},"GSSAPIAuthenticatorUpdateSpec":{"type":"object","required":["allow_legacy_clients","allow_ntlm_fallback","enable_login_as_current_user","enforce_channel_bindings","trigger_mode"],"properties":{"allow_legacy_clients":{"type":"boolean","example":true,"description":"Indicates whether the legacy Horizon clients will be allowed to use login as current user."},"allow_ntlm_fallback":{"type":"boolean","example":true,"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."},"enable_login_as_current_user":{"type":"boolean","example":true,"description":"Indicates whether the login as current user is enabled or not."},"enforce_channel_bindings":{"type":"boolean","example":true,"description":"Indicates whether channel bindings is supported or not."},"trigger_mode":{"type":"string","example":"ENABLED","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.","enum":["DISABLED","OPTIONAL","ENABLED"]}},"title":"GSSAPIAuthenticatorUpdateSpec","description":"Information required to update GSSAPI Authenticator."},"GatewayInfo":{"type":"object","properties":{"address":{"type":"string","example":"uag1.example.com","description":"Gateway host name or IP address."},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID of the Gateway."},"internal":{"type":"boolean","example":false,"description":"Indicates whether the gateway is internal."},"name":{"type":"string","example":"uag1.example.com","description":"Gateway name."},"type":{"type":"string","example":"UAG","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.","enum":["UAG","F5","SG","SG_COHOSTED","UNKNOWN"]},"version":{"type":"string","example":"3.5.0","description":"Version of the Gateway."}},"title":"GatewayInfo","description":"Information about Gateway."},"GatewayMonitorDetails":{"type":"object","properties":{"address":{"type":"string","example":"uag1.example.com","description":"Gateway host name or IP address."},"internal":{"type":"boolean","example":false,"description":"Indicates if the Gateway is internal."},"type":{"type":"string","example":"UAG","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.","enum":["UAG","F5","SG","SG_COHOSTED","UNKNOWN"]},"version":{"type":"string","example":"3.5.0","description":"Version of the Gateway."}},"title":"GatewayMonitorDetails","description":"Details of the Gateway."},"GatewayMonitorInfo":{"type":"object","properties":{"active_connection_count":{"type":"integer","format":"int32","example":1234,"description":"Number of active connections for the gateway. Includes PCoIP and BLAST connection counts."},"blast_connection_count":{"type":"integer","format":"int32","example":10,"description":"Number of BLAST connections for the gateway."},"details":{"description":"Details of the gateway.","$ref":"#/definitions/GatewayMonitorDetails"},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID of the Gateway."},"name":{"type":"string","example":"uag1","description":"Gateway name."},"pcoip_connection_count":{"type":"integer","format":"int32","example":90,"description":"Number of PCoIP connections for the gateway."},"status":{"type":"string","example":"OK","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.","enum":["NOT_CONTACTED","PROBLEM","STALE","OK"]}},"title":"GatewayMonitorInfo","description":"Monitoring information related to Gateways registered in the environment."},"GatewayMonitorInfoV2":{"type":"object","properties":{"active_connection_count":{"type":"integer","format":"int32","example":1234,"description":"Number of active connections for the gateway. Includes PCoIP and BLAST connection counts."},"blast_connection_count":{"type":"integer","format":"int32","example":10,"description":"Number of BLAST connections for the gateway."},"details":{"description":"Details of the gateway.","$ref":"#/definitions/GatewayMonitorDetails"},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID of the Gateway."},"last_updated_timestamp":{"type":"integer","format":"int64","example":1582029025748,"description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time."},"name":{"type":"string","example":"uag1","description":"Gateway name."},"pcoip_connection_count":{"type":"integer","format":"int32","example":90,"description":"Number of PCoIP connections for the gateway."},"status":{"type":"string","example":"OK","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.","enum":["NOT_CONTACTED","PROBLEM","STALE","OK"]}},"title":"GatewayMonitorInfoV2","description":"Monitoring information related to Gateways registered in the environment."},"GatewayMonitorInfoV3":{"type":"object","properties":{"active_connection_count":{"type":"integer","format":"int32","example":1234,"description":"Number of active connections for the gateway. Includes PCoIP and BLAST connection counts."},"blast_connection_count":{"type":"integer","format":"int32","example":10,"description":"Number of BLAST connections for the gateway."},"details":{"description":"Details of the gateway.","$ref":"#/definitions/GatewayMonitorDetails"},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID of the Gateway."},"last_updated_timestamp":{"type":"integer","format":"int64","example":1582029025748,"description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time."},"name":{"type":"string","example":"uag1","description":"Gateway name."},"pcoip_connection_count":{"type":"integer","format":"int32","example":90,"description":"Number of PCoIP connections for the gateway."},"status":{"type":"string","example":"OK","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.","enum":["NOT_CONTACTED","PROBLEM","STALE","OK"]},"unrecognized_pcoip_requests_count":{"type":"integer","format":"int32","example":2,"description":"Number of unrecognized PCoIP Secure Gateway requests."},"unrecognized_tunnel_requests_count":{"type":"integer","format":"int32","example":5,"description":"Number of unrecognized Tunnel requests."},"unrecognized_xmlapi_requests_count":{"type":"integer","format":"int32","example":6,"description":"Number of unrecognized XML API requests."}},"title":"GatewayMonitorInfoV3","description":"Monitoring information related to Gateways registered in the environment."},"GeneralSettings":{"type":"object","properties":{"application_sso_timeout_minutes":{"type":"integer","format":"int32","example":30,"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."},"application_sso_timeout_policy":{"type":"string","example":"ENABLED","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.","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","example":false,"description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data."},"client_idle_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"description":"Determines how long a user can be idle before the Connection Server takes measure to protect the session."},"client_idle_session_timeout_policy":{"type":"string","example":"NEVER","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.","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"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."},"client_max_session_timeout_policy":{"type":"string","example":"TIMEOUT_AFTER","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.","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"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."},"console_session_timeout_minutes":{"type":"integer","format":"int32","example":30,"description":"Determines how long an idle admin console session continues before the session times out."},"display_pre_login_message":{"type":"boolean","example":false,"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."},"display_warning_before_forced_logoff":{"type":"boolean","example":true,"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."},"enable_automatic_status_updates":{"type":"boolean","example":true,"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."},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","example":false,"description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed."},"enable_multi_factor_re_authentication":{"type":"boolean","example":false,"description":"Enables 2 factor re-authentication after idle session timeout."},"enable_sending_domain_list":{"type":"boolean","example":false,"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."},"enable_server_in_single_user_mode":{"type":"boolean","example":true,"description":"Permits RDSServer operating systems to be used for non-RDS Machines."},"forced_logoff_message":{"type":"string","example":"The system will shut down shortly. Please save your work.","description":"The warning to be displayed before logging off the user."},"forced_logoff_timeout_minutes":{"type":"integer","format":"int32","example":3,"description":"The time to wait after the warning is displayed and before logging off the user."},"hide_domain_list_in_client":{"type":"boolean","example":true,"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."},"hide_server_information_in_client":{"type":"boolean","example":false,"description":"Indicates whether to hide the server URL in the Horizon client user interface."},"machine_sso_timeout_minutes":{"type":"integer","format":"int32","example":300,"description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server."},"machine_sso_timeout_policy":{"type":"string","example":"DISABLED_AFTER","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.","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_message":{"type":"string","example":"Disclaimer : This server is being monitored for suspicious activity.","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."},"restricted_client_data":{"type":"array","example":[{"type": "WINDOWS", "version": "7.5"}, {"type": "LINUX", "version": "6.5"}],"description":"List of restricted Horizon Clients.","items":{"$ref":"#/definitions/RestrictedClientData"}},"restricted_client_message":{"type":"string","example":"The system does not support this version of the Horizon client.","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server."},"store_cal_on_client":{"type":"boolean","example":false,"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."},"store_cal_on_connection_server":{"type":"boolean","example":false,"description":"Determines whether or not to store the RDS Per Device Client Access License on Connection Server."}},"title":"GeneralSettings","description":"Information related to General Settings."},"GeneralSettingsUpdateSpec":{"type":"object","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"],"properties":{"application_sso_timeout_minutes":{"type":"integer","format":"int32","example":30,"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."},"application_sso_timeout_policy":{"type":"string","example":"ENABLED","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.","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","example":false,"description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data."},"client_idle_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"description":"Determines how long a user can be idle before the broker takes measure to protect the session."},"client_idle_session_timeout_policy":{"type":"string","example":"NEVER","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.","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"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."},"client_max_session_timeout_policy":{"type":"string","example":"TIMEOUT_AFTER","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.","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"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."},"console_session_timeout_minutes":{"type":"integer","format":"int32","example":30,"description":"Determines how long an idle admin console session continues before the session times out."},"display_pre_login_message":{"type":"boolean","example":false,"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."},"display_warning_before_forced_logoff":{"type":"boolean","example":true,"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."},"enable_automatic_status_updates":{"type":"boolean","example":true,"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."},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","example":false,"description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed."},"enable_multi_factor_re_authentication":{"type":"boolean","example":false,"description":"Enables 2 factor re-authentication after idle session timeout."},"enable_sending_domain_list":{"type":"boolean","example":false,"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."},"enable_server_in_single_user_mode":{"type":"boolean","example":true,"description":"Permits RDSServer operating systems to be used for non-RDS Machines."},"forced_logoff_message":{"type":"string","example":"The system will shut down shortly. Please save your work.","description":"The warning to be displayed before logging off the user."},"forced_logoff_timeout_minutes":{"type":"integer","format":"int32","example":3,"description":"The time to wait after the warning is displayed and before logging off the user."},"hide_domain_list_in_client":{"type":"boolean","example":true,"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."},"hide_server_information_in_client":{"type":"boolean","example":false,"description":"Indicates whether to hide the server URL in the Horizon client user interface."},"machine_sso_timeout_minutes":{"type":"integer","format":"int32","example":300,"description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server."},"machine_sso_timeout_policy":{"type":"string","example":"DISABLED_AFTER","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.","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_message":{"type":"string","example":"Disclaimer : This server is being monitored for suspicious activity.","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."},"restricted_client_data":{"type":"array","example":[{"type": "WINDOWS", "version": "7.5"}, {"type": "LINUX", "version": "6.5"}],"description":"List of restricted Horizon Clients.","items":{"$ref":"#/definitions/RestrictedClientData"}},"restricted_client_message":{"type":"string","example":"The system does not support this version of the Horizon client.","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server."},"store_cal_on_client":{"type":"boolean","example":false,"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."},"store_cal_on_connection_server":{"type":"boolean","example":false,"description":"Determines whether or not to store the RDS Per Device Client Access License on Broker."}},"title":"GeneralSettingsUpdateSpec","description":"Information related to General Settings."},"GeneralSettingsUpdateSpecV2":{"type":"object","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"],"properties":{"application_sso_timeout_minutes":{"type":"integer","format":"int32","example":30,"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."},"application_sso_timeout_policy":{"type":"string","example":"ENABLED","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.","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","example":false,"description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data."},"client_idle_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"description":"Determines how long a user can be idle before the broker takes measure to protect the session."},"client_idle_session_timeout_policy":{"type":"string","example":"NEVER","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.","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"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."},"client_max_session_timeout_policy":{"type":"string","example":"TIMEOUT_AFTER","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.","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"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."},"console_session_timeout_minutes":{"type":"integer","format":"int32","example":30,"description":"Determines how long an idle admin console session continues before the session times out."},"display_pre_login_message":{"type":"boolean","example":false,"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."},"display_warning_before_forced_logoff":{"type":"boolean","example":true,"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."},"enable_automatic_status_updates":{"type":"boolean","example":true,"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."},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","example":false,"description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed."},"enable_multi_factor_re_authentication":{"type":"boolean","example":false,"description":"Enables 2 factor re-authentication after idle session timeout."},"enable_sending_domain_list":{"type":"boolean","example":false,"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."},"enable_server_in_single_user_mode":{"type":"boolean","example":true,"description":"Permits RDSServer operating systems to be used for non-RDS Machines."},"forced_logoff_message":{"type":"string","example":"The system will shut down shortly. Please save your work.","description":"The warning to be displayed before logging off the user."},"forced_logoff_timeout_minutes":{"type":"integer","format":"int32","example":3,"description":"The time to wait after the warning is displayed and before logging off the user."},"hide_domain_list_in_client":{"type":"boolean","example":true,"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."},"hide_server_information_in_client":{"type":"boolean","example":false,"description":"Indicates whether to hide the server URL in the Horizon client user interface."},"machine_sso_timeout_minutes":{"type":"integer","format":"int32","example":300,"description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server."},"machine_sso_timeout_policy":{"type":"string","example":"DISABLED_AFTER","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.","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_message":{"type":"string","example":"Disclaimer : This server is being monitored for suspicious activity.","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."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/definitions/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","example":"The system does not support this version of the Horizon client.","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server."},"restricted_client_warn_message":{"type":"string","example":"This client version is not recommended. Please upgrade to the latest version.","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server."},"store_cal_on_client":{"type":"boolean","example":false,"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."},"store_cal_on_connection_server":{"type":"boolean","example":false,"description":"Determines whether or not to store the RDS Per Device Client Access License on Broker."}},"title":"GeneralSettingsUpdateSpecV2","description":"Information related to General Settings."},"GeneralSettingsUpdateSpecV3":{"type":"object","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"],"properties":{"api_session_timeout_minutes":{"type":"integer","format":"int32","example":30,"description":"Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.
Setting the API session timeout to a high number of minutes increases the risk of unauthorized use of View API.
Use caution when you allow an idle session to persist for a long time.
Default value is 10.","minimum":10,"maximum":4320,"exclusiveMinimum":false,"exclusiveMaximum":false},"application_sso_timeout_minutes":{"type":"integer","format":"int32","example":30,"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."},"application_sso_timeout_policy":{"type":"string","example":"ENABLED","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.","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","example":false,"description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data."},"client_idle_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"description":"Determines how long a user can be idle before the broker takes measure to protect the session."},"client_idle_session_timeout_policy":{"type":"string","example":"NEVER","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.","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"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."},"client_max_session_timeout_policy":{"type":"string","example":"TIMEOUT_AFTER","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.","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"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."},"console_session_timeout_minutes":{"type":"integer","format":"int32","example":30,"description":"Determines how long an idle admin console session continues before the session times out."},"display_pre_login_admin_banner":{"type":"boolean","example":false,"description":"Enable/disable pre login message pop up before logging into Horizon admin console"},"display_pre_login_message":{"type":"boolean","example":false,"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."},"display_warning_before_forced_logoff":{"type":"boolean","example":true,"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."},"enable_automatic_status_updates":{"type":"boolean","example":true,"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."},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","example":false,"description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed."},"enable_multi_factor_re_authentication":{"type":"boolean","example":false,"description":"Enables 2 factor re-authentication after idle session timeout."},"enable_sending_domain_list":{"type":"boolean","example":false,"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."},"enable_server_in_single_user_mode":{"type":"boolean","example":true,"description":"Permits RDSServer operating systems to be used for non-RDS Machines."},"enable_user_name_caching":{"type":"boolean","example":true,"description":"UI Client provide 'remember me' option when this is set to true.
Default value is true."},"forced_logoff_message":{"type":"string","example":"The system will shut down shortly. Please save your work.","description":"The warning to be displayed before logging off the user."},"forced_logoff_timeout_minutes":{"type":"integer","format":"int32","example":3,"description":"The time to wait after the warning is displayed and before logging off the user."},"hide_domain_list_in_client":{"type":"boolean","example":true,"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."},"hide_server_information_in_client":{"type":"boolean","example":false,"description":"Indicates whether to hide the server URL in the Horizon client user interface."},"machine_sso_timeout_minutes":{"type":"integer","format":"int32","example":300,"description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server."},"machine_sso_timeout_policy":{"type":"string","example":"DISABLED_AFTER","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.","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_admin_banner_header":{"type":"string","example":"Attention","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."},"pre_login_admin_banner_message":{"type":"string","example":"On proceeding, you agree that you fully comply with the laws of this organisation.","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."},"pre_login_message":{"type":"string","example":"Disclaimer : This server is being monitored for suspicious activity.","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."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/definitions/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","example":"The system does not support this version of the Horizon client.","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server."},"restricted_client_warn_message":{"type":"string","example":"This client version is not recommended. Please upgrade to the latest version.","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server."},"store_cal_on_client":{"type":"boolean","example":false,"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."},"store_cal_on_connection_server":{"type":"boolean","example":false,"description":"Determines whether or not to store the RDS Per Device Client Access License on Broker."}},"title":"GeneralSettingsUpdateSpecV3","description":"Update specification for the configuration general settings."},"GeneralSettingsV2":{"type":"object","properties":{"application_sso_timeout_minutes":{"type":"integer","format":"int32","example":30,"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."},"application_sso_timeout_policy":{"type":"string","example":"ENABLED","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.","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","example":false,"description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data."},"client_idle_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"description":"Determines how long a user can be idle before the Connection Server takes measure to protect the session."},"client_idle_session_timeout_policy":{"type":"string","example":"NEVER","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.","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"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."},"client_max_session_timeout_policy":{"type":"string","example":"TIMEOUT_AFTER","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.","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"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."},"console_session_timeout_minutes":{"type":"integer","format":"int32","example":30,"description":"Determines how long an idle admin console session continues before the session times out."},"display_pre_login_message":{"type":"boolean","example":false,"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."},"display_warning_before_forced_logoff":{"type":"boolean","example":true,"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."},"enable_automatic_status_updates":{"type":"boolean","example":true,"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."},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","example":false,"description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed."},"enable_multi_factor_re_authentication":{"type":"boolean","example":false,"description":"Enables 2 factor re-authentication after idle session timeout."},"enable_sending_domain_list":{"type":"boolean","example":false,"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."},"enable_server_in_single_user_mode":{"type":"boolean","example":true,"description":"Permits RDSServer operating systems to be used for non-RDS Machines."},"forced_logoff_message":{"type":"string","example":"The system will shut down shortly. Please save your work.","description":"The warning to be displayed before logging off the user."},"forced_logoff_timeout_minutes":{"type":"integer","format":"int32","example":3,"description":"The time to wait after the warning is displayed and before logging off the user."},"hide_domain_list_in_client":{"type":"boolean","example":true,"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."},"hide_server_information_in_client":{"type":"boolean","example":false,"description":"Indicates whether to hide the server URL in the Horizon client user interface."},"machine_sso_timeout_minutes":{"type":"integer","format":"int32","example":300,"description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server."},"machine_sso_timeout_policy":{"type":"string","example":"DISABLED_AFTER","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.","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_message":{"type":"string","example":"Disclaimer : This server is being monitored for suspicious activity.","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."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/definitions/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","example":"The system does not support this version of the Horizon client.","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server."},"restricted_client_warn_message":{"type":"string","example":"This client version is not recommended. Please upgrade to the latest version.","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server."},"store_cal_on_client":{"type":"boolean","example":false,"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."},"store_cal_on_connection_server":{"type":"boolean","example":false,"description":"Determines whether or not to store the RDS Per Device Client Access License on Connection Server."}},"title":"GeneralSettingsV2","description":"Information related to General Settings."},"GeneralSettingsV3":{"type":"object","properties":{"api_session_timeout_minutes":{"type":"integer","format":"int32","example":30,"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."},"application_sso_timeout_minutes":{"type":"integer","format":"int32","example":30,"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."},"application_sso_timeout_policy":{"type":"string","example":"ENABLED","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.","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"block_restricted_clients":{"type":"boolean","example":false,"description":"Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data."},"client_idle_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"description":"Determines how long a user can be idle before the Connection Server takes measure to protect the session."},"client_idle_session_timeout_policy":{"type":"string","example":"NEVER","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.","enum":["TIMEOUT_AFTER","NEVER"]},"client_max_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"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."},"client_max_session_timeout_policy":{"type":"string","example":"TIMEOUT_AFTER","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.","enum":["TIMEOUT_AFTER","NEVER"]},"client_session_timeout_minutes":{"type":"integer","format":"int32","example":300,"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."},"console_session_timeout_minutes":{"type":"integer","format":"int32","example":30,"description":"Determines how long an idle admin console session continues before the session times out."},"display_pre_login_admin_banner":{"type":"boolean","example":false,"description":"Enable/disable pre login message pop up before logging into Horizon admin console"},"display_pre_login_message":{"type":"boolean","example":false,"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."},"display_warning_before_forced_logoff":{"type":"boolean","example":true,"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."},"enable_automatic_status_updates":{"type":"boolean","example":true,"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."},"enable_credential_cleanup_for_htmlaccess":{"type":"boolean","example":false,"description":"Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed."},"enable_multi_factor_re_authentication":{"type":"boolean","example":false,"description":"Enables 2 factor re-authentication after idle session timeout."},"enable_sending_domain_list":{"type":"boolean","example":false,"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."},"enable_server_in_single_user_mode":{"type":"boolean","example":true,"description":"Permits RDSServer operating systems to be used for non-RDS Machines."},"forced_logoff_message":{"type":"string","example":"The system will shut down shortly. Please save your work.","description":"The warning to be displayed before logging off the user."},"forced_logoff_timeout_minutes":{"type":"integer","format":"int32","example":3,"description":"The time to wait after the warning is displayed and before logging off the user."},"hide_domain_list_in_client":{"type":"boolean","example":true,"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."},"hide_server_information_in_client":{"type":"boolean","example":false,"description":"Indicates whether to hide the server URL in the Horizon client user interface."},"machine_sso_timeout_minutes":{"type":"integer","format":"int32","example":300,"description":"Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server."},"machine_sso_timeout_policy":{"type":"string","example":"DISABLED_AFTER","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.","enum":["DISABLED_AFTER","DISABLED","ENABLED"]},"pre_login_admin_banner_header":{"type":"string","example":"Attention","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."},"pre_login_admin_banner_message":{"type":"string","example":"On proceeding, you agree that you fully comply with the laws of this organisation.","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."},"pre_login_message":{"type":"string","example":"Disclaimer : This server is being monitored for suspicious activity.","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."},"restricted_client_data_v2":{"type":"array","description":"List of restricted Horizon Clients.","items":{"$ref":"#/definitions/RestrictedClientDataV2"}},"restricted_client_message":{"type":"string","example":"The system does not support this version of the Horizon client.","description":"The message to be displayed to Horizon clients which are blocked by the Connection Server."},"restricted_client_warn_message":{"type":"string","example":"This client version is not recommended. Please upgrade to the latest version.","description":"The message to be displayed to Horizon clients which are not recommended by the Connection Server."},"store_cal_on_client":{"type":"boolean","example":false,"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."},"store_cal_on_connection_server":{"type":"boolean","example":false,"description":"Determines whether or not to store the RDS Per Device Client Access License on Connection Server."}},"title":"GeneralSettingsV3","description":"Information related to General Settings."},"GlobalApplicationEntitlementCreateSpec":{"type":"object","required":["federated_access_group_id","name"],"properties":{"allow_users_to_choose_protocol":{"type":"boolean","example":true,"description":"Indicates whether the users can choose the protocol used. Default value is true."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"default_display_protocol":{"type":"string","example":"PCOIP","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* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["PCOIP","BLAST"]},"description":{"type":"string","example":"global application entitlement description","description":"Description of global application entitlement.","maxLength":1024},"display_name":{"type":"string","example":"global-application-entitlement","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.","maxLength":64},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools. Default value is false."},"enable_pre_launch":{"type":"boolean","example":false,"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."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the global application entitlement is enabled. Default value is true."},"federated_access_group_id":{"type":"string","example":"310927ee-1195-44c3-b877-5b194b4b4ea8","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."},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","example":true,"description":"Indicates whether automatic session clean up is enabled. Default value is false."},"name":{"type":"string","example":"global-application-entitlement","description":"Unique name used to identify the global application entitlement.","minLength":1,"maxLength":64},"require_home_site":{"type":"boolean","example":false,"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."},"scope":{"type":"string","example":"ALL_SITES","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Default value of \"ALL_SITES\".\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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"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.","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","example":false,"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."}},"title":"GlobalApplicationEntitlementCreateSpec","description":"Information required to create global application entitlement."},"GlobalApplicationEntitlementInfo":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","example":true,"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'."},"application_data":{"description":"Information about application added to Global Application Entitlement.","$ref":"#/definitions/ApplicationData"},"application_icon_ids":{"type":"array","example":["98923489-102b-4ed3-953f-3dfe3d23e0fe","asa39i-102b-4ed3-953f-3d23esan0fe"],"description":"Icons associated with the Global Application Entitlement","items":{"type":"string"}},"backup_gae_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"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'.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["PCOIP","BLAST"]},"description":{"type":"string","example":"global application entitlement description","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_name":{"type":"string","example":"global-application-entitlement","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'."},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'."},"enable_pre_launch":{"type":"boolean","example":true,"description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'."},"group_count":{"type":"integer","format":"int32","example":5,"description":"Count of groups that are associated with this Global Application Entitlement."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'."},"local_application_pools_count":{"type":"integer","format":"int32","example":2,"description":"Count of application pools local to this pod that are associated with this Global Application Entitlement."},"member_pods":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"description":"Pods that have application pools associated with this Global Application Entitlement.","items":{"type":"string"}},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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'.\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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","example":false,"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'."},"name":{"type":"string","example":"global-application-entitlement","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'."},"primary_gae_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup."},"remote_application_pools_count":{"type":"integer","format":"int32","example":10,"description":"Count of application pools on remote pods that are associated with this Global Application Entitlement."},"require_home_site":{"type":"boolean","example":false,"description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'."},"scope":{"type":"string","example":"ALL_SITES","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"shortcut_locations":{"type":"array","example":["desktop"],"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.","items":{"type":"string"}},"supported_display_protocols":{"type":"array","example":["PCOIP", "BLAST"],"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.","items":{"type":"string","enum":["PCOIP","BLAST"]}},"use_home_site":{"type":"boolean","example":false,"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'."},"user_count":{"type":"integer","format":"int32","example":5,"description":"Count of users that are associated with this Global Application Entitlement."},"user_or_group_site_override_count":{"type":"integer","format":"int32","example":2,"description":"Count of all User Home Site overrides associated with this Global Application Entitlement (for either users or groups)."}},"title":"GlobalApplicationEntitlementInfo","description":"Information about Global Application Entitlement"},"GlobalApplicationEntitlementInfoV2":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","example":true,"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'."},"application_data":{"description":"Information about application added to Global Application Entitlement.","$ref":"#/definitions/ApplicationData"},"application_icon_ids":{"type":"array","example":["98923489-102b-4ed3-953f-3dfe3d23e0fe","asa39i-102b-4ed3-953f-3d23esan0fe"],"description":"Icons associated with the Global Application Entitlement","items":{"type":"string"}},"backup_gae_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"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'.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["PCOIP","BLAST"]},"description":{"type":"string","example":"global application entitlement description","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_name":{"type":"string","example":"global-application-entitlement","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'."},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'."},"enable_pre_launch":{"type":"boolean","example":true,"description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'."},"federated_access_group_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"This represents id of the federated access group associated with the global application entitlement."},"group_count":{"type":"integer","format":"int32","example":5,"description":"Count of groups that are associated with this Global Application Entitlement."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'."},"local_application_pools_count":{"type":"integer","format":"int32","example":2,"description":"Count of application pools local to this pod that are associated with this Global Application Entitlement."},"member_pods":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"description":"Pods that have application pools associated with this Global Application Entitlement.","items":{"type":"string"}},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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'.\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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","example":false,"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'."},"name":{"type":"string","example":"global-application-entitlement","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'."},"primary_gae_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup."},"remote_application_pools_count":{"type":"integer","format":"int32","example":10,"description":"Count of application pools on remote pods that are associated with this Global Application Entitlement."},"require_home_site":{"type":"boolean","example":false,"description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'."},"scope":{"type":"string","example":"ALL_SITES","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","example":["PCOIP", "BLAST"],"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.","items":{"type":"string","enum":["PCOIP","BLAST"]}},"use_home_site":{"type":"boolean","example":false,"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'."},"user_count":{"type":"integer","format":"int32","example":5,"description":"Count of users that are associated with this Global Application Entitlement."},"user_or_group_site_override_count":{"type":"integer","format":"int32","example":2,"description":"Count of all User Home Site overrides associated with this Global Application Entitlement (for either users or groups)."}},"title":"GlobalApplicationEntitlementInfoV2","description":"Information about Global Application Entitlement."},"GlobalApplicationEntitlementSummary":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","example":true,"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'."},"backup_gae_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"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'.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["PCOIP","BLAST"]},"description":{"type":"string","example":"global application entitlement description","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_name":{"type":"string","example":"global-application-entitlement","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'."},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'."},"enable_pre_launch":{"type":"boolean","example":true,"description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'."},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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'.\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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","example":false,"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'."},"name":{"type":"string","example":"global-application-entitlement","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'."},"primary_gae_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup."},"require_home_site":{"type":"boolean","example":false,"description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'."},"scope":{"type":"string","example":"ALL_SITES","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"shortcut_locations":{"type":"array","example":["desktop"],"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.","items":{"type":"string"}},"supported_display_protocols":{"type":"array","example":["PCOIP", "BLAST"],"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.","items":{"type":"string","enum":["PCOIP","BLAST"]}},"use_home_site":{"type":"boolean","example":false,"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'."}},"title":"GlobalApplicationEntitlementSummary","description":"Summary Information about Global Application Entitlement.
Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"GlobalApplicationEntitlementSummaryV2":{"type":"object","properties":{"allow_users_to_choose_protocol":{"type":"boolean","example":true,"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'."},"backup_gae_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement.\nSupported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"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'.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["PCOIP","BLAST"]},"description":{"type":"string","example":"global application entitlement description","description":"Description of Global Application Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_name":{"type":"string","example":"global-application-entitlement","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'."},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'."},"enable_pre_launch":{"type":"boolean","example":true,"description":"Indicates whether Global Application Entitlement can be pre-launched\nSupported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates if this Global Application Entitlement is enabled.\nSupported Filters: 'Equals'."},"federated_access_group_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"This represents id of the federated access group associated with the global application entitlement.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing this Global Application Entitlement.\nSupported Filters: 'Equals'."},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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'.\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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","example":false,"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'."},"name":{"type":"string","example":"global-application-entitlement","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'."},"primary_gae_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup."},"require_home_site":{"type":"boolean","example":false,"description":"Indicates whether we fail if a home site isn't defined for this Global Application Entitlement.\nSupported Filters: 'Equals'."},"scope":{"type":"string","example":"ALL_SITES","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"description":"Locations of the category folder in the user's OS containing a shortcut to the application.\n","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","example":["PCOIP", "BLAST"],"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.","items":{"type":"string","enum":["PCOIP","BLAST"]}},"use_home_site":{"type":"boolean","example":false,"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'."}},"title":"GlobalApplicationEntitlementSummaryV2","description":"Summary Information about Global Application Entitlement.
Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"GlobalApplicationEntitlementUpdateSpec":{"type":"object","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"],"properties":{"backup_gae_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Global Application Entitlement that can be used as backup for this Global Application Entitlement."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"default_display_protocol":{"type":"string","example":"PCOIP","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* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["PCOIP","BLAST"]},"description":{"type":"string","example":"global application entitlement description","description":"Description of global application entitlement.","maxLength":1024},"display_name":{"type":"string","example":"global-application-entitlement","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.","maxLength":64},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools."},"enable_pre_launch":{"type":"boolean","example":false,"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\"."},"enabled":{"type":"boolean","example":true,"description":"Indicates whether the global application entitlement is enabled."},"federated_access_group_id":{"type":"string","example":"310927ee-1195-44c3-b877-5b194b4b4ea8","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."},"multi_session_mode":{"type":"string","example":"ENABLED_ENFORCED","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.","enum":["DISABLED","ENABLED_DEFAULT_OFF","ENABLED_DEFAULT_ON","ENABLED_ENFORCED"]},"multiple_session_auto_clean":{"type":"boolean","example":true,"description":"Indicates whether automatic session clean up is enabled."},"name":{"type":"string","example":"global-application-entitlement","description":"Unique name used to identify the global application entitlement.","minLength":1,"maxLength":64},"require_home_site":{"type":"boolean","example":false,"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."},"scope":{"type":"string","example":"ALL_SITES","description":"Scope for this global application entitlement. Visibility and Placement policies are defined by this value.\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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"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.","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","example":false,"description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used."}},"title":"GlobalApplicationEntitlementUpdateSpec","description":"Information required to update global application entitlement."},"GlobalDesktopEntitlementCreateSpec":{"type":"object","required":["name"],"properties":{"allow_multiple_sessions_per_user":{"type":"boolean","example":true,"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."},"allow_users_to_choose_protocol":{"type":"boolean","example":true,"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."},"allow_users_to_reset_machines":{"type":"boolean","example":true,"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."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this global desktop entitlement is managed from cloud. Default value is false."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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","items":{"type":"string"}},"dedicated":{"type":"boolean","example":true,"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."},"default_display_protocol":{"type":"string","example":"PCOIP","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* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"description":{"type":"string","example":"global desktop entitlement description","description":"Description of Global Desktop Entitlement.\n","maxLength":1024},"display_assigned_machine_name":{"type":"boolean","example":false,"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."},"display_machine_alias":{"type":"boolean","example":false,"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."},"display_name":{"type":"string","example":"global-desktop-entitlement","description":"Name that users will see when they connect using Horizon Client.\nIf display_name is left blank, it defaults to name.\n","maxLength":64},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Default value is false."},"enabled":{"type":"boolean","example":true,"description":"Indicates if this Global Desktop Entitlement is enabled.Default value is true."},"multiple_session_auto_clean":{"type":"boolean","example":false,"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."},"name":{"type":"string","example":"global-desktop-entitlement","description":"Unique name used to identify the Global Desktop Entitlement.\n","minLength":1,"maxLength":64},"require_home_site":{"type":"boolean","example":false,"description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Default value is false."},"scope":{"type":"string","example":"ALL_SITES","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* 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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"session_collaboration_enabled":{"type":"boolean","example":false,"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."},"shortcut_locations":{"type":"array","example":["desktop"],"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.","items":{"type":"string"}},"use_home_site":{"type":"boolean","example":false,"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."}},"title":"GlobalDesktopEntitlementCreateSpec","description":"Information required to create Global Desktop Entitlement."},"GlobalDesktopEntitlementCreateSpecV2":{"type":"object","required":["federated_access_group_id","name"],"properties":{"allow_multiple_sessions_per_user":{"type":"boolean","example":true,"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."},"allow_users_to_choose_protocol":{"type":"boolean","example":true,"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."},"allow_users_to_reset_machines":{"type":"boolean","example":true,"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."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this global desktop entitlement is managed from cloud. Default value is false."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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","items":{"type":"string"}},"dedicated":{"type":"boolean","example":true,"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."},"default_display_protocol":{"type":"string","example":"PCOIP","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* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"description":{"type":"string","example":"global desktop entitlement description","description":"Description of Global Desktop Entitlement.\n","maxLength":1024},"display_assigned_machine_name":{"type":"boolean","example":false,"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."},"display_machine_alias":{"type":"boolean","example":false,"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."},"display_name":{"type":"string","example":"global-desktop-entitlement","description":"Name that users will see when they connect using Horizon Client.\nIf display_name is left blank, it defaults to name.\n","maxLength":64},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Default value is false."},"enabled":{"type":"boolean","example":true,"description":"Indicates if this Global Desktop Entitlement is enabled.Default value is true."},"federated_access_group_id":{"type":"string","example":"310927ee-1195-44c3-b877-5b194b4b4ea8","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."},"multiple_session_auto_clean":{"type":"boolean","example":false,"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."},"name":{"type":"string","example":"global-desktop-entitlement","description":"Unique name used to identify the Global Desktop Entitlement.\n","minLength":1,"maxLength":64},"require_home_site":{"type":"boolean","example":false,"description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Default value is false."},"scope":{"type":"string","example":"ALL_SITES","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* 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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"session_collaboration_enabled":{"type":"boolean","example":false,"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."},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"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.","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","example":false,"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."}},"title":"GlobalDesktopEntitlementCreateSpecV2","description":"Information required to create Global Desktop Entitlement."},"GlobalDesktopEntitlementInfo":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","example":true,"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'."},"allow_users_to_choose_protocol":{"type":"boolean","example":true,"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'."},"allow_users_to_reset_machines":{"type":"boolean","example":true,"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'."},"backup_gde_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"dedicated":{"type":"boolean","example":true,"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'."},"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'.\n* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"description":{"type":"string","example":"global desktop entitlement description","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_assigned_machine_name":{"type":"boolean","example":false,"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'."},"display_machine_alias":{"type":"boolean","example":true,"description":"Decides the visibility of the machine alias to the user."},"display_name":{"type":"string","example":"global-desktop-entitlement","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'."},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'."},"group_count":{"type":"integer","format":"int32","example":5,"description":"Count of groups that are associated with this Global Desktop Entitlement."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'."},"local_desktop_pools_count":{"type":"integer","format":"int32","example":2,"description":"Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement."},"member_pods":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","items":{"type":"string"}},"multiple_session_auto_clean":{"type":"boolean","example":false,"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'."},"name":{"type":"string","example":"global-desktop-entitlement","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'."},"primary_gde_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup."},"remote_desktop_pools_count":{"type":"integer","format":"int32","example":10,"description":"Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement."},"require_home_site":{"type":"boolean","example":false,"description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'."},"scope":{"type":"string","example":"ALL_SITES","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"session_collaboration_enabled":{"type":"boolean","example":false,"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'."},"shortcut_locations":{"type":"array","example":["desktop"],"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.","items":{"type":"string"}},"supported_display_protocols":{"type":"array","example":["PCOIP", "BLAST", "RDP"],"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.","items":{"type":"string","enum":["RDP","PCOIP","BLAST"]}},"use_home_site":{"type":"boolean","example":false,"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'."},"user_count":{"type":"integer","format":"int32","example":5,"description":"Count of users that are associated with this Global Desktop Entitlement."},"user_or_group_site_override_count":{"type":"integer","format":"int32","example":2,"description":"Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups)."}},"title":"GlobalDesktopEntitlementInfo","description":"Information about Global Desktop Entitlement"},"GlobalDesktopEntitlementInfoV2":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","example":true,"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'."},"allow_users_to_choose_protocol":{"type":"boolean","example":true,"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'."},"allow_users_to_reset_machines":{"type":"boolean","example":true,"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'."},"backup_gde_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"dedicated":{"type":"boolean","example":true,"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'."},"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'.\n* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"description":{"type":"string","example":"global desktop entitlement description","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_assigned_machine_name":{"type":"boolean","example":false,"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'."},"display_machine_alias":{"type":"boolean","example":true,"description":"Decides the visibility of the machine alias to the user."},"display_name":{"type":"string","example":"global-desktop-entitlement","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'."},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'."},"federated_access_group_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"This represents id of the federated access group associated with the global desktop entitlement."},"group_count":{"type":"integer","format":"int32","example":5,"description":"Count of groups that are associated with this Global Desktop Entitlement."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'."},"local_desktop_pools_count":{"type":"integer","format":"int32","example":2,"description":"Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement."},"member_pods":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","9238c-102b-4ed3-953f-3d23esan0fe"],"description":"Pods that have desktop pools associated with this Global Desktop Entitlement.","items":{"type":"string"}},"multiple_session_auto_clean":{"type":"boolean","example":false,"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'."},"name":{"type":"string","example":"global-desktop-entitlement","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'."},"primary_gde_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup."},"remote_desktop_pools_count":{"type":"integer","format":"int32","example":10,"description":"Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement."},"require_home_site":{"type":"boolean","example":false,"description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'."},"scope":{"type":"string","example":"ALL_SITES","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"session_collaboration_enabled":{"type":"boolean","example":false,"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'."},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","example":["PCOIP", "BLAST", "RDP"],"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.","items":{"type":"string","enum":["RDP","PCOIP","BLAST"]}},"use_home_site":{"type":"boolean","example":false,"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'."},"user_count":{"type":"integer","format":"int32","example":5,"description":"Count of users that are associated with this Global Desktop Entitlement."},"user_or_group_site_override_count":{"type":"integer","format":"int32","example":2,"description":"Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups)."}},"title":"GlobalDesktopEntitlementInfoV2","description":"Information about Global Desktop Entitlement."},"GlobalDesktopEntitlementSummary":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","example":true,"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'."},"allow_users_to_choose_protocol":{"type":"boolean","example":true,"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'."},"allow_users_to_reset_machines":{"type":"boolean","example":true,"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'."},"backup_gde_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"dedicated":{"type":"boolean","example":true,"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'."},"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'.\n* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"description":{"type":"string","example":"global desktop entitlement description","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_assigned_machine_name":{"type":"boolean","example":false,"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'."},"display_machine_alias":{"type":"boolean","example":true,"description":"Decides the visibility of the machine alias to the user."},"display_name":{"type":"string","example":"global-desktop-entitlement","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'."},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'."},"multiple_session_auto_clean":{"type":"boolean","example":false,"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'."},"name":{"type":"string","example":"global-desktop-entitlement","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'."},"primary_gde_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup."},"require_home_site":{"type":"boolean","example":false,"description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'."},"scope":{"type":"string","example":"ALL_SITES","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"session_collaboration_enabled":{"type":"boolean","example":false,"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'."},"shortcut_locations":{"type":"array","example":["desktop"],"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.","items":{"type":"string"}},"supported_display_protocols":{"type":"array","example":["PCOIP", "BLAST", "RDP"],"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.","items":{"type":"string","enum":["RDP","PCOIP","BLAST"]}},"use_home_site":{"type":"boolean","example":false,"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'."}},"title":"GlobalDesktopEntitlementSummary","description":"Summary Information about Global Desktop Entitlement.
Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"GlobalDesktopEntitlementSummaryV2":{"type":"object","properties":{"allow_multiple_sessions_per_user":{"type":"boolean","example":true,"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'."},"allow_users_to_choose_protocol":{"type":"boolean","example":true,"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'."},"allow_users_to_reset_machines":{"type":"boolean","example":true,"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'."},"backup_gde_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.\nSupported Filters: 'Equals'."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this global desktop entitlement is managed from cloud.\nSupported Filters: 'Equals'."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"dedicated":{"type":"boolean","example":true,"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'."},"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'.\n* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"description":{"type":"string","example":"global desktop entitlement description","description":"Description of Global Desktop Entitlement.\nThis property has a maximum length of 1024 characters.\nSupported Filters: 'Equals', 'StartsWith' and 'Contains'."},"display_assigned_machine_name":{"type":"boolean","example":false,"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'."},"display_machine_alias":{"type":"boolean","example":true,"description":"Decides the visibility of the machine alias to the user."},"display_name":{"type":"string","example":"global-desktop-entitlement","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'."},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.\nSupported Filters: 'Equals'."},"enabled":{"type":"boolean","example":true,"description":"Indicates if this Global Desktop Entitlement is enabled.\nSupported Filters: 'Equals'."},"federated_access_group_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"This represents id of the federated access group associated with the global desktop entitlement.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing this Global Desktop Entitlement.\nSupported Filters: 'Equals'."},"multiple_session_auto_clean":{"type":"boolean","example":false,"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'."},"name":{"type":"string","example":"global-desktop-entitlement","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'."},"primary_gde_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup."},"require_home_site":{"type":"boolean","example":false,"description":"Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.\nSupported Filters: 'Equals'."},"scope":{"type":"string","example":"ALL_SITES","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\nSupported Filters: 'Equals'.\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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"session_collaboration_enabled":{"type":"boolean","example":false,"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'."},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"description":"Locations of the category folder in the user's OS containing a shortcut to the desktop.\n","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"supported_display_protocols":{"type":"array","example":["PCOIP", "BLAST", "RDP"],"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.","items":{"type":"string","enum":["RDP","PCOIP","BLAST"]}},"use_home_site":{"type":"boolean","example":false,"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'."}},"title":"GlobalDesktopEntitlementSummaryV2","description":"Summary Information about Global Desktop Entitlement.
Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"GlobalDesktopEntitlementUpdateSpec":{"type":"object","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"],"properties":{"allow_multiple_sessions_per_user":{"type":"boolean","example":true,"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."},"backup_gde_id":{"type":"string","example":"0104abcdc-102b-4ed3-953f-3dfe3d23e0fe","description":"Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement."},"category_folder_name":{"type":"string","example":"dir1\\dir2\\dir3\\dir4","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."},"cloud_managed":{"type":"boolean","example":false,"description":"Indicates whether this global desktop entitlement is managed from cloud."},"cs_restriction_tags":{"type":"array","example":["Internal", "External"],"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.","items":{"type":"string"}},"default_display_protocol":{"type":"string","example":"PCOIP","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* RDP: Microsoft Remote Desktop Protocol.\n* PCOIP: PCoIP protocol.\n* BLAST: BLAST protocol.","enum":["RDP","PCOIP","BLAST"]},"description":{"type":"string","example":"global desktop entitlement description","description":"Description of Global Desktop Entitlement.\n","maxLength":1024},"display_assigned_machine_name":{"type":"boolean","example":false,"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."},"display_machine_alias":{"type":"boolean","example":false,"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"},"display_name":{"type":"string","example":"global-desktop-entitlement","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","maxLength":64},"enable_client_restrictions":{"type":"boolean","example":false,"description":"Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools."},"enabled":{"type":"boolean","example":true,"description":"Indicates if this Global Desktop Entitlement is enabled."},"federated_access_group_id":{"type":"string","example":"310927ee-1195-44c3-b877-5b194b4b4ea8","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."},"multiple_session_auto_clean":{"type":"boolean","example":false,"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."},"name":{"type":"string","example":"global-desktop-entitlement","description":"Unique name used to identify the Global Desktop Entitlement.\n","minLength":1,"maxLength":64},"require_home_site":{"type":"boolean","example":false,"description":"Indicates whether it should fail if a home site isn't defined for this Global Desktop Entitlement."},"scope":{"type":"string","example":"ALL_SITES","description":"Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.\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.\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.","enum":["WITHIN_POD","WITHIN_SITE","ALL_SITES"]},"session_collaboration_enabled":{"type":"boolean","example":false,"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."},"shortcut_locations_v2":{"type":"array","example":["DESKTOP"],"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.","items":{"type":"string","enum":["START_MENU","DESKTOP"]}},"use_home_site":{"type":"boolean","example":false,"description":"Indicates whether a pod in the user's home site is used to start the search or the current site is used."}},"title":"GlobalDesktopEntitlementUpdateSpec","description":"Information required to update Global Desktop Entitlement."},"GlobalSessionActionSpec":{"type":"object","required":["ids","pod_id"],"properties":{"ids":{"type":"array","example":["816d44cb-b486-3c97-adcb-cf3806d53657", "414927f3-1a3b-3e4c-81b3-d39602f634dc"],"description":"IDs of the sessions on which action is to be performed.","items":{"type":"string"}},"pod_id":{"type":"string","example":"54c122e0-d6b5-476c-af91-fd00392e5983","description":"ID of the hosting pod for the sessions."}},"title":"GlobalSessionActionSpec","description":"Information required to perform an action on global sessions."},"GlobalSessionClientData":{"type":"object","properties":{"address":{"type":"string","example":"127.0.0.1","description":"IP Address of the client machine for the session."},"location_id":{"type":"string","example":"ac9be3c194f62043b274058102d3ce39048ec9c26d0e2c8b8ea475909d497f79","description":"Client location for the session."},"name":{"type":"string","example":"Client1","description":"Client machine name for the session."},"type":{"type":"string","example":"WINDOWS","description":"Client type for the session.\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.","enum":["WINDOWS","MAC","HTMLACCESS","LINUX","IOS","ANDROID","OTHER"]},"version":{"type":"string","example":"5.4.0","description":"Client version for the session."}},"title":"GlobalSessionClientData","description":"Client data for the session."},"GlobalSessionInfo":{"type":"object","properties":{"agent_version":{"type":"string","example":"8.3.0","description":"Version of the agent for the session."},"application_names":{"type":"array","example":["Calculator", "Paint"],"description":"Names of the applications launched in the session.
It will only be set when session_type is APPLICATION.","items":{"type":"string"}},"broker_user_id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-500","description":"SID for the broker user associated with the session. \nIt will be unset for non-broker sessions."},"brokered_remotely":{"type":"boolean","example":true,"description":"Indicates whether the session is brokered from a remote pod.
This will be set only if the Horizon View agent where the session resides is version 6.0 or later."},"brokering_pod_id":{"type":"string","example":"399eecf2-66ab-4a8f-94d9-b290fda35e4f","description":"ID of the pod that brokered the session."},"client_data":{"description":"Client data associated with the session.","$ref":"#/definitions/GlobalSessionClientData"},"desktop_pool_id":{"type":"string","example":"53c4de7c-ae7c-471d-a8d0-3489cb9741d7","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."},"desktop_pool_or_farm_name":{"type":"string","example":"Farm-Name","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."},"desktop_pool_or_farm_source":{"type":"string","example":"VIRTUAL_CENTER","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.\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* VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL 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.","enum":["INSTANT_CLONE","LINKED_CLONE","VIRTUAL_CENTER","RDS","UNMANAGED"]},"desktop_pool_or_farm_type":{"type":"string","example":"AUTOMATED","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.\n* AUTOMATED: Automated Desktop Pool.\n* MANUAL: Manual Desktop Pool.\n* RDS: RDS Desktop Pool.","enum":["AUTOMATED","MANUAL","RDS"]},"disconnected_time":{"type":"integer","format":"int64","example":1621512686000,"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."},"farm_id":{"type":"string","example":"250f68e8-9e7e-4578-b8fa-25864c63f168","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."},"federated_access_group_ids":{"type":"array","example":["310927ee-1195-44c3-b877-5b194b4b4ea8", "78669598-45b6-44a3-aa0d-11b16d45ab73"],"description":"IDs of the federated access groups associated with the session.
This represents the federated access groups associated with the global desktop entitlement or global application entitlements used to launch the session.","items":{"type":"string"}},"forever_session":{"type":"boolean","example":false,"description":"Indicates whether the application session will continue to run indefinitely on reaching global idle timeout or max session timeout."},"global_application_entitlement_ids":{"type":"array","example":["0d23a254-b873-4534-ad9a-ce8d25c5b40e", "89036a3a-5f6f-4dcd-bc78-e2febdc9dc8a"],"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.","items":{"type":"string"}},"global_desktop_entitlement_id":{"type":"string","example":"adcfdefc-c853-4413-8ac7-b299535a509d","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."},"id":{"type":"string","example":"ac6fc134-d197-3bbc-a6bf-24dc63123ae6","description":"Unique ID representing a session."},"idle_duration":{"type":"integer","format":"int64","example":30,"description":"Idle time duration in minutes, indicating how long the end user of the session has been idle for."},"last_session_duration_ms":{"type":"integer","format":"int64","example":120290,"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."},"local_access_group_id":{"type":"string","example":"95061b82-92fa-4285-b90d-a5e1d8e38c3d","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."},"machine_id":{"type":"string","example":"3205f64e-1d3d-43c0-942b-0bb6707c481d","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."},"machine_or_rds_server_dns_name":{"type":"string","example":"machine1.example.com","description":"DNS name of the machine or RDS server for the session."},"pod_id":{"type":"string","example":"b7ade226-ca2a-4805-b7be-c4bc8cec5188","description":"ID of the pod that provided the resource for the session."},"rds_server_id":{"type":"string","example":"a6cddaeb-4477-468d-90ea-593c716790b8","description":"ID of the RDS server for the RDS desktop or application session.
This will be unset if the session is hosted by remote pod."},"resourced_remotely":{"type":"boolean","example":false,"description":"Indicates whether the session is running on a remote pod resource."},"security_gateway_data":{"description":"Security gateway data associated with the session.","$ref":"#/definitions/GlobalSessionSecurityGatewayData"},"session_protocol":{"type":"string","example":"BLAST","description":"Protocol for session. This will be unset for disconnected sessions.\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* UNKNOWN: Display protocol is unknown.","enum":["PCOIP","RDP","BLAST","CONSOLE","UNKNOWN"]},"session_state":{"type":"string","example":"CONNECTED","description":"State of session.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","example":"DESKTOP","description":"Type of session.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","enum":["DESKTOP","APPLICATION"]},"site_id":{"type":"string","example":"037e6be2-9aa3-4676-93d3-25a519efedf4","description":"ID of the site where the pod that resourced the session belongs."},"start_time":{"type":"integer","format":"int64","example":1621512606000,"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."},"unauthenticated":{"type":"boolean","example":false,"description":"Indicates whether the session belongs to unauthenticated access user."},"user_id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-500","description":" SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios."}},"title":"GlobalSessionInfo","description":"Information related to Global Session."},"GlobalSessionSecurityGatewayData":{"type":"object","properties":{"address":{"type":"string","example":"127.0.0.1","description":"IP Address of the security gateway for the session."},"domain_name":{"type":"string","example":"SECURE-GW.example.com","description":"Computer machine name or DNS name of the security gateway for the session."},"location":{"type":"string","example":"EXTERNAL","description":"IP Address of the security gateway for the session.\n* EXTERNAL: Gateway location is external.\n* INTERNAL: Gateway location is internal.\n* UNKNOWN: Gateway location is unknown.","enum":["EXTERNAL","INTERNAL","UNKNOWN"]}},"title":"GlobalSessionSecurityGatewayData","description":"Security gateway data for the session."},"GlobalSessionSendMessageSpec":{"type":"object","required":["global_session_action_specs","message","message_type"],"properties":{"global_session_action_specs":{"type":"array","description":"Sessions to which message is to be sent.","items":{"$ref":"#/definitions/GlobalSessionActionSpec"}},"message":{"type":"string","example":"Sample Info Message","description":"Message to be sent to sessions."},"message_type":{"type":"string","example":"INFO","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.","enum":["ERROR","WARNING","INFO"]}},"title":"GlobalSessionSendMessageSpec","description":"Information required to send message to global sessions."},"HeldUserOrGroupInfo":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-513","description":"Unique SID representing held user or group."}},"title":"HeldUserOrGroupInfo","description":"Information related to Held User or Group."},"HeldUserOrGroupResponseInfo":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-513","description":"Unique SID representing held user or group."},"errors":{"type":"array","description":"List of error objects containing error key and error message.","items":{"$ref":"#/definitions/APIError"}},"machines_data":{"type":"array","description":"List of objects containing information related to held Virtual Machines.","items":{"$ref":"#/definitions/HeldVMInfo"}},"status_code":{"type":"integer","format":"int32","example":200,"description":"Response HTTP status code of the operation."},"timestamp":{"type":"integer","format":"int64","example":1561939200000,"description":"Timestamp in milliseconds when the operation failed. Measured as epoch time."}},"title":"HeldUserOrGroupResponseInfo","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","example":"vm-416","description":"Unique virtual center moid representing the virtual machine."},"machine_state":{"type":"string","example":"Connected","description":"Machine state\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\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.\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* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* ERROR: An unknown error occurred in the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\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* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\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_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_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* 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* IN_PROGRESS: There is a machine operation in progress.\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* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* UNKNOWN: Could not determine the state of the machine.","enum":["PROVISIONING","PROVISIONING_ERROR","WAITING_FOR_AGENT","CUSTOMIZING","DELETING","MAINTENANCE","ERROR","PROVISIONED","AGENT_UNREACHABLE","UNASSIGNED_USER_CONNECTED","CONNECTED","UNASSIGNED_USER_DISCONNECTED","DISCONNECTED","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","ALREADY_USED","AVAILABLE","IN_PROGRESS","DISABLED","DISABLE_IN_PROGRESS","VALIDATING","UNKNOWN"]},"name":{"type":"string","example":"Win10","description":"VM name."}},"title":"HeldVMInfo","description":"Information related to a held Virtual Machine."},"HomeSiteCreateSpec":{"type":"object","required":["ad_user_or_group_id","site_id"],"properties":{"ad_user_or_group_id":{"type":"string","example":"S-1-5-32-551","description":"SID of the user or group for whom the home site is to be configured."},"global_application_entitlement_id":{"type":"string","example":"e285ebe1-194b-4563-80e0-0ad21134c503","description":"ID of the Global Application Entitlement for which this site is the overriding home site."},"global_desktop_entitlement_id":{"type":"string","example":"7493bfc7-834a-4d9b-ac7d-b5f60893a3a6","description":"ID of the Global Desktop Entitlement for which this site is the overriding home site."},"site_id":{"type":"string","example":"32a5ea06-cd09-4609-b3e5-df8379e99c13","description":"ID of the site for this home site configuration."}},"title":"HomeSiteCreateSpec","description":"Information required to create a Home Site in the pod federation.
If both Global Desktop Entitlement ID and Global Application Entitlement ID are unset, then this site is the global home site.
"},"HomeSiteInfo":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","example":"S-1-5-32-551","description":"SID of the user or group for whom this is the home site.
Supported Filters: 'Equals'."},"global_application_entitlement_id":{"type":"string","example":"e285ebe1-194b-4563-80e0-0ad21134c503","description":"ID of the Global Application Entitlement for which this site is the overriding home site.
Supported Filters: 'Equals'."},"global_desktop_entitlement_id":{"type":"string","example":"7493bfc7-834a-4d9b-ac7d-b5f60893a3a6","description":"ID of the Global Desktop Entitlement for which this site is the overriding home site.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"28deeb70-97d5-409e-abb4-497196f1ee18","description":"Unique ID representing this home site assignment.
Supported Filters: 'Equals'."},"site_id":{"type":"string","example":"32a5ea06-cd09-4609-b3e5-df8379e99c13","description":"ID representing this home site.
Supported Filters: 'Equals'."}},"title":"HomeSiteInfo","description":"Information related to home sites in a pod federation.
If both global Desktop Entitlement ID and global Application Entitlement ID are unset, then this site is the global home site.
Supported Filters : 'And', 'Or' and 'Equals'.
See the field description to know the filter types it supports."},"HomeSiteResolutionData":{"type":"object","properties":{"group_id":{"type":"string","example":"S-1-5-32-568","description":"SID of the group through which the user gets this home site."},"id":{"type":"string","example":"28deeb70-97d5-409e-abb4-497196f1ee18","description":"ID of the Home Site Configuration."},"resolved":{"type":"boolean","example":true,"description":"Indicates whether this is the resolved home site."},"site_id":{"type":"string","example":"52457bcd-9641-48b1-a1ac-a8c58069ef48","description":"ID of the Site configured as Home Site."},"type":{"type":"string","example":"USER_DEFAULT","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.","enum":["USER_OVERRIDE","GROUP_OVERRIDE","USER_DEFAULT","GROUP_DEFAULT"]}},"title":"HomeSiteResolutionData","description":"Information representing data for a home site resolution."},"HomeSiteResolutionInfo":{"type":"object","properties":{"global_application_entitlement_id":{"type":"string","example":"f309c150-ff8b-4391-ad5d-96e1a3c3cb70","description":"ID of the Global Application Entitlement this home site resolution is for."},"global_desktop_entitlement_id":{"type":"string","example":"dc2c29ce-baae-47b5-90e6-d7ab1d3b82288","description":"ID of the Global Desktop Entitlement this home site resolution is for."},"resolution_data":{"type":"array","description":"Home Site Resolution Data for this Global Entitlement.","items":{"$ref":"#/definitions/HomeSiteResolutionData"}}},"title":"HomeSiteResolutionInfo","description":"Information related to home site resolution for a user and a global entitlement.
Only one of Global Desktop Entitlement ID and Global Application Entitlement ID will be set.
Resolution Data will only be available if home site configuration exists for the global entitlement."},"HomeSiteResolutionSpec":{"type":"object","required":["user_id"],"properties":{"global_application_entitlement_id":{"type":"string","example":"751c7619-bc3b-48cd-80d1-29960375b6d8","description":"ID of the Global Application Entitlement this home site resolution is for."},"global_desktop_entitlement_id":{"type":"string","example":"9e94a90d-e7c2-40b6-a702-bd781512408d","description":"ID of the Global Desktop Entitlement this home site resolution is for."},"user_id":{"type":"string","example":"S-1-5-21-3623811015-3361044348","description":"SID of the user for whom home site is to be resolved."}},"title":"HomeSiteResolutionSpec","description":"Information required for home site resolution.
Only one of Global Desktop Entitlement ID and Global Application Entitlement ID may be set."},"HostOrClusterContainer":{"type":"object","properties":{"children":{"type":"array","description":"Contents of the container. These may be hosts or clusters or further nested containers.","items":{"$ref":"#/definitions/HostOrClusterInfo"}},"name":{"type":"string","example":"ServicesFolder","description":"Host or cluster container node display name."},"path":{"type":"string","example":"/Datacenter/host/ServicesFolder","description":"Host or cluster container node path."},"type":{"type":"string","example":"FOLDER","description":"Type of container.\n* FOLDER: A folder container.\n* OTHER: Other container type.","enum":["FOLDER","OTHER"]}},"title":"HostOrClusterContainer","description":"Details of the host or cluster container node."},"HostOrClusterDetails":{"type":"object","properties":{"cluster":{"type":"boolean","example":true,"description":"Whether or not this is a cluster or a host."},"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter id for this host or cluster."},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this Host Or Cluster from being used in desktop pool creation.","items":{"type":"string","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","example":"Cluster","description":"Host or cluster display name."},"path":{"type":"string","example":"/Datacenter/host/ServicesFolder/Cluster","description":"Host or cluster path."},"vcenter_id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Virtual Center id for this host or cluster."},"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"}}},"title":"HostOrClusterDetails","description":"Details of the host or cluster."},"HostOrClusterInfo":{"type":"object","properties":{"container":{"description":"Set only if this node represents a container.","$ref":"#/definitions/HostOrClusterContainer"},"details":{"description":"Set only if this node represents a host or cluster.","$ref":"#/definitions/HostOrClusterDetails"},"id":{"type":"string","example":"domain-s425","description":"Unique ID representing a host or cluster."}},"title":"HostOrClusterInfo","description":"Information related to host or cluster."},"HostOverrideData":{"type":"object","properties":{"cache_size_mb":{"type":"integer","format":"int32","example":2048,"description":"Size of the cache in megabytes. This property has a minimum value of 100. This property has a maximum value of 2048."},"path":{"type":"string","example":"/path/host","description":"The path of the host that supports View Storage Accelerator."}},"title":"HostOverrideData","description":"Details of the Hypervisor hosts involved in Content Based Read Caching (CBRC)"},"ImageManagementAssetCreateSpec":{"type":"object","required":["clone_type","im_stream_id","im_version_id","image_type","status","vcenter_id"],"properties":{"additional_details":{"type":"object","description":"Additional details about image management asset.","additionalProperties":{"type":"string"}},"base_snapshot_id":{"type":"string","example":"snapshot-1","description":"Virtual machine snapshot. Must be set if vm_template_id is unset."},"base_vm_id":{"type":"string","example":"vm-2","description":"Virtual machine ID. Must be set if vm_template_id is unset."},"clone_type":{"type":"string","example":"INSTANT_CLONE","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.","enum":["FULL_CLONE","INSTANT_CLONE"]},"im_stream_id":{"type":"string","example":"abc16e8f-9ba0-4789-a5dd-6880f32c52df","description":"Image management stream to which this asset belongs to."},"im_version_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Image management version to which this asset belongs to."},"image_type":{"type":"string","example":"RDSH_APPS","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.","enum":["RDSH_APPS","RDSH_DESKTOP","VDI_DESKTOP"]},"status":{"type":"string","example":"AVAILABLE","description":"Image management asset status.\n* AVAILABLE: Image management asset is available for desktop pools/farms to be created.\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* DELETED: Image management asset has been deleted.\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.","enum":["AVAILABLE","DEPLOYING_VM","DEPLOYMENT_DONE","DELETED","DISABLED","FAILED","REPLICATING","RETRY_PENDING","SPECIALIZING_VM"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"Virtual Center where this asset is created."},"vm_template_id":{"type":"string","example":"vm-1","description":"Virtual machine template ID."}},"title":"ImageManagementAssetCreateSpec","description":"Information related to image management asset."},"ImageManagementAssetInfo":{"type":"object","properties":{"additional_details":{"type":"object","description":"Additional details about image management asset.","additionalProperties":{"type":"string"}},"base_snapshot_id":{"type":"string","example":"snapshot-1","description":"Virtual machine snapshot. Must be set if vm_template_id is unset."},"base_vm_id":{"type":"string","example":"vm-2","description":"Virtual machine ID. Must be set if vm_template_id is unset."},"clone_type":{"type":"string","example":"INSTANT_CLONE","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.","enum":["FULL_CLONE","INSTANT_CLONE"]},"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter where this asset is created."},"id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d","description":"Unique ID representing image management asset."},"im_stream_id":{"type":"string","example":"abc16e8f-9ba0-4789-a5dd-6880f32c52df","description":"Image management stream to which this asset belongs to."},"im_version_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Image management version to which this asset belongs to."},"image_type":{"type":"string","example":"RDSH_APPs","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.","enum":["RDSH_APPS","RDSH_DESKTOP","VDI_DESKTOP"]},"status":{"type":"string","example":"AVAILABLE","description":"Image management asset status.\n* AVAILABLE: Image management asset is available for desktop pools/farms to be created.\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* DELETED: Image management asset has been deleted.\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.","enum":["AVAILABLE","DEPLOYING_VM","DEPLOYMENT_DONE","DELETED","DISABLED","FAILED","REPLICATING","RETRY_PENDING","SPECIALIZING_VM"]},"vcenter_id":{"type":"string","example":"f148f3e8-db0e-4abb-9c33-7e5205ccd360","description":"Virtual Center where this asset is created."},"vm_template_id":{"type":"string","example":"vm-1","description":"Virtual machine template ID."}},"title":"ImageManagementAssetInfo","description":"Information related to image management asset."},"ImageManagementAssetUpdateSpec":{"type":"object","required":["clone_type","image_type","status"],"properties":{"additional_details":{"type":"object","description":"Additional details about image management asset.","additionalProperties":{"type":"string"}},"clone_type":{"type":"string","example":"INSTANT_CLONE","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.","enum":["FULL_CLONE","INSTANT_CLONE"]},"image_type":{"type":"string","example":"RDSH_APPS","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.","enum":["RDSH_APPS","RDSH_DESKTOP","VDI_DESKTOP"]},"status":{"type":"string","example":"AVAILABLE","description":"Image management asset status.\n* AVAILABLE: Image management asset is available for desktop pools/farms to be created.\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* DELETED: Image management asset has been deleted.\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.","enum":["AVAILABLE","DEPLOYING_VM","DEPLOYMENT_DONE","DELETED","DISABLED","FAILED","REPLICATING","RETRY_PENDING","SPECIALIZING_VM"]}},"title":"ImageManagementAssetUpdateSpec","description":"Information related to image management asset."},"ImageManagementStreamCreateSpec":{"type":"object","required":["name","operating_system","source","status"],"properties":{"additional_details":{"type":"object","description":"Additional details about image management stream.","additionalProperties":{"type":"string"}},"description":{"type":"string","example":"Windows 10 Stream","description":"Image management stream description."},"name":{"type":"string","example":"Win10","description":"Image management stream name."},"operating_system":{"type":"string","example":"WINDOWS_10","description":"Operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"publisher":{"type":"string","example":"VMware","description":"Image management stream publisher"},"source":{"type":"string","example":"MARKET_PLACE","description":"Image management stream source.\n* MARKET_PLACE: Image management stream is from market place.\n* UPLOADED: Image management stream is uploaded.\n* COPIED_FROM_STREAM: Image management stream is copied from another stream.\n* COPIED_FROM_VERSION: Image management stream is copied from a version.","enum":["MARKET_PLACE","UPLOADED","COPIED_FROM_STREAM","COPIED_FROM_VERSION"]},"status":{"type":"string","example":"AVAILABLE","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.","enum":["AVAILABLE","DELETED","DISABLED","FAILED","IN_PROGRESS","PARTIALLY_AVAILABLE","PENDING"]}},"title":"ImageManagementStreamCreateSpec","description":"Information related to image management stream."},"ImageManagementStreamInfo":{"type":"object","properties":{"additional_details":{"type":"object","example":true,"description":"Additional details about image management stream.","additionalProperties":{"type":"string"}},"description":{"type":"string","example":"Windows 10 Stream","description":"Image management stream description."},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing image management stream."},"name":{"type":"string","example":"Win10","description":"Image management stream name."},"operating_system":{"type":"string","example":"WINDOWS_10","description":"Operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"publisher":{"type":"string","example":"VMware","description":"Image management stream publisher"},"source":{"type":"string","example":"MARKET_PLACE","description":"Image management stream source.\n* MARKET_PLACE: Image management stream is from market place.\n* UPLOADED: Image management stream is uploaded.\n* COPIED_FROM_STREAM: Image management stream is copied from another stream.\n* COPIED_FROM_VERSION: Image management stream is copied from a version.","enum":["MARKET_PLACE","UPLOADED","COPIED_FROM_STREAM","COPIED_FROM_VERSION"]},"status":{"type":"string","example":"AVAILABLE","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.","enum":["AVAILABLE","DELETED","DISABLED","FAILED","IN_PROGRESS","PARTIALLY_AVAILABLE","PENDING"]},"usable":{"type":"boolean","example":true,"description":"Specifies whether the image management stream can be used in desktop pool or farm. This will be set to true when: - Image management stream is in AVAILABLE or PARTIALLY_AVAILABLE state.
- There is at least one image management version in AVAILABLE or PARTIALLY_AVAILABLE state for this stream.
- There is at least one image management tag associated with the image management version.
For a specific virtual center, image management tag information will be retrieved."}},"title":"ImageManagementStreamInfo","description":"Information related to image management stream."},"ImageManagementStreamUpdateSpec":{"type":"object","required":["name","operating_system","source","status"],"properties":{"additional_details":{"type":"object","description":"Additional details about image management stream.","additionalProperties":{"type":"string"}},"description":{"type":"string","example":"Windows 10 Stream","description":"Image management stream description."},"name":{"type":"string","example":"Win10","description":"Image management stream name."},"operating_system":{"type":"string","example":"WINDOWS_10","description":"Operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"publisher":{"type":"string","example":"VMware","description":"Image management stream publisher"},"source":{"type":"string","example":"MARKET_PLACE","description":"Image management stream source.\n* MARKET_PLACE: Image management stream is from market place.\n* UPLOADED: Image management stream is uploaded.\n* COPIED_FROM_STREAM: Image management stream is copied from another stream.\n* COPIED_FROM_VERSION: Image management stream is copied from a version.","enum":["MARKET_PLACE","UPLOADED","COPIED_FROM_STREAM","COPIED_FROM_VERSION"]},"status":{"type":"string","example":"AVAILABLE","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.","enum":["AVAILABLE","DELETED","DISABLED","FAILED","IN_PROGRESS","PARTIALLY_AVAILABLE","PENDING"]}},"title":"ImageManagementStreamUpdateSpec","description":"Information related to image management stream."},"ImageManagementTagCreateSpec":{"type":"object","required":["im_stream_id","im_version_id","name"],"properties":{"additional_details":{"type":"object","description":"Additional details about image management tag.","additionalProperties":{"type":"string"}},"im_stream_id":{"type":"string","example":"abc16e8f-9ba0-4789-a5dd-6880f32c52df","description":"Image management stream ID to which this tag belongs."},"im_version_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Image management version ID to which this tag belongs."},"name":{"type":"string","example":"PROD","description":"Image management tag name. It is unique among all the tags of a stream."}},"title":"ImageManagementTagCreateSpec","description":"Information related to image management tag."},"ImageManagementTagInfo":{"type":"object","properties":{"additional_details":{"type":"object","description":"Additional details about image management tag.","additionalProperties":{"type":"string"}},"description":{"type":"string","description":"Image management tag description."},"id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d","description":"Unique ID representing image management tag."},"im_stream_id":{"type":"string","example":"abc16e8f-9ba0-4789-a5dd-6880f32c52df","description":"Image management stream ID to which this tag belongs."},"im_version_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Image management version ID to which this tag belongs."},"name":{"type":"string","example":"STAGE","description":"Image management tag name."}},"title":"ImageManagementTagInfo","description":"Information related to image management tag."},"ImageManagementTagUpdateSpec":{"type":"object","required":["im_version_id","name"],"properties":{"additional_details":{"type":"object","description":"Additional details about image management tag.","additionalProperties":{"type":"string"}},"im_version_id":{"type":"string","example":"7e85b3a5-e7d0-4ad6-a1e3-37168dd1ed62","description":"Image management version ID to which this tag belongs."},"name":{"type":"string","example":"PROD","description":"Image management tag name."}},"title":"ImageManagementTagUpdateSpec","description":"Information related to image management tag."},"ImageManagementVersionCreateSpec":{"type":"object","required":["im_stream_id","name","status"],"properties":{"additional_details":{"type":"object","description":"Additional details about image management version.","additionalProperties":{"type":"string"}},"description":{"type":"string","description":"Image management version description."},"im_stream_id":{"type":"string","example":"abc16e8f-9ba0-4789-a5dd-6880f32c52df","description":"Image management stream ID"},"name":{"type":"string","example":"v1","description":"Image management version name."},"status":{"type":"string","example":"AVAILABLE","description":"Image management version status.\n* AVAILABLE: Image management version is available for desktop pools/farms to be created.\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* DELETED: Image management version has been deleted.\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.","enum":["AVAILABLE","DEPLOYING_VM","DEPLOYMENT_DONE","DELETED","DISABLED","FAILED","PARTIALLY_AVAILABLE","PUBLISHING","REPLICATING"]}},"title":"ImageManagementVersionCreateSpec","description":"Information related to image management version."},"ImageManagementVersionInfo":{"type":"object","properties":{"additional_details":{"type":"object","description":"Additional details about image management version.","additionalProperties":{"type":"string"}},"description":{"type":"string","description":"Image management version description."},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing image management version."},"im_stream_id":{"type":"string","example":"abc16e8f-9ba0-4789-a5dd-6880f32c52df","description":"Image management stream ID"},"name":{"type":"string","example":"v1","description":"Image management version name."},"status":{"type":"string","example":"AVAILABLE","description":"Image management version status.\n* AVAILABLE: Image management version is available for desktop pools/farms to be created.\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* DELETED: Image management version has been deleted.\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.","enum":["AVAILABLE","DEPLOYING_VM","DEPLOYMENT_DONE","DELETED","DISABLED","FAILED","PARTIALLY_AVAILABLE","PUBLISHING","REPLICATING"]}},"title":"ImageManagementVersionInfo","description":"Information related to image management version."},"ImageManagementVersionUpdateSpec":{"type":"object","required":["name","status"],"properties":{"additional_details":{"type":"object","description":"Additional details about image management version.","additionalProperties":{"type":"string"}},"description":{"type":"string","description":"Image management version description."},"name":{"type":"string","example":"v1","description":"Image management version name."},"status":{"type":"string","example":"AVAILABLE","description":"Image management version status.\n* AVAILABLE: Image management version is available for desktop pools/farms to be created.\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* DELETED: Image management version has been deleted.\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.","enum":["AVAILABLE","DEPLOYING_VM","DEPLOYMENT_DONE","DELETED","DISABLED","FAILED","PARTIALLY_AVAILABLE","PUBLISHING","REPLICATING"]}},"title":"ImageManagementVersionUpdateSpec","description":"Information related to image management version."},"InstalledApplicationInfo":{"type":"object","properties":{"executable_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk","description":"Path to application executable."},"file_types":{"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":"#/definitions/ApplicationFileTypeData"}},"name":{"type":"string","example":"Firefox","description":"Application name information, as sent by RDSServer/machine during application discovery."},"other_file_types":{"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":"#/definitions/ApplicationOtherFileTypeData"}},"publisher":{"type":"string","example":"Mozilla Corporation","description":"Application publisher"},"version":{"type":"string","example":"72.0.2","description":"Application version."}},"title":"InstalledApplicationInfo","description":"Information about the application installed on RDS server/machine of a farm/desktop pool."},"InstalledApplicationValidationInfo":{"type":"object","properties":{"application_exe_path":{"type":"string","example":"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Accessibility\\Speech Recognition.lnk","description":"Application executable path."},"machine_or_rds_server_ids":{"type":"array","example":["c617fd51-e118-4cae-970c-54a7144aaadc", "bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"],"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.","items":{"type":"string"}},"status":{"type":"string","example":"SUCCESS","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.","enum":["SUCCESS","NOT_INSTALLED"]}},"title":"InstalledApplicationValidationInfo","description":"Information about the application installed on RDS server/machine of a farm/desktop pool based on a given application execution path."},"InstantCloneDomainAccountCreateSpec":{"type":"object","required":["ad_domain_id","password","username"],"properties":{"ad_domain_id":{"type":"string","example":"S-1-5-21-1085031214-1563985344-725345543","description":"SID of the AD Domain that this account user belongs to."},"password":{"type":"array","example":"","description":"Password of the account.","items":{"type":"string"}},"username":{"type":"string","example":"testuser","description":"User name of the account."}},"title":"InstantCloneDomainAccountCreateSpec","description":"Specification of the instant clone domain account."},"InstantCloneDomainAccountInfo":{"type":"object","properties":{"ad_domain_id":{"type":"string","example":"S-1-5-21-1085031214-1563985344-725345543","description":"SID of the AD Domain that this account user belongs to."},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing instant clone domain account."},"username":{"type":"string","example":"testuser","description":"User name of the account."}},"title":"InstantCloneDomainAccountInfo","description":"Information related to instant clone domain accounts of the environment."},"InstantCloneDomainAccountUpdateSpec":{"type":"object","required":["password"],"properties":{"password":{"type":"array","example":"","description":"Password of the account.","items":{"type":"string"}}},"title":"InstantCloneDomainAccountUpdateSpec","description":"Update specification for the instant clone domain account."},"JWTAuthenticatorCreateSpec":{"type":"object","required":["issuer","name"],"properties":{"description":{"type":"string","example":"Jwt Authenticator Description","description":"The description of this JWT authenticator.","minLength":1,"maxLength":1024},"issuer":{"type":"string","example":"portal","description":"The issuer of this JWT authenticator. The configured value is matched against the \"iss\" claim of the JWT.","minLength":1,"maxLength":256},"name":{"type":"string","example":"Jwt Authenticator","description":"The name of the JWT authenticator. It must be unique among all other JWT authenticators.","minLength":1,"maxLength":32},"public_keys":{"type":"array","example":["{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"],"description":"The publicKeys as Json strings for this JWT authenticator. If \"publicKeys\" is blank, then \"url\" must not be blank.","items":{"type":"string"}},"url":{"type":"string","example":"https://example.com/portal/.well-known/openid-configuration","description":"The URL to fetch the public keys for this authenticator. If \"url\" is blank, then \"publicKeys\" must not be blank.","minLength":1,"maxLength":2096}},"title":"JWTAuthenticatorCreateSpec","description":"Information required to create a JWT authenticator."},"JWTAuthenticatorInfo":{"type":"object","properties":{"description":{"type":"string","example":"Jwt Authenticator Description","description":"The description of this JWT authenticator."},"id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"Unique ID of this JWT authenticator."},"issuer":{"type":"string","example":"portal","description":"The issuer of this JWT authenticator. The configured value is matched against the \"iss\" claim of the JWT."},"name":{"type":"string","example":"Jwt Authenticator","description":"The name of this JWT authenticator."},"public_keys":{"type":"array","example":["{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"],"description":"The stored public keys for this JWT authenticator.","items":{"type":"string"}},"url":{"type":"string","example":"https://example.com/portal/.well-known/openid-configuration","description":"The URL to fetch the public keys for this authenticator."}},"title":"JWTAuthenticatorInfo","description":"Information about JWT authenticator."},"JWTAuthenticatorUpdateSpec":{"type":"object","required":["issuer","name"],"properties":{"description":{"type":"string","example":"Jwt Authenticator Description","description":"The description of this JWT authenticator.","minLength":1,"maxLength":1024},"issuer":{"type":"string","example":"portal","description":"The issuer of this JWT authenticator. The configured value is matched against the \"iss\" claim of the JWT.","minLength":1,"maxLength":256},"name":{"type":"string","example":"Jwt Authenticator","description":"The name of the JWT authenticator. It must be unique among all other JWT authenticators.","minLength":1,"maxLength":32},"public_keys":{"type":"array","example":["{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"],"description":"The publicKeys as Json strings for this JWT authenticator. If \"publicKeys\" is blank, then \"url\" must not be blank.","items":{"type":"string"}},"url":{"type":"string","example":"https://example.com/portal/.well-known/openid-configuration","description":"The URL to fetch the public keys for this authenticator. If \"url\" is blank, then \"publicKeys\" must not be blank.","minLength":1,"maxLength":2096}},"title":"JWTAuthenticatorUpdateSpec","description":"Information required to update a JWT authenticator."},"LicenseInfo":{"type":"object","properties":{"application_pool_launch_enabled":{"type":"boolean","example":false,"description":"Whether application pool launch is enabled."},"desktop_pool_launch_enabled":{"type":"boolean","example":false,"description":"Whether desktop pool launch is enabled."},"expiration_time":{"type":"integer","format":"int64","example":1656527400000,"description":"The expiration date of the license. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated."},"grace_period_days":{"type":"integer","format":"int32","example":100,"description":"The grace period in days. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated."},"help_desk_enabled":{"type":"boolean","example":false,"description":"Whether help desk is enabled."},"instant_clone_enabled":{"type":"boolean","example":true,"description":"Whether instant clone is enabled."},"license_edition":{"type":"string","example":"HORIZON_STANDARD_CONCURRENT_USER","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.","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","example":"GREEN","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 and license update is missed but not more than 7 days.\n* RED: License is expired.\n* YELLOW: License is not expired and license update is missed for more than 7 days.","enum":["GREEN","RED","YELLOW"]},"license_key":{"type":"string","example":"KHJL-XXXXX-XXXXX-XXXXX-E3HNJ","description":"The license key in partially redacted form. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated."},"license_mode":{"type":"string","example":"SUBSCRIPTION","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.","enum":["DEFAULT","PERPETUAL_ONLY","SUBSCRIPTION"]},"licensed":{"type":"boolean","example":true,"description":"Whether the horizon is licensed."},"session_collaboration_enabled":{"type":"boolean","example":true,"description":"Whether session collaboration is enabled."},"subscription_slice_expiry":{"type":"integer","format":"int64","example":1465711500000,"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."},"usage_model":{"type":"string","example":"NAMED_USER","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.","enum":["CONCURRENT_USER","NAMED_USER"]}},"title":"LicenseInfo","description":"Information about a license."},"LicenseInfoV2":{"type":"object","properties":{"agent_auto_upgrade_enabled":{"type":"boolean","example":true,"description":"Indicates whether agent auto upgrade is enabled."},"application_pool_launch_enabled":{"type":"boolean","example":false,"description":"Whether application pool launch is enabled."},"desktop_pool_launch_enabled":{"type":"boolean","example":false,"description":"Whether desktop pool launch is enabled."},"expiration_time":{"type":"integer","format":"int64","example":1656527400000,"description":"The expiration date of the license. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated."},"grace_period_days":{"type":"integer","format":"int32","example":100,"description":"The grace period in days. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated."},"help_desk_enabled":{"type":"boolean","example":false,"description":"Whether help desk is enabled."},"instant_clone_enabled":{"type":"boolean","example":true,"description":"Whether instant clone is enabled."},"license_edition":{"type":"string","example":"HORIZON_STANDARD_CONCURRENT_USER","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.","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","example":"GREEN","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 and license update is missed but not more than 7 days.\n* RED: License is expired.\n* YELLOW: License is not expired and license update is missed for more than 7 days.","enum":["GREEN","RED","YELLOW"]},"license_key":{"type":"string","example":"KHJL-XXXXX-XXXXX-XXXXX-E3HNJ","description":"The license key in partially redacted form. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated."},"license_mode":{"type":"string","example":"SUBSCRIPTION","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.","enum":["DEFAULT","PERPETUAL_ONLY","SUBSCRIPTION"]},"licensed":{"type":"boolean","example":true,"description":"Whether the horizon is licensed."},"session_collaboration_enabled":{"type":"boolean","example":true,"description":"Whether session collaboration is enabled."},"subscription_slice_expiry":{"type":"integer","format":"int64","example":1465711500000,"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."},"usage_model":{"type":"string","example":"NAMED_USER","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.","enum":["CONCURRENT_USER","NAMED_USER"]}},"title":"LicenseInfoV2","description":"Information about a license."},"LicenseModeSpec":{"type":"object","required":["license_mode"],"properties":{"license_mode":{"type":"string","example":"SUBSCRIPTION","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.","enum":["DEFAULT","PERPETUAL_ONLY","SUBSCRIPTION"]}},"title":"LicenseModeSpec","description":"Information to set the mode of license"},"LoadBalancerMetricSettings":{"type":"object","properties":{"cpu_threshold":{"type":"integer","format":"int32","example":50,"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.","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_queue_length_threshold":{"type":"integer","format":"int32","example":50,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_read_latency_threshold":{"type":"integer","format":"int32","example":50,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_write_latency_threshold":{"type":"integer","format":"int32","example":50,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"include_session_count":{"type":"boolean","example":true,"description":"Whether to include session count for load balancing. Default value is true."},"memory_threshold":{"type":"integer","format":"int32","example":50,"description":"Represents threshold of memory usage, in percentage.If the value is 0, then this metric will not be considered for load balancing.","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"LoadBalancerMetricSettings","description":"Load Balancer Metric settings for Farm."},"LocalAccessGroupCreateSpec":{"type":"object","required":["name"],"properties":{"description":{"type":"string","example":"This access group can be used to delegate administration of sales team inventories to specific administrators.","description":"Access group description.","maxLength":400},"name":{"type":"string","example":"Sales","description":"Access group name. This property must contain only alphanumerics, underscores, and dashes.","minLength":1,"maxLength":32}},"title":"LocalAccessGroupCreateSpec","description":"Information required to create Local Access Group."},"LocalAccessGroupInfo":{"type":"object","properties":{"deletable":{"type":"boolean","example":true,"description":"Indicates whether this access group can be deleted."},"description":{"type":"string","example":"This access group can be used to delegate administration of sales team inventories to specific administrators.","description":"Access group description."},"id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"Unique ID representing this access group."},"name":{"type":"string","example":"Sales","description":"Access group name."}},"title":"LocalAccessGroupInfo","description":"Information about a local access group."},"LocalAccessGroupInfoV2":{"type":"object","properties":{"deletable":{"type":"boolean","example":true,"description":"Indicates whether this access group can be deleted."},"description":{"type":"string","example":"This access group can be used to delegate administration of sales team inventories to specific administrators.","description":"Access group description."},"id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"Unique ID representing this access group."},"name":{"type":"string","example":"Sales","description":"Access group name."},"permission_ids":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","6fd4638a-381f-4518-aed6-042aa3d9f14c"],"description":"List of permission ids associated with the access group","items":{"type":"string"}}},"title":"LocalAccessGroupInfoV2","description":"Information about a local access group."},"MachineAgentUpgradeSpec":{"type":"object","required":["end_time","machine_ids","start_time"],"properties":{"agent_installer_package_id":{"type":"string","example":"2b6eaeb8-2e91-11ed-a261-0242ac120002","description":"ID of the agent installer package."},"custom_install_parameters":{"type":"string","example":"ADDLOCAL=Core,USB","description":"Indicates any parameters to be used by the agent for silent install."},"end_time":{"type":"integer","format":"int64","example":1652079610000,"description":"Agent upgrade end time."},"machine_ids":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe", "7cdd624f-37d1-46c1-ab96-695a5d13956f"],"description":"Machine Ids representing the machines to be upgraded.","items":{"type":"string"}},"skip_for_logged_in_users":{"type":"boolean","example":true,"description":"Indicates whether to skip agent upgrade for logged in users."},"start_time":{"type":"integer","format":"int64","example":1652079610000,"description":"Agent upgrade start time."}},"title":"MachineAgentUpgradeSpec"},"MachineAlias":{"type":"object","properties":{"ad_user_id":{"type":"string","example":"S-1-5-21-2898529287-1016622242-505487308-1553","description":"Sid of the user"},"alias_name":{"type":"string","example":"Alias1","description":"Alias name of the user."}},"title":"MachineAlias","description":"Info for reading machine aliases of assigned users."},"MachineAliasSpec":{"type":"object","properties":{"ad_user_id":{"type":"string","example":"S-1-5-21-2898529287-1016622242-505487308-1553","description":"Sid of the user"},"alias_name":{"type":"string","example":"Alias1","description":"Alias name of the user."}},"title":"MachineAliasSpec","description":"The specification for updating machine aliases of assigned users."},"MachineDeleteData":{"type":"object","properties":{"allow_delete_from_multi_desktop_pools":{"type":"boolean","example":true,"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."},"archive_datastore_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","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."},"archive_datastore_path_id":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","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."},"archive_persistent_disk":{"type":"boolean","example":true,"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. "},"delete_from_disk":{"type":"boolean","example":true,"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."},"force_logoff_session":{"type":"boolean","example":true,"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. "}},"title":"MachineDeleteData","description":"Specification applicable when deleting machines."},"MachineDeleteSpec":{"type":"object","required":["machine_ids"],"properties":{"machine_delete_data":{"description":"The specification applicable when deleting machines.","$ref":"#/definitions/MachineDeleteData"},"machine_ids":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe", "7cdd624f-37d1-46c1-ab96-695a5d13956f"],"description":"Machine Ids representing the machines to be deleted.","items":{"type":"string"}}},"title":"MachineDeleteSpec","description":"Information required to delete machines."},"MachineInfo":{"type":"object","properties":{"agent_build_number":{"type":"string","example":22673015,"description":"The Horizon Agent build number.
Supported Filters : 'Equals'."},"agent_version":{"type":"string","example":7.12,"description":"The Horizon Agent version.
Supported Filters : 'Equals'."},"attempted_theft_by_connection_server":{"type":"array","example":"connection-server2.example.com","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","items":{"type":"string"}},"configured_by_connection_server":{"type":"array","example":"connection-server1.example.com","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","items":{"type":"string"}},"desktop_pool_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"The id of the Desktop Pool that the machine belongs to.
Supported Filters : 'Equals'."},"dns_name":{"type":"string","example":"machine1.example.com","description":"DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing machine.
Supported Filters : 'Equals'."},"managed_machine_data":{"description":"Information applicable only to Managed Machines.","$ref":"#/definitions/ManagedMachineData"},"message_security_enhanced_mode_supported":{"type":"boolean","example":true,"description":"Indicates whether ENHANCED message security mode is currently supported by this machine."},"message_security_mode":{"type":"string","example":"MIXED","description":"The current JMS message security mode used by this machine.
Supported Filters : 'Equals'.\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.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.","enum":["DISABLED","MIXED","ENABLED","ENHANCED"]},"name":{"type":"string","example":"machine1","description":"Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'."},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2016","description":"The guest operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"operating_system_architecture":{"type":"string","example":"BIT_64","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.","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","example":"IN_PAIRING","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.","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","example":32573985,"description":"The remote experience Horizon Agent build number.
Supported Filters : 'Equals'."},"remote_experience_agent_version":{"type":"string","example":7.12,"description":"The remote experience Horizon Agent version.
Supported Filters : 'Equals'."},"state":{"type":"string","example":"PROVISIONING","description":"The state of the machine.
Supported Filters : 'Equals'.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\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.\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* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* ERROR: An unknown error occurred in the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\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* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\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_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_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* 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* IN_PROGRESS: There is a machine operation in progress.\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* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* UNKNOWN: Could not determine the state of the machine.","enum":["PROVISIONING","PROVISIONING_ERROR","WAITING_FOR_AGENT","CUSTOMIZING","DELETING","MAINTENANCE","ERROR","PROVISIONED","AGENT_UNREACHABLE","UNASSIGNED_USER_CONNECTED","CONNECTED","UNASSIGNED_USER_DISCONNECTED","DISCONNECTED","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","ALREADY_USED","AVAILABLE","IN_PROGRESS","DISABLED","DISABLE_IN_PROGRESS","VALIDATING","UNKNOWN"]},"type":{"type":"string","example":"MANAGED_MACHINE","description":"The type of machine.
Supported Filters : 'Equals'.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE"]},"user_ids":{"type":"array","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"description":"The unique SIDs of the users assigned to the machine.
Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","items":{"type":"string"}}},"title":"MachineInfo","description":"Information related to a Machine.
List API returning this summary information can use search filter query to filter on specific fields supported by filters.
Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"MachineInfoV2":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access group id of this Machine."},"agent_build_number":{"type":"string","example":22673015,"description":"The Horizon Agent build number.
Supported Filters : 'Equals'."},"agent_version":{"type":"string","example":7.12,"description":"The Horizon Agent version.
Supported Filters : 'Equals'."},"aliases":{"type":"array","description":"List of MachineAlias","items":{"$ref":"#/definitions/MachineAlias"}},"attempted_theft_by_connection_server":{"type":"array","example":"connection-server2.example.com","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","items":{"type":"string"}},"configured_by_connection_server":{"type":"array","example":"connection-server1.example.com","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","items":{"type":"string"}},"desktop_pool_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"The id of the Desktop Pool that the machine belongs to.
Supported Filters : 'Equals'."},"dns_name":{"type":"string","example":"machine1.example.com","description":"DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing machine.
Supported Filters : 'Equals'."},"managed_machine_data":{"description":"Information applicable only to Managed Machines.","$ref":"#/definitions/ManagedMachineDataV2"},"message_security_enhanced_mode_supported":{"type":"boolean","example":true,"description":"Indicates whether ENHANCED message security mode is currently supported by this machine."},"message_security_mode":{"type":"string","example":"MIXED","description":"The current JMS message security mode used by this machine.
Supported Filters : 'Equals'.\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.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.","enum":["DISABLED","MIXED","ENABLED","ENHANCED"]},"name":{"type":"string","example":"machine1","description":"Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'."},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2016","description":"The guest operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"operating_system_architecture":{"type":"string","example":"BIT_64","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.","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","example":"IN_PAIRING","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.","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","example":32573985,"description":"The remote experience Horizon Agent build number.
Supported Filters : 'Equals'."},"remote_experience_agent_version":{"type":"string","example":7.12,"description":"The remote experience Horizon Agent version.
Supported Filters : 'Equals'."},"session_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"The ID of the session on the Machine (if one exists)."},"state":{"type":"string","example":"PROVISIONING","description":"The state of the machine.
Supported Filters : 'Equals'.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\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.\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* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* ERROR: An unknown error occurred in the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\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* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\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_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_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* 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* IN_PROGRESS: There is a machine operation in progress.\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* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* UNKNOWN: Could not determine the state of the machine.","enum":["PROVISIONING","PROVISIONING_ERROR","WAITING_FOR_AGENT","CUSTOMIZING","DELETING","MAINTENANCE","ERROR","PROVISIONED","AGENT_UNREACHABLE","UNASSIGNED_USER_CONNECTED","CONNECTED","UNASSIGNED_USER_DISCONNECTED","DISCONNECTED","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","ALREADY_USED","AVAILABLE","IN_PROGRESS","DISABLED","DISABLE_IN_PROGRESS","VALIDATING","UNKNOWN"]},"type":{"type":"string","example":"MANAGED_MACHINE","description":"The type of machine.
Supported Filters : 'Equals'.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE"]},"user_ids":{"type":"array","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"description":"The unique SIDs of the users assigned to the machine.
Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","items":{"type":"string"}}},"title":"MachineInfoV2","description":"Information related to a Machine.
List API returning this summary information can use search filter query to filter on specific fields supported by filters.
Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"MachineInfoV3":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access group id of this Machine."},"agent_build_number":{"type":"string","example":22673015,"description":"The Horizon Agent build number.
Supported Filters : 'Equals'."},"agent_version":{"type":"string","example":7.12,"description":"The Horizon Agent version.
Supported Filters : 'Equals'."},"aliases":{"type":"array","description":"List of MachineAlias","items":{"$ref":"#/definitions/MachineAlias"}},"attempted_theft_by_connection_server":{"type":"array","example":"connection-server2.example.com","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","items":{"type":"string"}},"configured_by_connection_server":{"type":"array","example":"connection-server1.example.com","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","items":{"type":"string"}},"desktop_pool_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"The id of the Desktop Pool that the machine belongs to.
Supported Filters : 'Equals'."},"dns_name":{"type":"string","example":"machine1.example.com","description":"DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'."},"held_machine":{"type":"boolean","example":true,"description":"Indicates whether the machine is in held state.Supported Filters: 'Equals'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing machine.
Supported Filters : 'Equals'."},"managed_machine_data":{"description":"Information applicable only to Managed Machines.","$ref":"#/definitions/ManagedMachineDataV2"},"message_security_enhanced_mode_supported":{"type":"boolean","example":true,"description":"Indicates whether ENHANCED message security mode is currently supported by this machine."},"message_security_mode":{"type":"string","example":"MIXED","description":"The current JMS message security mode used by this machine.
Supported Filters : 'Equals'.\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.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.","enum":["DISABLED","MIXED","ENABLED","ENHANCED"]},"name":{"type":"string","example":"machine1","description":"Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'."},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2016","description":"The guest operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"operating_system_architecture":{"type":"string","example":"BIT_64","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.","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","example":"IN_PAIRING","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.","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","example":32573985,"description":"The remote experience Horizon Agent build number.
Supported Filters : 'Equals'."},"remote_experience_agent_version":{"type":"string","example":7.12,"description":"The remote experience Horizon Agent version.
Supported Filters : 'Equals'."},"session_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"The ID of the session on the Machine (if one exists)."},"state":{"type":"string","example":"PROVISIONING","description":"The state of the machine.
Supported Filters : 'Equals'.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\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.\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* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* ERROR: An unknown error occurred in the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\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* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\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_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_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* 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* IN_PROGRESS: There is a machine operation in progress.\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* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* UNKNOWN: Could not determine the state of the machine.","enum":["PROVISIONING","PROVISIONING_ERROR","WAITING_FOR_AGENT","CUSTOMIZING","DELETING","MAINTENANCE","ERROR","PROVISIONED","AGENT_UNREACHABLE","UNASSIGNED_USER_CONNECTED","CONNECTED","UNASSIGNED_USER_DISCONNECTED","DISCONNECTED","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","ALREADY_USED","AVAILABLE","IN_PROGRESS","DISABLED","DISABLE_IN_PROGRESS","VALIDATING","UNKNOWN"]},"type":{"type":"string","example":"MANAGED_MACHINE","description":"The type of machine.
Supported Filters : 'Equals'.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE"]},"user_ids":{"type":"array","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"description":"The unique SIDs of the users assigned to the machine.
Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","items":{"type":"string"}}},"title":"MachineInfoV3","description":"Information related to a Machine.
List API returning this summary information can use search filter query to filter on specific fields supported by filters.
Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"MachineInfoV4":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"Access group id of this Machine."},"agent_build_number":{"type":"string","example":22673015,"description":"The Horizon Agent build number.
Supported Filters : 'Equals'."},"agent_upgrade_error_message":{"type":"string","example":true,"description":"Error message of the agent upgrade operation failure on the machine."},"agent_upgrade_result":{"type":"string","example":"OK","description":"Result of the agent upgrade operation on the machine.\n* OK: Agent upgrade is OK.\n* ERROR: Agent upgrade has unknown error.\n* FAILURE: Agent upgrade has failed.\n* INVALID: Agent received invalid values for upgrade.\n* DUPLICATE: Agent received duplicate upgrade request.\n* NOT_FOUND: Agent could not find upgrade request.\n* PROGRESS: Agent upgrade is in progress.\n* PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.\n* PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.\n* PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.\n* UNKNOWN: Agent upgrade result is unknown.","enum":["OK","ERROR","FAILURE","INVALID","DUPLICATE","NOT_FOUND","PROGRESS","PREFLIGHTCHECK_INPROGRESS","PREFLIGHTCHECK_OK","PREFLIGHTCHECK_FAILURE","UNKNOWN"]},"agent_upgrade_state":{"type":"string","example":"WAIT","description":"State of the agent upgrade operation on the machine.\n* READY: Agent is ready to be upgraded.\n* DOWNLOAD: Agent is downloading the upgrade binary.\n* WAIT: Agent is waiting for user to logoff or for reboot to complete.\n* NOLOGON: Agent has no logged in user.\n* UPDATING: Agent is upgrading.\n* DONE: Agent upgrade task has ended.\n* UNKNOWN: Agent upgrade state is unknown.","enum":["READY","DOWNLOAD","WAIT","NOLOGON","UPDATING","DONE","UNKNOWN"]},"agent_version":{"type":"string","example":7.12,"description":"The Horizon Agent version.
Supported Filters : 'Equals'."},"aliases":{"type":"array","description":"List of MachineAlias","items":{"$ref":"#/definitions/MachineAlias"}},"attempted_theft_by_connection_server":{"type":"array","example":"connection-server2.example.com","description":"Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.","items":{"type":"string"}},"configured_by_connection_server":{"type":"array","example":"connection-server1.example.com","description":"Names of the Horizon Connection Servers the Horizon Agent is paired with.","items":{"type":"string"}},"desktop_pool_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"The id of the Desktop Pool that the machine belongs to.
Supported Filters : 'Equals'."},"dns_name":{"type":"string","example":"machine1.example.com","description":"DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'."},"held_machine":{"type":"boolean","example":true,"description":"Indicates whether the machine is in held state.Supported Filters: 'Equals'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing machine.
Supported Filters : 'Equals'."},"managed_machine_data":{"description":"Information applicable only to Managed Machines.","$ref":"#/definitions/ManagedMachineDataV2"},"message_security_enhanced_mode_supported":{"type":"boolean","example":true,"description":"Indicates whether ENHANCED message security mode is currently supported by this machine."},"message_security_mode":{"type":"string","example":"MIXED","description":"The current JMS message security mode used by this machine.
Supported Filters : 'Equals'.\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.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.","enum":["DISABLED","MIXED","ENABLED","ENHANCED"]},"name":{"type":"string","example":"machine1","description":"Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'."},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2016","description":"The guest operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"operating_system_architecture":{"type":"string","example":"BIT_64","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.","enum":["UNKNOWN","BIT_32","BIT_64"]},"pairing_state":{"type":"string","example":"IN_PAIRING","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.","enum":["NOT_AVAILABLE","IN_PAIRING","PAIRED_AND_SECURED"]},"remote_experience_agent_build_number":{"type":"string","example":32573985,"description":"The remote experience Horizon Agent build number.
Supported Filters : 'Equals'."},"remote_experience_agent_version":{"type":"string","example":7.12,"description":"The remote experience Horizon Agent version.
Supported Filters : 'Equals'."},"session_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","description":"The ID of the session on the Machine (if one exists)."},"state":{"type":"string","example":"PROVISIONING","description":"The state of the machine.
Supported Filters : 'Equals'.\n* PROVISIONING: The machine is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\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.\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* MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.\n* ERROR: An unknown error occurred in the machine.\n* PROVISIONED: The machine is powered off or suspended.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\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* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\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_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_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* 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* IN_PROGRESS: There is a machine operation in progress.\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* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* UNKNOWN: Could not determine the state of the machine.","enum":["PROVISIONING","PROVISIONING_ERROR","WAITING_FOR_AGENT","CUSTOMIZING","DELETING","MAINTENANCE","ERROR","PROVISIONED","AGENT_UNREACHABLE","UNASSIGNED_USER_CONNECTED","CONNECTED","UNASSIGNED_USER_DISCONNECTED","DISCONNECTED","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_CONFIG_ERROR","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","ALREADY_USED","AVAILABLE","IN_PROGRESS","DISABLED","DISABLE_IN_PROGRESS","VALIDATING","UNKNOWN"]},"type":{"type":"string","example":"MANAGED_MACHINE","description":"The type of machine.
Supported Filters : 'Equals'.\n* MANAGED_MACHINE: The machine is a managed virtual machine.\n* UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.","enum":["MANAGED_MACHINE","UNMANAGED_MACHINE"]},"user_ids":{"type":"array","example":["S-1-1-1-3965912346-1012345398-3123456564-123","S-1-2-3-3123456786-1012345398-3123456784-124"],"description":"The unique SIDs of the users assigned to the machine.
Supported Filters : 'Equals', 'NotEquals' and 'Contains'.","items":{"type":"string"}}},"title":"MachineInfoV4","description":"Information related to a Machine.
List API returning this summary information can use search filter query to filter on specific fields supported by filters.
Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"MachineSpecifiedName":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"machine1","description":"Name of the machine."},"user_id":{"type":"string","example":"S-1-1-1-3965912346-1012345398-3123456564-123","description":"The unique SID of the user assigned to the machine."}},"title":"MachineSpecifiedName","description":"Information required to add a machine to a desktop pool."},"ManagedMachineData":{"type":"object","properties":{"clone_error_message":{"type":"string","example":"Timeout expired trying to clone a virtual machine.","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."},"clone_error_time":{"type":"integer","format":"int64","example":1575285661395,"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."},"create_time":{"type":"integer","format":"int64","example":1575285661395,"description":"Time at which the machine was created in milliseconds. Measured as epoch time."},"host_name":{"type":"string","example":"WD332H5","description":"The name of the host on which this virtual machine is registered."},"in_hold_customization":{"type":"boolean","example":false,"description":"This condition determines if this virtual machine should be on hold before customization is started.
Supported Filters : 'Equals'."},"in_maintenance_mode":{"type":"boolean","example":false,"description":"Indicates whether the Machine is in maintenance mode."},"memory_mb":{"type":"integer","format":"int32","example":1024,"description":"The virtual machine physical memory in MB."},"missing_in_vcenter":{"type":"boolean","example":false,"description":"This condition determines if the virtual machine is missing in vCenter Server.
Supported Filters : 'Equals'."},"network_labels":{"type":"array","description":"The network label(s) associated with this Machine.
This information will only be populated if a network label is explicitly assigned to this machine.
Otherwise, the machine inherits these properties from the parent virtual machine.","items":{"$ref":"#/definitions/NetworkLabelData"}},"path":{"type":"string","example":"/path/host","description":"The virtual machine path.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.Field name to be used in filter : managedMachineData.path."},"storage_accelerator_state":{"type":"string","example":"CURRENT","description":"The Horizon Storage Accelerator state. Storage acceleration will be available for managed machines if configured.
Supported Filters : 'Equals'.\n* OFF: The Storage Accelerator is off.\n* CURRENT: The machine cached data is updated.\n* OUT_OF_DATE: The machine cached data is not updated and requires regeneration.\n* ERROR: The Storage Accelerator has encountered an error.","enum":["OFF","CURRENT","OUT_OF_DATE","ERROR"]},"virtual_center_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"The ID of the Virtual Center managing this machine.
Supported Filters : 'Equals'."},"virtual_disks":{"type":"array","description":"The virtual disks comprising the virtual machine.","items":{"$ref":"#/definitions/VirtualDiskData"}},"virtual_machine_power_state":{"type":"string","example":"POWERED_ON","description":"The virtual machine power state.
Supported Filters : 'Equals'.\n* POWERED_OFF: The machine is powered off.\n* POWERED_ON: The machine is powered on.\n* SUSPENDED: The machine is suspended.","enum":["POWERED_OFF","POWERED_ON","SUSPENDED"]}},"title":"ManagedMachineData","description":"Information related to Managed machines."},"ManagedMachineDataV2":{"type":"object","properties":{"base_vm_id":{"type":"string","example":"vm-23","description":"The base VM id.
Supported Filters : 'Equals'."},"base_vm_snapshot_id":{"type":"string","example":"snapshot-2","description":"The base VM snapshot id.
Supported Filters : 'Equals'."},"clone_error_message":{"type":"string","example":"Timeout expired trying to clone a virtual machine.","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."},"clone_error_time":{"type":"integer","format":"int64","example":1575285661395,"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."},"create_time":{"type":"integer","format":"int64","example":1575285661395,"description":"Time at which the machine was created in milliseconds. Measured as epoch time."},"datastore_ids":{"type":"array","example":["datastore1", "datastore2"],"description":"The ids of the datastores.","items":{"type":"string"}},"host_name":{"type":"string","example":"WD332H5","description":"The name of the host on which this virtual machine is registered."},"image_management_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"The id of the image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog."},"image_management_tag_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d","description":"The id of the image management tag. This will be populated only for instant clone machines provisioned from pools created using image catalog."},"in_hold_customization":{"type":"boolean","example":false,"description":"This condition determines if this virtual machine should be on hold before customization is started.
Supported Filters : 'Equals'."},"in_maintenance_mode":{"type":"boolean","example":false,"description":"Indicates whether the Machine is in maintenance mode."},"last_maintenance_time":{"type":"integer","format":"int64","example":1587081283000,"description":"The time of the last maintenance operation."},"logoff_policy":{"type":"string","example":"FORCE_LOGOFF","description":"The user log off behavior at the time of maintenance.\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.","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"memory_mb":{"type":"integer","format":"int32","example":1024,"description":"The virtual machine physical memory in MB."},"missing_in_vcenter":{"type":"boolean","example":false,"description":"This condition determines if the virtual machine is missing in vCenter Server.
Supported Filters : 'Equals'."},"network_labels":{"type":"array","description":"The network label(s) associated with this Machine.
This information will only be populated if a network label is explicitly assigned to this machine.
Otherwise, the machine inherits these properties from the parent virtual machine.","items":{"$ref":"#/definitions/NetworkLabelData"}},"operation":{"type":"string","example":"REFRESH","description":"The current maintenance operation on the machine.
Supported Filters : 'Equals'.\n* PUSH_IMAGE: A push image operation.\n* ARCHIVE: An archive operation.\n* TAGGING: A tagging operation.","enum":["PUSH_IMAGE","ARCHIVE","TAGGING"]},"operation_state":{"type":"string","example":"AVAILABLE","description":"The state of the current maintenance operation on the machine.
Supported Filters : 'Equals'.\n* UNDEFINED: The operation state is unrecognized.\n* SCHEDULED: The operation is scheduled for future execution.\n* PROGRESSING: The operation is in progress.\n* COMPLETED: The operation has completed.\n* FAULT: The operation has encountered an error.\n* CANCELLING: The operation has been cancelled.\n* HOLDING: The operation has been paused.\n* CREATE: The operation is being initiated.\n* STANDBY: The operation is on standby for a selective resync.","enum":["UNDEFINED","SCHEDULED","PROGRESSING","COMPLETED","FAULT","CANCELLING","HOLDING","CREATE","STANDBY"]},"path":{"type":"string","example":"/path/host","description":"The virtual machine path.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.Field name to be used in filter : managedMachineData.path."},"pending_base_vm_id":{"type":"string","example":"vm-8","description":"The pending base VM id.
Supported Filters : 'Equals'."},"pending_base_vm_snapshot_id":{"type":"string","example":"snapshot-7","description":"The pending base VM snapshot id.
Supported Filters : 'Equals'."},"pending_image_management_stream_id":{"type":"string","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25","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."},"pending_image_management_tag_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d","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."},"storage_accelerator_state":{"type":"string","example":"CURRENT","description":"The Horizon Storage Accelerator state. Storage acceleration will be available for managed machines if configured.
Supported Filters : 'Equals'.\n* OFF: The Storage Accelerator is off.\n* CURRENT: The machine cached data is updated.\n* OUT_OF_DATE: The machine cached data is not updated and requires regeneration.\n* ERROR: The Storage Accelerator has encountered an error.","enum":["OFF","CURRENT","OUT_OF_DATE","ERROR"]},"virtual_center_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"The ID of the Virtual Center managing this machine.
Supported Filters : 'Equals'."},"virtual_disks":{"type":"array","description":"The virtual disks comprising the virtual machine.","items":{"$ref":"#/definitions/VirtualDiskData"}},"virtual_machine_power_state":{"type":"string","example":"POWERED_ON","description":"The virtual machine power state.
Supported Filters : 'Equals'.\n* POWERED_OFF: The machine is powered off.\n* POWERED_ON: The machine is powered on.\n* SUSPENDED: The machine is suspended.","enum":["POWERED_OFF","POWERED_ON","SUSPENDED"]}},"title":"ManagedMachineDataV2","description":"Information related to Managed machines V2."},"NameAvailabilityInfo":{"type":"object","properties":{"available":{"type":"boolean","description":"Indicates whether name is available for resource creation."}},"title":"NameAvailabilityInfo","description":"Information about name availability of an inventory resource."},"NameAvailabilitySpec":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the inventory resource to be checked for availability."}},"title":"NameAvailabilitySpec","description":"Information required for checking name availability of an inventory resource."},"NamesSpec":{"type":"object","required":["machine_name"],"properties":{"machine_name":{"type":"string","example":"Machine-002-jdoe","description":"The virtual machine name."},"user_name":{"type":"string","example":"abcorp.com\\jdoe","description":"The name of the user entitled to the VM, used only in case of persistent desktop pools."}},"title":"NamesSpec","description":"Manually defined virtual machines and users."},"NetworkInterfaceCardInfo":{"type":"object","properties":{"id":{"type":"string","example":"74390016-2dea-4b8c-8181-385783effaeb","description":"Unique ID representing the network interface card."},"mac_address":{"type":"string","example":"00:50:56:a6:62:ac","description":"Network interface card MAC address."},"name":{"type":"string","example":"Network adapter 1","description":"Network interface card name."}},"title":"NetworkInterfaceCardInfo","description":"Information related to network interface card."},"NetworkInterfaceCardInfoV2":{"type":"object","properties":{"id":{"type":"string","example":"74390016-2dea-4b8c-8181-385783effaeb","description":"Unique ID representing the network interface card."},"mac_address":{"type":"string","example":"00:50:56:a6:62:ac","description":"Network interface card MAC address."},"name":{"type":"string","example":"Network adapter 1","description":"Network interface card name."},"network_type":{"type":"string","example":"OPAQUE_NETWORK","description":"Type of network interface card.\n* NETWORK: Standard network.\n* OPAQUE_NETWORK: Opaque network.\n* DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS Port group.","enum":["NETWORK","OPAQUE_NETWORK","DISTRUBUTED_VIRTUAL_PORT_GROUP"]}},"title":"NetworkInterfaceCardInfoV2","description":"Information related to network interface card."},"NetworkLabelAssignmentSettings":{"type":"object","properties":{"enabled":{"type":"boolean","example":true,"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."},"max_label":{"type":"integer","format":"int32","example":1,"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."},"max_label_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","example":"vm-network","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."}},"title":"NetworkLabelAssignmentSettings","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","example":true,"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."},"max_label":{"type":"integer","format":"int32","example":1,"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."},"max_label_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"network_label_name":{"type":"string","example":"vm-network","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."}},"title":"NetworkLabelAssignmentSettingsInfo","description":"Network label assignment settings for the farm."},"NetworkLabelData":{"type":"object","properties":{"network_label_name":{"type":"string","example":"example-network","description":"The network label name."},"nic_name":{"type":"string","example":"network1","description":"The network interface name"}},"title":"NetworkLabelData","description":"Information related to a network label."},"NetworkLabelInfo":{"type":"object","properties":{"available_ports":{"type":"integer","format":"int32","example":0,"description":"Available ports in network label."},"id":{"type":"string","example":"network-1","description":"Unique ID representing the network label."},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this Network Label from being used in desktoppool/farm configuration.","items":{"type":"string","enum":["NOT_CONFIGURED_ON_ALL_HOSTS","DVS_UPLINK_PORT","VMC_NETWORKS"]}},"label_type":{"type":"string","example":"EARLY_BINDING","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.","enum":["EARLY_BINDING","EPHEMERAL","LATE_BINDING"]},"max_ports":{"type":"integer","format":"int32","example":0,"description":"The total number of ports present."},"name":{"type":"string","example":"VM Network","description":"Network label name."},"switch_type":{"type":"string","example":"STANDARD_SWITCH","description":"Network label switch type.\n* STANDARD_SWITCH: Standard Switch.\n* DISTRIBUTED_VIRTUAL_SWITCH: Distributed Virtual Switch.\n* NSX_NETWORK_SWITCH: NSX network Switch.","enum":["STANDARD_SWITCH","DISTRIBUTED_VIRTUAL_SWITCH","NSX_NETWORK_SWITCH"]}},"title":"NetworkLabelInfo","description":"Information related to network label."},"NotEqualsFilter":{"title":"NotEqualsFilter","allOf":[{"$ref":"#/definitions/BaseFilter"},{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["And","Or","Not","NotEquals","Equals","Contains","StartsWith","EndsWith","Between"]},"value":{"type":"object"}},"title":"NotEqualsFilter"}]},"NotFilter":{"title":"NotFilter","allOf":[{"$ref":"#/definitions/BaseFilter"},{"type":"object","properties":{"filter":{"$ref":"#/definitions/BaseFilter"},"type":{"type":"string","enum":["And","Or","Not","NotEquals","Equals","Contains","StartsWith","EndsWith","Between"]}},"title":"NotFilter"}]},"OrFilter":{"title":"OrFilter","allOf":[{"$ref":"#/definitions/BaseFilter"},{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/definitions/BaseFilter"}},"type":{"type":"string","enum":["And","Or","Not","NotEquals","Equals","Contains","StartsWith","EndsWith","Between"]}},"title":"OrFilter"}]},"PermissionCreateSpec":{"type":"object","required":["ad_user_or_group_id","role_id"],"properties":{"ad_user_or_group_id":{"type":"string","example":"S-1-5-21-1042673909-920613684-1833544874-512","description":"The AD User or Group SID for this permission."},"federation_access_group_id":{"type":"string","example":"f4c5d06e-791c-4ef8-af6f-1b95955e24df","description":"The federation access group ID for this permission."},"local_access_group_id":{"type":"string","example":"b59b3791-88de-42ed-a61a-561b7fd267ab","description":"The local access group ID for this permission."},"role_id":{"type":"string","example":"9b50589d-818f-40c2-9ced-161d0f1d67dd","description":"Role ID for this permission."}},"title":"PermissionCreateSpec","description":"Information about permission."},"PermissionInfo":{"type":"object","properties":{"ad_user_or_group_id":{"type":"string","example":"S-1-5-21-1042673909-920613684-1833544874-512","description":"The AD User or Group SID for this permission."},"federation_access_group_id":{"type":"string","example":"f4c5d06e-791c-4ef8-af6f-1b95955e24df","description":"The federation access group ID for this permission."},"id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"Unique ID representing this permission."},"local_access_group_id":{"type":"string","example":"b59b3791-88de-42ed-a61a-561b7fd267ab","description":"The local access group ID for this permission."},"role_id":{"type":"string","example":"9b50589d-818f-40c2-9ced-161d0f1d67dd","description":"Role ID for this permission."}},"title":"PermissionInfo","description":"Information about permission."},"PhysicalMachineInfo":{"type":"object","properties":{"description":{"type":"string","example":"This is a physical machine.","description":"Description of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'."},"dns_name":{"type":"string","example":"machine1.example.com","description":"DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing machine.
Supported Filters : 'Equals'."},"message_security_enhanced_mode_supported":{"type":"boolean","example":true,"description":"Indicates whether ENHANCED message security mode is currently supported by this machine."},"message_security_mode":{"type":"string","example":"MIXED","description":"The current JMS message security mode used by this machine.
Supported Filters : 'Equals'.\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.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.","enum":["DISABLED","MIXED","ENABLED","ENHANCED"]},"name":{"type":"string","example":"machine1","description":"Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'."},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2016","description":"The machine operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"state":{"type":"string","example":"AVAILABLE","description":"The state of the machine.
Supported Filters : 'Equals'.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\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* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\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_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_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* DISABLED: The machine is disabled.\n* UNKNOWN: Could not determine the state of the machine.","enum":["AGENT_UNREACHABLE","UNASSIGNED_USER_CONNECTED","CONNECTED","UNASSIGNED_USER_DISCONNECTED","DISCONNECTED","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_CONFIG_ERROR","AVAILABLE","VALIDATING","DISABLED","UNKNOWN"]}},"title":"PhysicalMachineInfo","description":"Information related to a Physical Machine.
List API returning this summary information can use search filter query to filter on specific fields supported by filters.
Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"PhysicalMachineInfoV2":{"type":"object","properties":{"description":{"type":"string","example":"This is a physical machine.","description":"Description of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'."},"dns_name":{"type":"string","example":"machine1.example.com","description":"DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing machine.
Supported Filters : 'Equals'."},"message_security_enhanced_mode_supported":{"type":"boolean","example":true,"description":"Indicates whether ENHANCED message security mode is currently supported by this machine."},"message_security_mode":{"type":"string","example":"MIXED","description":"The current JMS message security mode used by this machine.
Supported Filters : 'Equals'.\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.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.","enum":["DISABLED","MIXED","ENABLED","ENHANCED"]},"name":{"type":"string","example":"machine1","description":"Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'."},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2016","description":"The machine operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"rds_server":{"type":"boolean","example":true,"description":"Indicates if the physical machine is RDS Server.
Supported Filters : 'Equals'."},"state":{"type":"string","example":"AVAILABLE","description":"The state of the machine.
Supported Filters : 'Equals'.\n* AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.\n* UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.\n* CONNECTED: The machine is in an active session and has an active connection to a Horizon client.\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* DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.\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_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_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.\n* AVAILABLE: The machine is powered on and ready for active connections.\n* VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.\n* DISABLED: The machine is disabled.\n* UNKNOWN: Could not determine the state of the machine.","enum":["AGENT_UNREACHABLE","UNASSIGNED_USER_CONNECTED","CONNECTED","UNASSIGNED_USER_DISCONNECTED","DISCONNECTED","AGENT_ERROR_STARTUP_IN_PROGRESS","AGENT_ERROR_DISABLED","AGENT_ERROR_INVALID_IP","AGENT_ERROR_NEEDS_REBOOT","AGENT_ERROR_PROTOCOL_FAILURE","AGENT_CONFIG_ERROR","AVAILABLE","VALIDATING","DISABLED","UNKNOWN"]}},"title":"PhysicalMachineInfoV2","description":"Information related to a Physical Machine.
List API returning this summary information can use search filter query to filter on specific fields supported by filters.
Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"PhysicalMachineRegisterInfo":{"type":"object","properties":{"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing the physical machine."},"pairing_token":{"type":"string","example":"","description":"The pairing token for the physical machine."}},"title":"PhysicalMachineRegisterInfo","description":"Physical machine register response."},"PhysicalMachineRegisterSpec":{"type":"object","required":["dns_name","operating_system"],"properties":{"description":{"type":"string","example":"Newly added physical machine","description":"An optional string to describe how and why this physical machine was registered."},"dns_name":{"type":"string","example":"machine1.example.com","description":"The DNS name for the physical machine."},"operating_system":{"type":"string","example":"WINDOWS_10","description":"The Operating System of the physical machine.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]}},"title":"PhysicalMachineRegisterSpec","description":"Information required to register a physical machine."},"PodAssignmentInfo":{"type":"object","properties":{"global_application_entitlement_id":{"type":"string","example":"e285ebe1-194b-4563-80e0-0ad21134c503","description":"ID of the Global Application Entitlement associated with this pod assignment.
Supported Filters: 'Equals'."},"global_desktop_entitlement_id":{"type":"string","example":"7493bfc7-834a-4d9b-ac7d-b5f60893a3a6","description":"ID of the Global Desktop Entitlement associated with this pod assignment.
Supported Filters: 'Equals'."},"id":{"type":"string","example":"28deeb70-97d5-409e-abb4-497196f1ee18","description":"Unique ID representing this pod assignment.
Supported Filters: 'Equals'."},"pod_id":{"type":"string","example":"32a5ea06-cd09-4609-b3e5-df8379e99c13","description":"ID representing the pod associated with this pod assignment.
Supported Filters: 'Equals'."},"user_id":{"type":"string","example":"S-1-1-1-3965912346-1012345398-3123456564-123","description":"SID of the user associated with this pod assignment.
Supported Filters: 'Equals'."}},"title":"PodAssignmentInfo","description":"Information related to pod assignments in a pod federation.
Only one of global Desktop Entitlement ID and global Application Entitlement ID will be set.
Supported Filters : 'And', 'Or' and 'Equals'.
See the field description to know the filter types it supports."},"PodEndPointData":{"type":"object","properties":{"enabled":{"type":"boolean","example":true,"description":"Indicates whether an endpoint is enabled. A disabled endpoint will be excluded from participating inter-pod communication."},"id":{"type":"string","example":"c5337d77-2bf1-4fa4-b027-c301114f2d1e","description":"Unique ID for a pod endpoint."},"name":{"type":"string","example":"connection-server1.example.com","description":"Name for the pod endpoint."},"roundtrip_time":{"type":"integer","format":"int64","example":1234,"description":"Round trip time (in milliseconds) for ping request between the local pod endpoint and the remote pod."},"status":{"type":"string","example":"ONLINE","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.","enum":["ONLINE","UNCHECKED","OFFLINE"]},"url":{"type":"string","example":"https://connection-server1.example.com:8742","description":"The URL for the pod endpoint. This address and special port will be used for inter-pod communication."}},"title":"PodEndPointData"},"PodEndPointDataV2":{"type":"object","properties":{"enabled":{"type":"boolean","example":true,"description":"Indicates whether an endpoint is enabled. A disabled endpoint will be excluded from participating inter-pod communication."},"id":{"type":"string","example":"c5337d77-2bf1-4fa4-b027-c301114f2d1e","description":"Unique ID for a pod endpoint."},"last_updated_timestamp":{"type":"integer","format":"int64","example":1582029025748,"description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time."},"name":{"type":"string","example":"connection-server1.example.com","description":"Name for the pod endpoint."},"roundtrip_time":{"type":"integer","format":"int64","example":1234,"description":"Round trip time (in milliseconds) for ping request between the local pod endpoint and the remote pod."},"status":{"type":"string","example":"ONLINE","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.","enum":["ONLINE","UNCHECKED","OFFLINE"]},"url":{"type":"string","example":"https://connection-server1.example.com:8742","description":"The URL for the pod endpoint. This address and special port will be used for inter-pod communication."}},"title":"PodEndPointDataV2"},"PodEndpointInfo":{"type":"object","properties":{"enabled":{"type":"boolean","example":true,"description":"Indicates whether an endpoint is enabled. A disabled endpoint is excluded from participating in inter-pod communication."},"id":{"type":"string","example":"48dreb70-97g6-405e-abb5-497136g2ee35","description":"Unique ID representing this pod endpoint."},"name":{"type":"string","example":"Horizon Connection Server","description":"Name of the pod endpoint."},"server_address":{"type":"string","example":"https://horizon-CS.xyz.local:8472","description":"The URL for the pod endpoint. This address and port is used for inter-pod communication."}},"title":"PodEndpointInfo","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":"#/definitions/ConnectionServerStatus"}},"guid":{"type":"string","example":"97b8c51e-2e30-47f8-8c3c-3b2d3ec1a2a7","description":"GUID representing the pod federation."},"local_connection_server_status":{"type":"string","example":"ENABLED","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.","enum":["ENABLED","DISABLED","PENDING","ENABLE_ERROR","DISABLE_ERROR"]},"name":{"type":"string","example":"Horizon Cloud Pod Federation","description":"Name of the pod federation."},"sites":{"type":"array","example":["c617fd51-e118-4cae-970c-54a7144aaadc", "bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"],"description":"Member sites in the pod federation.","items":{"type":"string"}}},"title":"PodFederationInfo","description":"Information related to Pod Federation."},"PodInfo":{"type":"object","properties":{"active_global_application_entitlements":{"type":"array","example":["01c42e80-d31e-4633-93c6-44ff8a5b1afe", "86ba95e0-9d59-4b1f-934e-2deba13fcecb"],"description":"List of Global Application Entitlements with mappings to application pools within this pod.","items":{"type":"string"}},"active_global_desktop_entitlements":{"type":"array","example":["648d8fc5-94e5-438f-8524-8edb533c7de2", "50075a5b-6a68-4be5-b079-cff355945856"],"description":"List of Global Desktop Entitlements with mappings to desktop pools within this pod.","items":{"type":"string"}},"cloud_managed":{"type":"boolean","example":true,"description":"Indicates whether this pod is managed from cloud."},"description":{"type":"string","example":"Pod Description.","description":"Description of this pod."},"endpoints":{"type":"array","example":["716269b7-e43d-4874-877a-c5af36a11322", "d56671b5-42a6-490e-ab40-8373f839f2d3"],"description":"List of endpoints within this pod.","items":{"type":"string"}},"id":{"type":"string","example":"28deeb70-97d5-409e-abb4-497196f1ee18","description":"Unique ID representing this pod."},"local_pod":{"type":"boolean","example":true,"description":"Indicates whether this is the local pod the request was made from.
Only one pod in the pod federation will return true."},"name":{"type":"string","example":"Cluster-CS-1","description":"Name of this pod."},"site_id":{"type":"string","example":"9a892821-8c3d-4e61-9d65-69dfec7b70dc","description":"ID of the site this pod belongs to."}},"title":"PodInfo","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":"#/definitions/PodEndPointData"}},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the pod."},"name":{"type":"string","example":"Cluster-SITE1-POD1","description":"Display name for the pod."},"site_id":{"type":"string","example":"a5882e23-3bf4-1ba6-c128-e780004f2d1e","description":"The Id of the site this pod belongs to."}},"title":"PodMonitorInfo","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":"#/definitions/PodEndPointDataV2"}},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the pod."},"name":{"type":"string","example":"Cluster-SITE1-POD1","description":"Display name for the pod."},"site_id":{"type":"string","example":"a5882e23-3bf4-1ba6-c128-e780004f2d1e","description":"The Id of the site this pod belongs to."}},"title":"PodMonitorInfoV2","description":"Monitoring information related to a pod."},"PodUpdateSpec":{"type":"object","required":["name","site_id"],"properties":{"cloud_managed":{"type":"boolean","example":true,"description":"Indicates whether this pod is managed from cloud. Default value is false."},"description":{"type":"string","example":"Pod Description.","description":"Description of this pod."},"name":{"type":"string","example":"Cluster-CS-1","description":"Name of this pod."},"site_id":{"type":"string","example":"9a892821-8c3d-4e61-9d65-69dfec7b70dc","description":"ID of the site this pod belongs to."}},"title":"PodUpdateSpec","description":"Information required to update a pod in the pod federation."},"PreLogonSettingsInfo":{"type":"object","properties":{"api_session_timeout_minutes":{"type":"integer","format":"int32","example":30,"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"},"console_session_timeout_minutes":{"type":"integer","format":"int32","example":30,"description":"Determines how long an idle admin console session continues before the session times out."},"display_pre_login_admin_banner":{"type":"boolean","example":false,"description":"Enable/disable pre login message pop up before logging into Horizon admin console"},"enable_user_name_caching":{"type":"boolean","example":true,"description":"UI Client provide 'remember me' option when this is set to true"},"pre_login_admin_banner_header":{"type":"string","example":"Attention","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."},"pre_login_admin_banner_message":{"type":"string","example":"Attention","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."}},"title":"PreLogonSettingsInfo","description":"Information related to Pre Logon Settings."},"PrivilegeInfo":{"type":"object","properties":{"name":{"type":"string","example":"FEDERATED_LDAP_MANAGE","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* 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_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* UNKNOWN_PRIVILEGE: Unknown Privilege type. This is a non-selectable privilege.","enum":["ADMINISTRATOR","ADMINISTRATOR_VIEW","VC_CONFIG_VIEW","LOG_COLLECTION","FORENSICS","MANAGE_CERTIFICATES","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_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","UNKNOWN_PRIVILEGE"]},"sub_privileges":{"type":"array","example":["FEDERATED_LDAP_VIEW","POOL_VIEW","MACHINE_VIEW"],"description":"List of sub-privileges.","items":{"type":"string","enum":["ADMINISTRATOR","ADMINISTRATOR_VIEW","VC_CONFIG_VIEW","LOG_COLLECTION","FORENSICS","MANAGE_CERTIFICATES","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_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","UNKNOWN_PRIVILEGE"]}}},"title":"PrivilegeInfo","description":"Information about privileges."},"RADIUSAuthenticatorCreateSpec":{"type":"object","required":["label","radius_servers"],"properties":{"description":{"type":"string","example":"test radius auth","description":"The description for this RADIUS authenticator.","maxLength":1024},"label":{"type":"string","example":"radius-auth-lablel","description":"The label for this RADIUS authenticator. It must be unique among all other RADIUS authenticators.","minLength":1,"maxLength":50},"passcode_label":{"type":"string","example":"test radius auth user passcode","description":"The label for the RADIUS authenticator passcode.","maxLength":20},"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":"#/definitions/RADIUSServerCreateSpec"}},"user_name_label":{"type":"string","example":"test radius auth user","description":"The label for the RADIUS authenticator user name.","maxLength":20}},"title":"RADIUSAuthenticatorCreateSpec","description":"Information required to create a RADIUS authenticator."},"RADIUSAuthenticatorInfo":{"type":"object","properties":{"description":{"type":"string","example":"test radius auth","description":"The description for this RADIUS authenticator."},"id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"Unique ID representing this RADIUS Authenticator."},"label":{"type":"string","example":"radius-auth-lablel","description":"The label for this RADIUS authenticator."},"passcode_label":{"type":"string","example":"test radius auth user passcode","description":"The label for the RADIUS authenticator passcode."},"radius_servers":{"type":"array","description":"List of RADIUS servers.","items":{"$ref":"#/definitions/RADIUSServerInfo"}},"user_name_label":{"type":"string","example":"test radius auth user","description":"The label for the RADIUS authenticator user name."}},"title":"RADIUSAuthenticatorInfo","description":"Information about to RADIUS Authenticator."},"RADIUSAuthenticatorUpdateSpec":{"type":"object","required":["label","radius_servers"],"properties":{"description":{"type":"string","example":"test radius auth","description":"The description for this RADIUS authenticator.","maxLength":1024},"label":{"type":"string","example":"radius-auth-lablel","description":"The label for this RADIUS authenticator. It must be unique among all other RADIUS authenticators.","minLength":1,"maxLength":50},"passcode_label":{"type":"string","example":"test radius auth user passcode","description":"The label for the RADIUS authenticator passcode.","maxLength":20},"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":"#/definitions/RADIUSServerUpdateSpec"}},"user_name_label":{"type":"string","example":"test radius auth user","description":"The label for the RADIUS authenticator user name.","maxLength":20}},"title":"RADIUSAuthenticatorUpdateSpec","description":"Information required to update a RADIUS authenticator."},"RADIUSServerCreateSpec":{"type":"object","required":["accounting_port","authentication_port","authentication_type","hostname","max_attempts","server_timeout_seconds","shared_secret"],"properties":{"accounting_port":{"type":"integer","format":"int32","example":1813,"description":"The accounting port of the RADIUS authentication server."},"authentication_port":{"type":"integer","format":"int32","example":1812,"description":"The authentication port of the RADIUS authentication server. Radius servers should not have both hostname and authentication port same."},"authentication_type":{"type":"string","example":"PAP","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.","enum":["PAP","CHAP","MSCHAP1","MSCHAP2","UNKNOWN"]},"hostname":{"type":"string","example":"10.109.69.213","description":"The hostname of the RADIUS authentication server. Radius servers should not have both hostname and authentication port same."},"max_attempts":{"type":"integer","format":"int32","example":5,"description":"The maximum number of authentication attempts for the RADIUS authentication server.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"primary_radius_server":{"type":"boolean","example":true,"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."},"realm_prefix":{"type":"string","example":"test_realm_prefix","description":"The realm prefix of the RADIUS authentication server."},"realm_suffix":{"type":"string","example":"test_realm_suffix","description":"The realm suffix of the RADIUS authentication server."},"server_timeout_seconds":{"type":"integer","format":"int32","example":4,"description":"The server timeout (in seconds) of the RADIUS authentication server.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"shared_secret":{"type":"array","example":"","description":"The shared secret of the RADIUS authentication server.","items":{"type":"string"}}},"title":"RADIUSServerCreateSpec","description":"Information required to create a RADIUS authentication server."},"RADIUSServerInfo":{"type":"object","properties":{"accounting_port":{"type":"integer","format":"int32","example":1813,"description":"The accounting port of the RADIUS authentication server."},"authentication_port":{"type":"integer","format":"int32","example":1812,"description":"The authentication port of the RADIUS authentication server."},"authentication_type":{"type":"string","example":"PAP","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.","enum":["PAP","CHAP","MSCHAP1","MSCHAP2","UNKNOWN"]},"hostname":{"type":"string","example":"10.109.69.213","description":"The hostname of the RADIUS authentication server."},"max_attempts":{"type":"integer","format":"int32","example":5,"description":"The maximum number of authentication attempts for the RADIUS authentication server."},"primary_radius_server":{"type":"boolean","example":true,"description":"Indicates whether it is a primary RADIUS authentication server."},"realm_prefix":{"type":"string","example":"test_realm_prefix","description":"The realm prefix of the RADIUS authentication server."},"realm_suffix":{"type":"string","example":"test_realm_suffix","description":"The realm suffix of the RADIUS authentication server."},"server_timeout_seconds":{"type":"integer","format":"int32","example":4,"description":"The server timeout (in seconds) of the RADIUS authentication server."}},"title":"RADIUSServerInfo","description":"Information related to a RADIUS authentication server."},"RADIUSServerUpdateSpec":{"type":"object","required":["accounting_port","authentication_port","authentication_type","hostname","max_attempts","primary_radius_server","server_timeout_seconds","shared_secret"],"properties":{"accounting_port":{"type":"integer","format":"int32","example":1813,"description":"The accounting port of the RADIUS authentication server."},"authentication_port":{"type":"integer","format":"int32","example":1812,"description":"The authentication port of the RADIUS authentication server. Primary and secondary servers should not have both hostname and authentication port same."},"authentication_type":{"type":"string","example":"PAP","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.","enum":["PAP","CHAP","MSCHAP1","MSCHAP2","UNKNOWN"]},"hostname":{"type":"string","example":"10.109.69.213","description":"The hostname of the RADIUS authentication server. Primary and secondary servers should not have both hostname and authentication port same."},"max_attempts":{"type":"integer","format":"int32","example":5,"description":"The maximum number of authentication attempts for the RADIUS authentication server.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"primary_radius_server":{"type":"boolean","example":true,"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."},"realm_prefix":{"type":"string","example":"test_realm_prefix","description":"The realm prefix of the RADIUS authentication server."},"realm_suffix":{"type":"string","example":"test_realm_suffix","description":"The realm suffix of the RADIUS authentication server."},"server_timeout_seconds":{"type":"integer","format":"int32","example":4,"description":"The server timeout (in seconds) of the RADIUS authentication server.","minimum":1,"exclusiveMinimum":false,"exclusiveMaximum":false},"shared_secret":{"type":"array","example":"","description":"The shared secret of the RADIUS authentication server.","items":{"type":"string"}}},"title":"RADIUSServerUpdateSpec","description":"Information required to create a RADIUS authentication server."},"RCXClientRegisterSpec":{"type":"object","required":["name","thumbprints"],"properties":{"ip_address":{"type":"string","example":"127.0.0.1","description":"IP address of the RCX client."},"name":{"type":"string","example":"example.com","description":"The RCX client certificate name."},"thumbprints":{"type":"array","description":"Thumbprints of the RCX client certificate.","items":{"$ref":"#/definitions/CertificateThumbprint"}}},"title":"RCXClientRegisterSpec","description":"Specification of the RCX client."},"RCXClientUpdateSpec":{"type":"object","required":["thumbprints"],"properties":{"ip_address":{"type":"string","example":"127.0.0.1","description":"IP address of the RCX client."},"thumbprints":{"type":"array","description":"Thumbprints of the RCX client certificate.","items":{"$ref":"#/definitions/CertificateThumbprint"}}},"title":"RCXClientUpdateSpec","description":"Update specification for the RCX client."},"RCXServerInfo":{"type":"object","properties":{"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing RCX server."},"name":{"type":"string","example":"rcxserver.example.com","description":"FQDN/IP address of the RCX server."},"port":{"type":"integer","format":"int32","example":81,"description":"RCX server's port."},"status":{"type":"string","example":"UP","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.","enum":["UP","DOWN","UNKNOWN"]},"thumbprints":{"type":"array","description":"Thumbprints of the RCX server certificates.","items":{"$ref":"#/definitions/CertificateThumbprint"}},"version":{"type":"string","example":7.12,"description":"Version information of RCX server."}},"title":"RCXServerInfo","description":"Information related to RCX servers of the cluster."},"RDSHLoadBalancerSettingsCreateSpec":{"type":"object","properties":{"cpu_threshold":{"type":"integer","format":"int32","example":10,"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.","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_queue_length_threshold":{"type":"integer","format":"int32","example":15,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_read_latency_threshold":{"type":"integer","format":"int32","example":10,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_write_latency_threshold":{"type":"integer","format":"int32","example":15,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"include_session_count":{"type":"boolean","example":true,"description":"Indicates whether to include session count for load balancing. Default value is true when use_custom_script_for_load_balancing is false."},"memory_threshold":{"type":"integer","format":"int32","example":10,"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.","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"RDSHLoadBalancerSettingsCreateSpec","description":"RDSH load balancer settings for the farm."},"RDSHLoadBalancerSettingsCreateSpecV2":{"type":"object","properties":{"connecting_session_threshold":{"type":"integer","format":"int32","example":10,"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.","minimum":0,"maximum":150,"exclusiveMinimum":false,"exclusiveMaximum":false},"cpu_threshold":{"type":"integer","format":"int32","example":10,"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.","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_queue_length_threshold":{"type":"integer","format":"int32","example":15,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_read_latency_threshold":{"type":"integer","format":"int32","example":10,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_write_latency_threshold":{"type":"integer","format":"int32","example":15,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"include_session_count":{"type":"boolean","example":true,"description":"Indicates whether to include session count for load balancing. Default value is true when use_custom_script_for_load_balancing is false."},"load_index_threshold":{"type":"integer","format":"int32","example":20,"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.","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"memory_threshold":{"type":"integer","format":"int32","example":10,"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.","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"RDSHLoadBalancerSettingsCreateSpecV2","description":"RDSH load balancer settings for the farm."},"RDSHLoadBalancerSettingsInfo":{"type":"object","properties":{"cpu_threshold":{"type":"integer","format":"int32","example":10,"description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing."},"disk_queue_length_threshold":{"type":"integer","format":"int32","example":15,"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."},"disk_read_latency_threshold":{"type":"integer","format":"int32","example":10,"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. "},"disk_write_latency_threshold":{"type":"integer","format":"int32","example":15,"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."},"include_session_count":{"type":"boolean","example":true,"description":"Indicates whether to include session count for load balancing."},"memory_threshold":{"type":"integer","format":"int32","example":10,"description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. "}},"title":"RDSHLoadBalancerSettingsInfo","description":"RDSH load balancer settings for the farm."},"RDSHLoadBalancerSettingsInfoV2":{"type":"object","properties":{"connecting_session_threshold":{"type":"integer","format":"int32","example":10,"description":"Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions."},"cpu_threshold":{"type":"integer","format":"int32","example":10,"description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing."},"disk_queue_length_threshold":{"type":"integer","format":"int32","example":15,"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."},"disk_read_latency_threshold":{"type":"integer","format":"int32","example":10,"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. "},"disk_write_latency_threshold":{"type":"integer","format":"int32","example":15,"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."},"include_session_count":{"type":"boolean","example":true,"description":"Indicates whether to include session count for load balancing."},"load_index_threshold":{"type":"integer","format":"int32","example":20,"description":"Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions."},"memory_threshold":{"type":"integer","format":"int32","example":10,"description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. "}},"title":"RDSHLoadBalancerSettingsInfoV2","description":"RDSH load balancer settings for the farm."},"RDSHLoadBalancerSettingsUpdateSpec":{"type":"object","required":["cpu_threshold","disk_queue_length_threshold","disk_read_latency_threshold","disk_write_latency_threshold","include_session_count","memory_threshold"],"properties":{"cpu_threshold":{"type":"integer","format":"int32","example":10,"description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_queue_length_threshold":{"type":"integer","format":"int32","example":15,"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. ","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_read_latency_threshold":{"type":"integer","format":"int32","example":10,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_write_latency_threshold":{"type":"integer","format":"int32","example":15,"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. ","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"include_session_count":{"type":"boolean","example":true,"description":"Indicates whether to include session count for load balancing."},"memory_threshold":{"type":"integer","format":"int32","example":10,"description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. ","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"RDSHLoadBalancerSettingsUpdateSpec","description":"RDSH load balancer settings for the farm. This is required if use_custom_script_for_load_balancing is false."},"RDSHLoadBalancerSettingsUpdateSpecV2":{"type":"object","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"],"properties":{"connecting_session_threshold":{"type":"integer","format":"int32","example":10,"description":"Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions.","minimum":0,"maximum":150,"exclusiveMinimum":false,"exclusiveMaximum":false},"cpu_threshold":{"type":"integer","format":"int32","example":10,"description":"Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_queue_length_threshold":{"type":"integer","format":"int32","example":15,"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. ","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_read_latency_threshold":{"type":"integer","format":"int32","example":10,"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.","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"disk_write_latency_threshold":{"type":"integer","format":"int32","example":15,"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. ","minimum":0,"exclusiveMinimum":false,"exclusiveMaximum":false},"include_session_count":{"type":"boolean","example":true,"description":"Indicates whether to include session count for load balancing."},"load_index_threshold":{"type":"integer","format":"int32","example":20,"description":"Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions.","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"memory_threshold":{"type":"integer","format":"int32","example":10,"description":"Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing. ","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"RDSHLoadBalancerSettingsUpdateSpecV2","description":"RDSH load balancer settings for the farm."},"RDSServerInfo":{"type":"object","properties":{"access_group_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"The id of the Access Group that the RDS Server belongs to.
Supported Filters : 'Equals'."},"agent_build_number":{"type":"string","example":22673015,"description":"The Horizon Agent build number.
Supported Filters : 'Equals'."},"agent_version":{"type":"string","example":7.12,"description":"The Horizon Agent version.
Supported Filters : 'Equals'."},"base_vm_id":{"type":"string","example":"vm-23","description":"The base vm id.
Supported Filters : 'Equals'."},"base_vm_snapshot_id":{"type":"string","example":"snapshot-2","description":"The base vm snapshot id.
Supported Filters : 'Equals'."},"description":{"type":"string","example":"New RDS Server.","description":"Description of the RDS Server.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'."},"dns_name":{"type":"string","example":"machine1.example.com","description":"DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'."},"enabled":{"type":"boolean","example":true,"description":"Indicates if RDS server is enabled.
Supported Filters : 'Equals'."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"The id of the Farm that the RDS Server belongs to.
Supported Filters : 'Equals'."},"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing the RDS Server.
Supported Filters : 'Equals'."},"image_management_stream_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","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.
Supported Filters : 'Equals'."},"image_management_tag_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d","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.
Supported Filters : 'Equals'."},"load_index":{"type":"integer","format":"int32","example":60,"description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100."},"load_preference":{"type":"string","example":"NORMAL","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* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light 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.","enum":["BLOCK","HEAVY","NORMAL","LIGHT","UNKNOWN"]},"logoff_policy":{"type":"string","example":"FORCE_LOGOFF","description":"The user log off behavior at the time of maintenance.\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.","enum":["FORCE_LOGOFF","WAIT_FOR_LOGOFF"]},"max_sessions_count":{"type":"integer","format":"int32","example":123,"description":"Maximum number of sessions for RDS server as reported by the Horizon Agent. This will be unset if the value is not configured."},"max_sessions_count_configured":{"type":"integer","format":"int32","example":123,"description":"Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured."},"max_sessions_type":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED"]},"max_sessions_type_configured":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]},"message_security_enhanced_mode_supported":{"type":"boolean","example":true,"description":"Indicates whether ENHANCED message security mode is currently supported by this machine."},"message_security_mode":{"type":"string","example":"MIXED","description":"The current JMS message security mode used by this machine.
Supported Filters : 'Equals'.\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.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.","enum":["DISABLED","MIXED","ENABLED","ENHANCED"]},"name":{"type":"string","example":"server1","description":"Name of the RDS Server.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'."},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2012","description":"The machine operating system.\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\n* LINUX_SERVER_OTHER: Linux Server (other)","enum":["UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_SERVER_OTHER"]},"operation":{"type":"string","example":"REFRESH","description":"The current maintenance operation on the RDS Server.
Supported Filters : 'Equals'.\n* PUSH_IMAGE: A push image operation.\n* ARCHIVE: An archive operation.\n* TAGGING: A tagging operation.","enum":["PUSH_IMAGE","ARCHIVE","TAGGING"]},"operation_state":{"type":"string","example":"AVAILABLE","description":"The state of the current maintenance operation on the RDS Server.
Supported Filters : 'Equals'.\n* UNDEFINED: The operation state is unrecognized.\n* SCHEDULED: The operation is scheduled for future execution.\n* PROGRESSING: The operation is in progress.\n* COMPLETED: The operation has completed.\n* FAULT: The operation has encountered an error.\n* CANCELLING: The operation has been cancelled.\n* HOLDING: The operation has been paused.\n* CREATE: The operation is being initiated.\n* STANDBY: The operation is on standby for a selective resync.","enum":["UNDEFINED","SCHEDULED","PROGRESSING","COMPLETED","FAULT","CANCELLING","HOLDING","CREATE","STANDBY"]},"pending_base_vm_id":{"type":"string","example":"vm-8","description":"The pending base vm id.
Supported Filters : 'Equals'."},"pending_base_vm_snapshot_id":{"type":"string","example":"snapshot-7","description":"The pending base vm snapshot id.
Supported Filters : 'Equals'."},"pending_image_management_stream_id":{"type":"string","example":"ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25","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.
Supported Filters : 'Equals'."},"pending_image_management_tag_id":{"type":"string","example":"c9896e51-48a2-4d82-ae9e-a0246981b47d","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.
Supported Filters : 'Equals'."},"remote_experience_agent_build_number":{"type":"string","example":32573985,"description":"The remote experience Horizon Agent build number.
Supported Filters : 'Equals'."},"remote_experience_agent_version":{"type":"string","example":7.12,"description":"The remote experience Horizon Agent version.
Supported Filters : 'Equals'."},"session_count":{"type":"integer","format":"int32","example":35,"description":"RDS server session count.
Supported Filters : 'Equals'."},"state":{"type":"string","example":"AVAILABLE","description":"The state of the RDS server.
Supported Filters : 'Equals'.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\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* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* ERROR: An unknown error occurred in the RDS Server.\n* PROVISIONED: The RDS Server has been provisioned.\n* CONNECTED: The RDS Server is in an active session.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\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_ERR_DISABLED: The Horizon Agent is disabled.\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_DOMAIN_FAILURE: The RDS Server has an invalid domain.\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* ALREADY_USED: The RDS Server cannot accept new sessions.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* UNKNOWN: Could not determine the state of the RDS Server.","enum":["WAIT_FOR_AGENT","AGENT_UNREACHABLE","AGENT_CONFIG_ERROR","AVAILABLE","DISABLED","DISABLE_IN_PROGRESS","PROVISIONING","PROVISIONING_ERROR","CUSTOMIZING","DELETING","MAINTENANCE","ERROR","PROVISIONED","CONNECTED","DISCONNECTED","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERR_DISABLED","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_DOMAIN_FAILURE","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","ALREADY_USED","IN_PROGRESS","VALIDATING","UNKNOWN"]}},"title":"RDSServerInfo","description":"Information related to an RDS Server.
List API returning this summary information can use search filter query to filter on specific fields supported by filters.
Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports."},"RDSServerMonitorDetails":{"type":"object","properties":{"agent_build":{"type":"string","example":4445678,"description":"Agent build number."},"agent_version":{"type":"string","example":"7.9.0","description":"Agent version."},"max_sessions_count_configured":{"type":"integer","format":"int32","example":123,"description":"Maximum number of sessions for RDS server as configured by administrator. Will be unset if the value is not configured."},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2016","description":"Operating System version.\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\n* LINUX_SERVER_OTHER: Linux Server (other)","enum":["UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_SERVER_OTHER"]},"state":{"type":"string","example":"AVAILABLE","description":"State of RDS Server.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\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* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* ERROR: An unknown error occurred in the RDS Server.\n* PROVISIONED: The RDS Server has been provisioned.\n* CONNECTED: The RDS Server is in an active session.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\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_ERR_DISABLED: The Horizon Agent is disabled.\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_DOMAIN_FAILURE: The RDS Server has an invalid domain.\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* ALREADY_USED: The RDS Server cannot accept new sessions.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* UNKNOWN: Could not determine the state of the RDS Server.","enum":["WAIT_FOR_AGENT","AGENT_UNREACHABLE","AGENT_CONFIG_ERROR","AVAILABLE","DISABLED","DISABLE_IN_PROGRESS","PROVISIONING","PROVISIONING_ERROR","CUSTOMIZING","DELETING","MAINTENANCE","ERROR","PROVISIONED","CONNECTED","DISCONNECTED","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERR_DISABLED","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_DOMAIN_FAILURE","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","ALREADY_USED","IN_PROGRESS","VALIDATING","UNKNOWN"]}},"title":"RDSServerMonitorDetails","description":"Details of RDS Server."},"RDSServerMonitorInfo":{"type":"object","properties":{"details":{"description":"Server details of RDS Server.","$ref":"#/definitions/RDSServerMonitorDetails"},"enabled":{"type":"boolean","example":true,"description":"Indicates if RDS server is enabled."},"farm_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Indicates the Farm ID to which the RDS Server belongs to."},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the RDS server."},"load_index":{"type":"integer","format":"int32","example":60,"description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"load_preference":{"type":"string","example":"NORMAL","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* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light 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.","enum":["BLOCK","HEAVY","NORMAL","LIGHT","UNKNOWN"]},"name":{"type":"string","example":"rds-server.example.com","description":"RDS Server name."},"session_count":{"type":"integer","format":"int32","example":35,"description":"RDS server session count."},"status":{"type":"string","example":"OK","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.","enum":["OK","WARNING","ERROR","DISABLED"]}},"title":"RDSServerMonitorInfo","description":"RDS Server Monitor Information."},"RDSServerRegisterInfo":{"type":"object","properties":{"id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","description":"Unique ID representing the RDS Server."},"pairing_token":{"type":"string","example":"","description":"The pairing token for the RDS Server."}},"title":"RDSServerRegisterInfo","description":"RDS Server register response."},"RDSServerRegisterSpec":{"type":"object","required":["dns_name","operating_system"],"properties":{"description":{"type":"string","example":"New RDS Server","description":"An optional string to describe how and why this RDS Server was registered."},"dns_name":{"type":"string","example":"rdsserver1.example.com","description":"The DNS name for the RDS Server."},"farm_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"The farm to which the RDS Server will be added."},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2012","description":"The Operating System of the RDS Server.\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\n* LINUX_SERVER_OTHER: Linux Server (other)","enum":["UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_SERVER_OTHER"]}},"title":"RDSServerRegisterSpec","description":"Information required to register an RDS Server."},"RDSServerUpdateSpec":{"type":"object","required":["enabled","max_sessions_type_configured"],"properties":{"enabled":{"type":"boolean","example":true,"description":"Indicates if RDS server is enabled."},"max_sessions_count_configured":{"type":"integer","format":"int32","example":123,"description":"Maximum number of sessions for RDS server as configured by administrator."},"max_sessions_type_configured":{"type":"string","example":"LIMITED","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.","enum":["UNLIMITED","LIMITED","UNCONFIGURED"]}},"title":"RDSServerUpdateSpec","description":"Information required to update an RDS Server."},"RefreshToken":{"type":"object","required":["refresh_token"],"properties":{"refresh_token":{"type":"string","example":"","description":"Refresh Token to be used to get a new Access token."}},"title":"RefreshToken","description":"Refresh Token"},"ResourcePoolInfo":{"type":"object","properties":{"children":{"type":"array","description":"Child nodes of the resource pool.","items":{"$ref":"#/definitions/ResourcePoolInfo"}},"id":{"type":"string","example":"resgroup-1","description":"Unique ID representing the resource pool."},"name":{"type":"string","example":"RP1","description":"Resource pool name."},"path":{"type":"string","example":"/Datacenter/host/Cluster/Resources/RP1","description":"Resource pool path."},"type":{"type":"string","example":"RESOURCE_POOL","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.","enum":["HOST","CLUSTER","RESOURCE_POOL","OTHER"]}},"title":"ResourcePoolInfo","description":"Information related to resource pool."},"RestrictedClientData":{"type":"object","properties":{"type":{"type":"string","example":"WINDOWS","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.","enum":["WINDOWS","MAC","HTMLACCESS","LINUX","IOS","ANDROID","WINSTORE","CHROME","OTHER"]},"version":{"type":"string","example":7.5,"description":"Blocks versions of Horizon Client connections which are older than the specified version."}},"title":"RestrictedClientData","description":"Information related to Restricted Horizon Clients."},"RestrictedClientDataV2":{"type":"object","properties":{"block_specific_versions":{"type":"array","example":["3.5,4","4.0.1"],"description":"Blocks specific versions of Horizon Client connections.","items":{"type":"string"}},"type":{"type":"string","example":"WINDOWS","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.","enum":["WINDOWS","MAC","HTMLACCESS","LINUX","IOS","ANDROID","WINSTORE","CHROME","OTHER"]},"version":{"type":"string","example":7.5,"description":"Blocks versions of Horizon Client connections which are older than the specified version."},"warn_specific_versions":{"type":"array","example":["7.5,4","5.0.2"],"description":"Warns specific versions of Horizon Client connections.","items":{"type":"string"}}},"title":"RestrictedClientDataV2","description":"Information related to Restricted Horizon Clients."},"ResumeTaskSpec":{"type":"object","properties":{"retry_failed_vms":{"type":"boolean","example":true,"description":"Indicates whether to restart the task for virtual machines whose task status is in error state. Default value is false."},"stop_on_error":{"type":"boolean","example":false,"description":"Indicates whether to stop the task at first error. Default value is true."}},"title":"ResumeTaskSpec","description":"Information required for resuming a task."},"RoleCreateSpec":{"type":"object","required":["name","privileges"],"properties":{"description":{"type":"string","example":"Custom administrator role.","description":"Role description.","maxLength":400},"name":{"type":"string","example":"Custom","description":"Role name. This property must contain only alphanumerics, underscores, and dashes.","minLength":1,"maxLength":32},"privileges":{"type":"array","example":["VC_CONFIG_VIEW", "FEDERATED_LDAP_MANAGE","GLOBAL_CONFIG_MANAGEMENT"],"description":"Privileges for this role. When being created or updated, input non-selectable privileges are ignored. ","items":{"type":"string","enum":["ADMINISTRATOR","ADMINISTRATOR_VIEW","VC_CONFIG_VIEW","LOG_COLLECTION","FORENSICS","MANAGE_CERTIFICATES","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_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","UNKNOWN_PRIVILEGE"]}}},"title":"RoleCreateSpec","description":"Information required to create a role."},"RoleInfo":{"type":"object","properties":{"applies_to_federation_access_group":{"type":"boolean","example":true,"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."},"applies_to_local_access_group":{"type":"boolean","example":true,"description":"Specifies whether local access group is applicable for this role. This will be true when the role contains atleast one inventory specific privilege."},"built_in_role_type":{"type":"string","example":"INVENTORY_ADMIN","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.","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","example":"Administration users with rights for global and per Connection Server configuration settings.","description":"Role description."},"id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"Unique ID representing this role."},"name":{"type":"string","example":"Global Configuration and Policy Administrators","description":"Role name."},"permission_ids":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe","6fd4638a-381f-4518-aed6-042aa3d9f14c"],"description":"Administrative permissions (user/group and access group) for this role.","items":{"type":"string"}},"privileges":{"type":"array","example":["GLOBAL_ADMIN_UI_INTERACTIVE","GLOBAL_CONFIG_MANAGEMENT","GLOBAL_CONFIG_VIEW","GLOBAL_CVP_PUBLICATION"],"description":"Privileges for this role.","items":{"type":"string","enum":["ADMINISTRATOR","ADMINISTRATOR_VIEW","VC_CONFIG_VIEW","LOG_COLLECTION","FORENSICS","MANAGE_CERTIFICATES","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_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","UNKNOWN_PRIVILEGE"]}}},"title":"RoleInfo","description":"Information about role."},"RoleUpdateSpec":{"type":"object","required":["privileges"],"properties":{"description":{"type":"string","example":"Administration users with full administrative rights.","description":"Role description.","maxLength":400},"privileges":{"type":"array","example":["VC_CONFIG_VIEW", "FEDERATED_LDAP_MANAGE","GLOBAL_CONFIG_MANAGEMENT"],"description":"Privileges for this role. When being created or updated, input non-selectable privileges are ignored. ","items":{"type":"string","enum":["ADMINISTRATOR","ADMINISTRATOR_VIEW","VC_CONFIG_VIEW","LOG_COLLECTION","FORENSICS","MANAGE_CERTIFICATES","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_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","UNKNOWN_PRIVILEGE"]}}},"title":"RoleUpdateSpec","description":"Information required to update a role."},"SAMLAuthMonitorDetails":{"type":"object","properties":{"administrator_url":{"type":"string","example":"https://vidm.example.com/saas/api/1.0/GET/admindata","description":"The administrator URL for the SAML authenticator."},"label":{"type":"string","example":"vidm.example.com","description":"The label of the SAML Authenticator."},"metadata_url":{"type":"string","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml","description":"The metadata URL of the SAML Authenticator."}},"title":"SAMLAuthMonitorDetails","description":"Details of the SAML authenticator."},"SAMLAuthenticatorCreateSpec":{"type":"object","required":["authenticator_type","label"],"properties":{"administrator_url":{"type":"string","example":"https://vidm.example.com/saas/api/1.0/GET/admindata","description":"The administrator URL for this SAML authenticator. This must specify a protocol (scheme) of http or https."},"authenticator_type":{"type":"string","example":"DYNAMIC","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.","enum":["STATIC","DYNAMIC"]},"certificate":{"type":"string","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----","description":"SAML Authenticator certificate."},"certificate_type":{"type":"string","example":"PEM","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","enum":["PEM","UNKNOWN"]},"connection_server_ids":{"type":"array","example":["11bd230b-87ce-3306-a943-810affe7b68a", "aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b"],"description":"The list of Connection Servers for which this SAML authenticator is enabled.","items":{"type":"string"}},"description":{"type":"string","example":"Dynamic Saml Authenticator","description":"The description of this SAML authenticator."},"label":{"type":"string","example":"vidm.example.com","description":"The label for this SAML authenticator. It must be unique among all other SAML authenticators."},"metadata_url":{"type":"string","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml","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."},"password_mode":{"type":"string","example":"REMOVE","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.","enum":["REMOVE","PASSTHRU","ERROR"]},"static_metadata":{"type":"string","example":"","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."},"trigger_mode":{"type":"string","example":"DISABLED","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.","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]}},"title":"SAMLAuthenticatorCreateSpec","description":"Information required to create SAML authenticator."},"SAMLAuthenticatorInfo":{"type":"object","properties":{"administrator_url":{"type":"string","example":"https://vidm.example.com/saas/api/1.0/GET/admindata","description":"The administrator URL for the SAML authenticator."},"authenticator_type":{"type":"string","example":"DYNAMIC","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.","enum":["STATIC","DYNAMIC"]},"certificate":{"type":"string","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----","description":"SAML Authenticator certificate."},"certificate_type":{"type":"string","example":"PEM","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","enum":["PEM","UNKNOWN"]},"description":{"type":"string","example":"Dynamic Saml Authenticator","description":"The description of this SAML authenticator."},"id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"Unique ID representing this SAML Authenticator."},"label":{"type":"string","example":"vidm.example.com","description":"The label for this SAML authenticator."},"metadata_url":{"type":"string","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml","description":"The metadata URL of the SAML Authenticator."},"password_mode":{"type":"string","example":"REMOVE","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.","enum":["REMOVE","PASSTHRU","ERROR"]},"static_metadata":{"type":"string","example":"","description":"The static metadata of a SAML authenticator which contains an entity id, signing keys, and encryption keys for processing SAML authentication."},"trigger_mode":{"type":"string","example":"DISABLED","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.","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]}},"title":"SAMLAuthenticatorInfo","description":"Information about SAML Authenticator."},"SAMLAuthenticatorMonitorConnectionServer":{"type":"object","properties":{"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"OK","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.","enum":["OK","ERROR","WARN","UNKNOWN"]},"thumbprint_accepted":{"type":"boolean","example":false,"description":"Indicates if the thumbprint of the SAML authenticator was accepted."}},"title":"SAMLAuthenticatorMonitorConnectionServer","description":"Information about the SAML authenticator connection from a connection server."},"SAMLAuthenticatorMonitorConnectionServerV2":{"type":"object","properties":{"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"last_updated_timestamp":{"type":"integer","format":"int64","example":1582029025748,"description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time."},"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"OK","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.","enum":["OK","ERROR","WARN","UNKNOWN"]},"thumbprint_accepted":{"type":"boolean","example":false,"description":"Indicates if the thumbprint of the SAML authenticator was accepted."}},"title":"SAMLAuthenticatorMonitorConnectionServerV2","description":"Information about the SAML authenticator connection from a connection server."},"SAMLAuthenticatorMonitorInfo":{"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the SAML authenticator connections from each of the connection servers.","items":{"$ref":"#/definitions/SAMLAuthenticatorMonitorConnectionServer"}},"details":{"description":"Details about the SAML authenticator.","$ref":"#/definitions/SAMLAuthMonitorDetails"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the SAML Authenticator."}},"title":"SAMLAuthenticatorMonitorInfo","description":"Monitoring information related to SAML Authenticator."},"SAMLAuthenticatorMonitorInfoV2":{"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the SAML authenticator connections from each of the connection servers.","items":{"$ref":"#/definitions/SAMLAuthenticatorMonitorConnectionServerV2"}},"details":{"description":"Details about the SAML authenticator.","$ref":"#/definitions/SAMLAuthMonitorDetails"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the SAML Authenticator."}},"title":"SAMLAuthenticatorMonitorInfoV2","description":"Monitoring information related to SAML Authenticator."},"SAMLAuthenticatorServerSpec":{"type":"object","properties":{"administrator_url":{"type":"string","example":"https://vidm.example.com/SAAS/API/1.0/GET/admindata","description":"The administrator URL for the SAML authenticator."},"metadata_url":{"type":"string","example":"https://vidm.example.com/SAAS/API/1.0/GET/metadata/idp.xml","description":"The metadata URL of the SAML Authenticator."}},"title":"SAMLAuthenticatorServerSpec","description":"SAML Authenticator server Information."},"SAMLAuthenticatorUpdateSpec":{"type":"object","required":["label","trigger_mode"],"properties":{"administrator_url":{"type":"string","example":"https://vidm.example.com/saas/api/1.0/GET/admindata","description":"The administrator URL for this SAML authenticator. This must specify a protocol (scheme) of http or https."},"certificate":{"type":"string","example":"-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----","description":"SAML Authenticator certificate."},"certificate_type":{"type":"string","example":"PEM","description":"Type of Certificate.\n* PEM: PEM encoded certificate type\n* UNKNOWN: Unknown certificate type","enum":["PEM","UNKNOWN"]},"description":{"type":"string","example":"Dynamic Saml Authenticator","description":"The description of this SAML authenticator."},"label":{"type":"string","example":"vidm.example.com","description":"The label for this SAML authenticator. It must be unique among all other SAML authenticators."},"metadata_url":{"type":"string","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml","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."},"password_mode":{"type":"string","example":"REMOVE","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.","enum":["REMOVE","PASSTHRU","ERROR"]},"static_metadata":{"type":"string","example":"","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."},"trigger_mode":{"type":"string","example":"DISABLED","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.","enum":["DISABLED","ENABLE_IF_NO_PASSWORD","REQUIRE_IF_NO_PASSWORD","ENABLE_ALWAYS","REQUIRE_ALWAYS"]}},"title":"SAMLAuthenticatorUpdateSpec","description":"Information required to update SAML authenticator."},"SecurityConfigInfo":{"type":"object","properties":{"certificate_properties":{"description":"Certificate properties.","$ref":"#/definitions/CertificateProperties"},"connection_server_security_config":{"description":"Security configuration of connection server.","$ref":"#/definitions/SecurityConfiguration"},"secure_gateway_security_config":{"description":"Security configuration of secure gateway.","$ref":"#/definitions/SecurityConfiguration"}},"title":"SecurityConfigInfo","description":"Security configuration of connection server and secure gateway."},"SecurityConfiguration":{"type":"object","properties":{"client_properties":{"description":"Client properties of security configuration.","$ref":"#/definitions/ClientProperties"},"server_properties":{"description":"Server properties of security configuration.","$ref":"#/definitions/ServerProperties"}},"title":"SecurityConfiguration","description":"Client and server properties of Security configuration."},"SecurityGatewayData":{"type":"object","properties":{"address":{"type":"string","example":"127.0.0.1","description":"IP address of the security gateway. \nThis property need not be set.
Supported Filters : 'Equals'."},"domain_name":{"type":"string","example":"SECURE-GW.example.com","description":"Computer machine name or DNS name of the security gateway. \nThis property need not be set.
Supported Filters : 'Equals'."},"location":{"type":"string","example":"EXTERNAL","description":"Location of the security gateway. \nThis property need not be set.
Supported Filters : 'Equals'.\n* EXTERNAL: Gateway location is external.\n* INTERNAL: Gateway location is internal.\n* UNKNOWN: Gateway location is unknown.","enum":["EXTERNAL","INTERNAL","UNKNOWN"]}},"title":"SecurityGatewayData","description":"Security gateway data associated with the session."},"SecuritySettings":{"type":"object","properties":{"cluster_public_key":{"type":"string","example":"3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c","description":"The Base 64 encoded public key of the cluster in PEM format."},"cluster_public_key_id":{"type":"string","example":"cluster key","description":"Key Id to identify the cluster's active key pair."},"data_recovery_password_configured":{"type":"boolean","example":true,"description":"Indicates whether the backup recovery password has been configured."},"message_security_mode":{"type":"string","example":"ENABLED","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\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.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.","enum":["DISABLED","MIXED","ENABLED","ENHANCED"]},"message_security_status":{"type":"string","example":"NOTSET","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.","enum":["NOTSET","ENHANCED","WAITING_FOR_BUS_RESTARTS","PENDING_ENHANCED","LEAVING_ENHANCED","PREPARING_ENHANCED","DISABLED","MIXED","ENABLED"]},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","example":true,"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."}},"title":"SecuritySettings","description":"Information related to Security Settings."},"SecuritySettingsUpdateSpec":{"type":"object","required":["message_security_mode"],"properties":{"data_recovery_password_hash":{"type":"array","example":"5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8","description":"The SHA-256 hash of the (UTF-8) data recovery password.","items":{"type":"string"}},"data_recovery_password_hint":{"type":"string","example":"password hint","description":"The data recovery password hint. This property has a maximum length of 128 characters."},"message_security_mode":{"type":"string","example":"ENABLED","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\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.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.","enum":["DISABLED","MIXED","ENABLED","ENHANCED"]},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","example":true,"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."}},"title":"SecuritySettingsUpdateSpec","description":"Information related to Security Settings."},"SecuritySettingsV2":{"type":"object","properties":{"cluster_public_key":{"type":"string","example":"3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c","description":"The Base 64 encoded public key of the cluster in PEM format."},"cluster_public_key_id":{"type":"string","example":"cluster key","description":"Key Id to identify the cluster's active key pair."},"data_recovery_password_configured":{"type":"boolean","example":true,"description":"Indicates whether the backup recovery password has been configured."},"disallow_enhanced_security_mode":{"type":"boolean","example":true,"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. "},"message_security_mode":{"type":"string","example":"ENABLED","description":"Determines if signing and verification of the JMS messages passed between Horizon components takes place.\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.\n* ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.","enum":["DISABLED","MIXED","ENABLED","ENHANCED"]},"message_security_status":{"type":"string","example":"NOTSET","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.","enum":["NOTSET","ENHANCED","WAITING_FOR_BUS_RESTARTS","PENDING_ENHANCED","LEAVING_ENHANCED","PREPARING_ENHANCED","DISABLED","MIXED","ENABLED"]},"re_auth_secure_tunnel_after_interruption":{"type":"boolean","example":true,"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."}},"title":"SecuritySettingsV2","description":"Information related to Security Settings."},"ServerKeyDerivationInfo":{"type":"object","properties":{"client_reference_id":{"type":"string","example":"855ea6c5-720a-41e1-96f4-958c90e6e424","description":"Client reference identifier which is required to be passed as query param to login api, to enable decryption of encrypted sensitive information."},"identifier":{"type":"string","format":"byte","example":"QnJva2Vy","description":"Identifier as Base64 encoded binary data."},"proof":{"type":"string","format":"byte","example":"qck2eXsbiOpFJMGKEBzyPTidLwwCzsG8PgvyncQpeZU=","description":"Proof as Base64 encoded binary data."},"public_key":{"type":"string","format":"byte","example":"","description":"Diffie Hellman public key as Base64 encoded binary data."},"scheme":{"type":"string","example":"SCHEME-AES2","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.","enum":["SCHEME-AES1","SCHEME-AES2","SCHEME-EC-AES1","SCHEME-EC-AES2"]}},"title":"ServerKeyDerivationInfo","description":"Server key derivation information."},"ServerProperties":{"type":"object","properties":{"cipher_suites":{"type":"array","example":["TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256","TLS_RSA_WITH_AES_128_CBC_SHA256"],"description":"List of cipher suites of server.","items":{"type":"string"}},"named_groups":{"type":"array","example":["SECP384_R1","FFDHE_4096"],"description":"List of named groups of server.","items":{"type":"string"}},"signature_algorithms":{"type":"array","example":["RSA_PSS_RSAE_SHA512","RSA_PKCS1_SHA512", "RSA_PKCS1_SHA1"],"description":"List of signature algorithms of server.","items":{"type":"string"}},"thumbprint_algorithms":{"type":"array","example":["SHA_512","SHA_384"],"description":"List of thumbprint algorithms of server.","items":{"type":"string"}}},"title":"ServerProperties","description":"Server properties of Security configuration."},"ServerSpec":{"type":"object","properties":{"password":{"type":"array","example":"","description":"Password to use for the connection. This property is not required if the server is already added.","items":{"type":"string"}},"port":{"type":"integer","format":"int32","example":443,"description":"Port of the server to connect to."},"server_name":{"type":"string","example":"horizon.com","description":"Url of the server without the protocol prefix."},"username":{"type":"string","example":"administrator","description":"User name to use for the connection."}},"title":"ServerSpec","description":"Server information."},"ServiceAccount":{"type":"object","properties":{"owner_id":{"type":"string","example":"S-1-1-1-3965912346-1012345398-3123456564-123","description":"The owner of the service account."},"status":{"type":"string","example":"ACTIVE","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.","enum":["ACTIVE","ERROR","UNKNOWN"]},"username":{"type":"string","example":"USER1","description":"The username of the service account."}},"title":"ServiceAccount","description":"Service accounts for the domain."},"SessionInfo":{"type":"object","properties":{"access_group_id":{"type":"string","example":"6fd4638a-381f-4518-aed6-042aa3d9f14c","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.
Supported Filters : 'Equals'."},"agent_version":{"type":"string","example":"7.12.0","description":"Version of agent\nThis property need not be set.
Supported Filters : 'Equals'."},"application_names":{"type":"array","example":["Calculator"],"description":"Names of the applications launched in the session. \nIt will be only set when session_type is APPLICATION.
Supported Filters : 'Contains'.","items":{"type":"string"}},"broker_user_id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-500","description":"User SID for the broker user associated with the session. \nIt will be unset for non-broker sessions.
Supported Filters : 'Equals'."},"brokered_remotely":{"type":"boolean","example":false,"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.
Supported Filters : 'Equals'."},"client_data":{"description":"Client data associated with the session.","$ref":"#/definitions/ClientData"},"desktop_pool_id":{"type":"string","example":"0103796c-102b-4ed3-953f-3dfe3d23e0fe","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.
Supported Filters : 'Equals'."},"disconnected_time":{"type":"integer","format":"int64","example":1582181947320,"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.
Supported Filters : 'Equals'."},"farm_id":{"type":"string","example":"0dbd14ba-5795-4141-9cec-128ff6d494b0","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.
Supported Filters : 'Equals'."},"id":{"type":"string","example":"7cdd624f-37d1-46c1-ab96-695a5d13956f","description":"Unique id representing a session.
Supported Filters : 'Equals'."},"idle_duration":{"type":"integer","format":"int64","example":60,"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.
Supported Filters : 'Equals'."},"last_session_duration_ms":{"type":"integer","format":"int64","example":116320,"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.
Supported Filters : 'Equals'."},"machine_id":{"type":"string","example":"a00eda55-708a-4f7d-8cbc-1d1b3a2b5f73","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.
Supported Filters : 'Equals'."},"rds_server_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique RDS server id for the RDS desktop or application session.\nThis property need not be set.
Supported Filters : 'Equals'."},"resourced_remotely":{"type":"boolean","example":false,"description":"Indicates whether the session is running on remote pod resource.
Supported Filters : 'Equals'."},"security_gateway_data":{"description":"Security gateway data associated with the session.","$ref":"#/definitions/SecurityGatewayData"},"session_protocol":{"type":"string","example":"PCOIP","description":"Protocol for the session. \nIt will be unset for disconnected sessions.
Supported Filters : 'Equals'.\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* UNKNOWN: Display protocol is unknown.","enum":["PCOIP","RDP","BLAST","CONSOLE","UNKNOWN"]},"session_state":{"type":"string","example":"CONNECTED","description":"State of session.
Supported Filters : 'Equals', 'NotEquals'.\n* CONNECTED: Session is connected\n* DISCONNECTED: Session is disconnected\n* PENDING: Session is pending","enum":["CONNECTED","DISCONNECTED","PENDING"]},"session_type":{"type":"string","example":"APPLICATION","description":"Type of session.
Supported Filters : 'Equals'.\n* DESKTOP: Desktop or RDS desktop session.\n* APPLICATION: Application session.","enum":["DESKTOP","APPLICATION"]},"start_time":{"type":"integer","format":"int64","example":1582181831000,"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.
Supported Filters : 'Equals'."},"unauthenticated":{"type":"boolean","example":false,"description":"Indicates whether the session is of unauthenticated access user. \nThis property need not be set.
Supported Filters : 'Equals'."},"user_id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-500","description":"Unique SID of the user logged into the session. \nIt may not match the broker user id for non-SSO scenarios.
Supported Filters : 'Equals'."}},"title":"SessionInfo","description":"Information related to Session.
Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.
See the field description to know the filter types it supports."},"SessionSendMessageSpec":{"type":"object","required":["message","message_type","session_ids"],"properties":{"message":{"type":"string","example":"Sample Info Message","description":"Message to be sent to session(s)."},"message_type":{"type":"string","example":"INFO","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.","enum":["ERROR","WARNING","INFO"]},"session_ids":{"type":"array","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"description":"List of session ids to which message is to be sent","items":{"type":"string"}}},"title":"SessionSendMessageSpec","description":"Information required to send message to sessions."},"SettingsInfo":{"type":"object","properties":{"feature_settings":{"description":"Settings related to specific features.","$ref":"#/definitions/FeatureSettings"},"general_settings":{"description":"General settings determine session time-out lengths, status updates in Horizon Console, and whether prelogin and warning messages are displayed.","$ref":"#/definitions/GeneralSettings"},"security_settings":{"description":"Security settings determine whether Horizon clients are reauthenticated after interruptions, message security mode is enabled and SSO is used for local resource operations.","$ref":"#/definitions/SecuritySettings"}},"title":"SettingsInfo","description":"Information related to Settings."},"SettingsInfoV2":{"type":"object","properties":{"feature_settings":{"description":"Settings related to specific features.","$ref":"#/definitions/FeatureSettings"},"general_settings":{"description":"General settings determine session time-out lengths, status updates in Horizon Console, and whether prelogin and warning messages are displayed.","$ref":"#/definitions/GeneralSettingsV2"},"security_settings":{"description":"Security settings determine whether Horizon clients are reauthenticated after interruptions, message security mode is enabled and SSO is used for local resource operations.","$ref":"#/definitions/SecuritySettingsV2"}},"title":"SettingsInfoV2","description":"Information related to Settings."},"SettingsInfoV3":{"type":"object","properties":{"feature_settings":{"description":"Settings related to specific features.","$ref":"#/definitions/FeatureSettings"},"general_settings":{"description":"General settings determine session time-out lengths, status updates in Horizon Console, and whether prelogin and warning messages are displayed.","$ref":"#/definitions/GeneralSettingsV3"},"security_settings":{"description":"Security settings determine whether Horizon clients are reauthenticated after interruptions, message security mode is enabled and SSO is used for local resource operations.","$ref":"#/definitions/SecuritySettingsV2"}},"title":"SettingsInfoV3","description":"Information related to Settings."},"SettingsUpdateSpec":{"type":"object","properties":{"feature_settings":{"description":"Settings related to specific features.","$ref":"#/definitions/FeatureSettingsUpdateSpec"},"general_settings":{"description":"General settings determine session time-out lengths, status updates in Horizon Console, and whether prelogin and warning messages are displayed.","$ref":"#/definitions/GeneralSettingsUpdateSpec"},"security_settings":{"description":"Security settings determine whether Horizon clients are reauthenticated after interruptions, message security mode is enabled, IPSec is used for security server connections, and SSO is used for local resource operations.","$ref":"#/definitions/SecuritySettingsUpdateSpec"}},"title":"SettingsUpdateSpec","description":"Update specification for the configuration settings."},"SettingsUpdateSpecV2":{"type":"object","properties":{"feature_settings":{"description":"Settings related to specific features.","$ref":"#/definitions/FeatureSettingsUpdateSpec"},"general_settings":{"description":"General settings determine session time-out lengths, status updates in Horizon Console, and whether prelogin and warning messages are displayed.","$ref":"#/definitions/GeneralSettingsUpdateSpecV2"},"security_settings":{"description":"Security settings determine whether Horizon clients are reauthenticated after interruptions, message security mode is enabled, IPSec is used for security server connections, and SSO is used for local resource operations.","$ref":"#/definitions/SecuritySettingsUpdateSpec"}},"title":"SettingsUpdateSpecV2","description":"Update specification for the configuration settings."},"SettingsUpdateSpecV3":{"type":"object","properties":{"feature_settings":{"description":"Settings related to specific features.","$ref":"#/definitions/FeatureSettingsUpdateSpec"},"general_settings":{"description":"General settings determine session time-out lengths, status updates in Horizon Console, and whether prelogin and warning messages are displayed.","$ref":"#/definitions/GeneralSettingsUpdateSpecV3"},"security_settings":{"description":"Security settings determine whether Horizon clients are reauthenticated after interruptions, message security mode is enabled, IPSec is used for security server connections, and SSO is used for local resource operations.","$ref":"#/definitions/SecuritySettingsUpdateSpec"}},"title":"SettingsUpdateSpecV3","description":"Update specification for the configuration settings."},"SiteCreateSpec":{"type":"object","required":["name"],"properties":{"description":{"type":"string","example":"This is US site","description":"Detailed description of the site."},"name":{"type":"string","example":"US Site","description":"The name of the site."}},"title":"SiteCreateSpec","description":"Information required to create a site."},"SiteInfo":{"type":"object","properties":{"description":{"type":"string","example":"This is US site","description":"Detailed description of the site."},"id":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","description":"Unique ID representing the site."},"name":{"type":"string","example":"US Site","description":"Name of the site."},"pods":{"type":"array","example":["c617fd51-e118-4cae-970c-54a7144aaadc", "bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"],"description":"Member pods for this site.","items":{"type":"string"}}},"title":"SiteInfo","description":"Information related to sites in a pod federation."},"SiteUpdateSpec":{"type":"object","required":["name"],"properties":{"description":{"type":"string","example":"This is US site","description":"Detailed description of the site."},"name":{"type":"string","example":"US Site","description":"The name of the site."}},"title":"SiteUpdateSpec","description":"Information required to update a site."},"SmartCardAuthTokens":{"type":"object","properties":{"access_token":{"type":"string","example":"","description":"Access Token to be used in API calls."},"domain":{"type":"string","example":"AD-TEST-DOMAIN","description":"Domain"},"refresh_token":{"type":"string","example":"","description":"Refresh Token to be used to get a new Access token."},"user_name":{"type":"string","example":"Administrator","description":"User Name"}},"title":"SmartCardAuthTokens","description":"Smart card authentication tokens."},"SpecifiedNamesValidationInfo":{"type":"object","properties":{"machine_name":{"type":"string","example":"Machine-002-jdoe","description":"The virtual machine name."},"specified_names_statuses":{"type":"array","example":"VM_NAME_TOO_LONG","description":"The status information captured after validation.","items":{"type":"string","enum":["SUCCESS","VM_NAME_TOO_LONG","INVALID_VM_NAME","DUPLICATE_VM_NAME","INVALID_USER_NAME","DUPLICATE_USER_NAME"]}},"user_id":{"type":"string","example":"S-1-5-21-3711839221-3344336616-3511462156-1117","description":"The SID of the user."},"user_name":{"type":"string","example":"abcorp.com\\jdoe","description":"The name of the user entitled to the VM."}},"title":"SpecifiedNamesValidationInfo","description":"Information about specified names validation."},"SpecifiedNamesValidationSpec":{"type":"object","required":["names_spec"],"properties":{"dedicated":{"type":"boolean","example":false,"description":"Indicates whether desktop pool is dedicated or floating. Default value is false."},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","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."},"names_spec":{"type":"array","description":"List of manually defined virtual machines and users.","items":{"$ref":"#/definitions/NamesSpec"}}},"title":"SpecifiedNamesValidationSpec","description":"Information required to validate specified names."},"StartsWithFilter":{"title":"StartsWithFilter","allOf":[{"$ref":"#/definitions/BaseFilter"},{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["And","Or","Not","NotEquals","Equals","Contains","StartsWith","EndsWith","Between"]},"value":{"type":"object"}},"title":"StartsWithFilter"}]},"StorageAcceleratorData":{"type":"object","properties":{"default_cache_size_mb":{"type":"integer","format":"int32","example":1024,"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. "},"enabled":{"type":"boolean","example":false,"description":"Is View Storage Accelerator enabled? This property has a default value of false."},"host_overrides":{"type":"array","description":"Cache size overrides for hosts which support View Storage Accelerator.","items":{"$ref":"#/definitions/HostOverrideData"}}},"title":"StorageAcceleratorData","description":"Information about the Storage Accelerator Data"},"TaskInfo":{"type":"object","properties":{"category":{"type":"string","example":"POD_FEDERATION_CATEGORY","description":"The category of the task.\n* POD_FEDERATION_CATEGORY: Category for PodFederation related tasks.","enum":["POD_FEDERATION_CATEGORY"]},"id":{"type":"string","example":"a219420d-4799-4517-8f78-39c74c7c4efc","description":"Unique ID representing the task."},"percentage_complete":{"type":"integer","format":"int32","example":80,"description":"The amount of task completed, in percentage."},"result":{"description":"The result of a task, only available when task is completed.","$ref":"#/definitions/TaskResult"},"status":{"type":"string","example":"COMPLETED","description":"The state of the task.\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.","enum":["RUNNING","WAITING","COMPLETED","FAILED","PAUSED","CANCELLED"]},"type":{"type":"string","example":"POD_FEDERATION_INITIALIZING","description":"The type of the task.\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.","enum":["POD_FEDERATION_INITIALIZING","POD_FEDERATION_UNINITIALIZING","POD_FEDERATION_JOINING","POD_FEDERATION_UNJOINING"]}},"title":"TaskInfo","description":"Information related to CPA tasks."},"TaskResult":{"type":"object","properties":{"message":{"type":"string","example":"PodFederation initialization completed.","description":"The result message."},"message_id":{"type":"string","example":"POD_FEDERATION_INIT_SUCCESS.","description":"The result message ID."},"result_code":{"type":"string","example":"SUCCESS","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.","enum":["SUCCESS","WARN","ERROR"]}},"title":"TaskResult","description":"Information about a task result."},"TrueSSOCertificateDomainInfo":{"type":"object","properties":{"certificate_servers":{"type":"array","description":"Collection of certificate server data available to this domain.","items":{"$ref":"#/definitions/TrueSSOCertificateServerInfo"}},"dns_name":{"type":"string","example":"az.example.com","description":"DNS name of the domain."},"domain_id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"Id of the domain."},"domain_status":{"type":"string","example":"READY","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.","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","example":"VALID","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.","enum":["VALID","NOT_VALID"]},"forest_dns_name":{"type":"string","example":"example.com","description":"DNS name of the domain's forest, if any."},"replication_status":{"type":"string","example":"OK","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.","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":"#/definitions/TrueSSOTemplateInfo"}}},"title":"TrueSSOCertificateDomainInfo","description":"Domain data available to this enrollment server."},"TrueSSOCertificateServerInfo":{"type":"object","properties":{"certificate_server_name":{"type":"string","example":"pod07-POD07-CA1-CA","description":"Unique (common) name of this certificate server."},"certificate_server_network_address":{"type":"string","example":"POD07-CA1.pod07.example.com","description":"DNS name network address of this certificate server."},"certificate_status":{"type":"string","example":"VALID","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.","enum":["VALID","NOT_YET_VALID","UNKNOWN","INVALID","EXPIRED","NOT_TRUSTED"]},"connection_status":{"type":"string","example":"CONNECTED","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.","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","example":["TrueSso2","TrueSso1","TrueSsoTemplate"],"description":"Collection of certificate template names available to this certificate server.","items":{"type":"string"}}},"title":"TrueSSOCertificateServerInfo","description":"Certificate server data available to this domain. "},"TrueSSOEnrollmentServerInfo":{"type":"object","properties":{"connector_ids":{"type":"array","example":["42e47f15-aad0-221a-b231-ea4a3a134ec9", "d0325b13-2bf1-4fa4-b027-e780004f2d1e"],"description":"TrueSSO connectors, if any, associated with this enrollment server.","items":{"type":"string"}},"domains":{"type":"array","description":"Collection of domain data available to this enrollment server.","items":{"$ref":"#/definitions/TrueSSOCertificateDomainInfo"}},"id":{"type":"string","example":"42e47f15-aad0-221a-b231-ea4a3a134ec9","description":"Unique ID representing this TrueSSO Enrollment Server."},"name":{"type":"string","example":"pod07-es1.pod07.example.com","description":"Name of this enrollment server."},"network_address":{"type":"string","example":"pod07-es1.pod07.example.com","description":"DNS name network address of this enrollment server."},"status":{"type":"string","example":"ONLINE","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.","enum":["ONLINE","OFFLINE"]},"version":{"type":"string","example":1.0,"description":"Version number of this enrollment server."}},"title":"TrueSSOEnrollmentServerInfo","description":"Information about TrueSSO Enrollment Server."},"TrueSSOMonitorInfo":{"type":"object","properties":{"ad_domain_dns_name":{"type":"string","example":"ad-domain.example.com","description":"The DNS name of the domain."},"ad_domain_id":{"type":"string","example":"S-1-5-21-1085031214-1563985344-725345543","description":"Unique SID of the AD Domain."},"ad_domain_status":{"type":"string","example":"OK","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.","enum":["OK","WARN","ERROR"]},"certificate_server_details":{"type":"array","description":"Details of each certificate server.","items":{"$ref":"#/definitions/CertificateServerDetails"}},"enabled":{"type":"boolean","example":true,"description":"Indicates if the True SSO connector is enabled."},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the True SSO Connector."},"name":{"type":"string","example":"true-sso.example.com","description":"True SSO connector name."},"primary_enrollment_server":{"description":"The primary enrollment server details.","$ref":"#/definitions/EnrollmentServerDetails"},"secondary_enrollment_server":{"description":"The secondary enrollment server details.","$ref":"#/definitions/EnrollmentServerDetails"},"status":{"type":"string","example":"OK","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.","enum":["OK","WARN","ERROR"]},"template_name":{"type":"string","example":"TrueSSO Template","description":"Unique name for the True SSO template."},"template_status":{"type":"string","example":"OK","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.","enum":["OK","WARN","ERROR"]}},"title":"TrueSSOMonitorInfo","description":"Monitoring information related to the True SSO Connector."},"TrueSSOTemplateInfo":{"type":"object","properties":{"hash_algorithm":{"type":"string","example":"SHA_256","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.","enum":["SHA1","SHA256","SHA384","SHA512"]},"minimum_key_length":{"type":"integer","format":"int32","example":2048,"description":"Minimum key-length of the private/public key associated with the certificate."},"template_name":{"type":"string","example":"TrueSsoTemplate","description":"Unique name for this template."},"template_status":{"type":"string","example":"SUPPORTED_OPTIMAL","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.","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","format":"int64","example":36000000000,"description":"Length of time, in seconds, that certificates issues with this template remain valid."}},"title":"TrueSSOTemplateInfo","description":"Certificate template data available to certificate servers on this domain."},"UnauthenticatedAccessUserCreateSpec":{"type":"object","required":["user_id"],"properties":{"alias_name":{"type":"string","example":"unauthenticated-user","description":"Alias to be used for login from client.\nIf unset, AD login name of the user would be used."},"description":{"type":"string","example":"example description","description":"Description of the unauthenticated access user."},"hybrid_logon_mode":{"type":"string","example":"PASSWORD","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.","enum":["PASSWORD","TRUESSO","DISABLED"]},"hybrid_logon_password":{"type":"array","example":"password","description":"Password for the user for hybrid logon.\nThis is required when hybrid_logon_mode is set to PASSWORD.","items":{"type":"string"}},"user_id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-500","description":"SID of the user for whom unauthenticated access is to be configured."}},"title":"UnauthenticatedAccessUserCreateSpec","description":"Information required to create unauthenticated access user."},"UnauthenticatedAccessUserInfo":{"type":"object","properties":{"alias_name":{"type":"string","example":"unauthenticated-user","description":"Alias used for login from client."},"description":{"type":"string","example":"example description","description":"Description of the unauthenticated access user."},"hybrid_logon_mode":{"type":"string","example":"TRUESSO","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.","enum":["PASSWORD","TRUESSO","DISABLED"]},"id":{"type":"string","example":"11bd230b-87ce-3306-a943-810affe7b68a","description":"ID of the unauthenticated access configuration for the user."},"source_pod_ids":{"type":"array","example":["310927ee-1195-44c3-b877-5b194b4b4ea8", "78669598-45b6-44a3-aa0d-11b16d45ab73"],"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.","items":{"type":"string"}},"user_id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-500","description":"SID of the user for whom unauthenticated access is configured."}},"title":"UnauthenticatedAccessUserInfo","description":"Information related to Unauthenticated Access User."},"UserOrGroupLocalSummaryInfo":{"type":"object","properties":{"application_entitlements":{"type":"array","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"description":"Local application entitlements for this user or group.","items":{"type":"string"}},"application_local_session_ids":{"type":"array","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"description":"Ids for local application sessions for this user.","items":{"type":"string"}},"application_pool_ids":{"type":"array","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"description":"Local application IDs for which this user has an entitlement.","items":{"type":"string"}},"container":{"type":"string","example":"example.com/Users","description":"AD container for this user or group."},"description":{"type":"string","example":"Test User account","description":"Description number of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'."},"desktop_entitlements":{"type":"array","example":["S-1-1-1-3965912346-1012345398-3123456564-123"],"description":"Local desktop entitlements for this user or group.","items":{"type":"string"}},"desktop_local_session_ids":{"type":"array","example":["7cdd624f-37d1-46c1-ab96-695a5d13956f"],"description":"Ids for local desktop sessions for this user.","items":{"type":"string"}},"desktop_pool_ids":{"type":"array","example":["0103796c-102b-4ed3-953f-3dfe3d23e0fe"],"description":"Local desktop IDs for which this user has an entitlement.","items":{"type":"string"}},"display_name":{"type":"string","example":"example.com\\\\testuser","description":"Login name with domain of this user or group."},"distinguished_name":{"type":"string","example":"CN=Test User,CN=Users,DC=example,DC=com","description":"Active Directory distinguished name for this user or group."},"domain":{"type":"string","example":"example.com","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."},"email":{"type":"string","example":"testuser@example.com","description":"Email address of this user or group.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'."},"first_name":{"type":"string","example":"Test","description":"First name of this user or group."},"group":{"type":"boolean","example":false,"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."},"held_user":{"type":"boolean","example":false,"description":"Indicates if this user is a \"held user\".\nSupported Filters : 'Equals'."},"id":{"type":"string","example":"S-1-5-21-1111111111-2222222222-3333333333-500","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."},"kiosk_user":{"type":"boolean","example":false,"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."},"last_name":{"type":"string","example":"User","description":"Last name of this user or group."},"login_name":{"type":"string","example":"testuser","description":"Login name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'."},"long_display_name":{"type":"string","example":"testuser@example.com (Test User)","description":"Login name, domain and name for this user or group, else display name"},"machine_ids":{"type":"array","example":["0223796c-102b-4ed3-953f-3dfe3d23e1de"],"description":"Machines this user or group is assigned to.","items":{"type":"string"}},"name":{"type":"string","example":"Test User","description":"Name of this user or group.\n Supported Filters : 'Equals', 'StartsWith', 'Contains'."},"phone":{"type":"string","example":"1-877-486-9273","description":"Phone number of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'."},"unauthenticated_access_user":{"type":"boolean","example":false,"description":"Whether or not this is unauthenticated access user."},"user_display_name":{"type":"string","example":"Test User","description":"User or group's display name. This corresponds with displayName attribute in AD."},"user_principal_name":{"type":"string","example":"testuser@example.com","description":"User Principal name(UPN) of this user.\nSupported Filters : 'Equals', 'StartsWith', 'Contains'."}},"title":"UserOrGroupLocalSummaryInfo","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."},"VCLimits":{"type":"object","properties":{"instant_clone_engine_provisioning_limit":{"type":"integer","format":"int32","example":20,"description":"Maximum concurrent instant clone engine provisioning operations. This property has a default value of 20. This property has a minimum value of 1."},"power_operations_limit":{"type":"integer","format":"int32","example":50,"description":"Maximum concurrent virtual center power operations. This property has a default value of 50. This property has a minimum value of 1."},"provisioning_limit":{"type":"integer","format":"int32","example":20,"description":"Maximum concurrent virtual center provisioning operations. This property has a default value of 20. This property has a minimum value of 1."}},"title":"VCLimits","description":"Information about the limits configured for Virtual Center"},"VCMonitorConnectionServer":{"type":"object","properties":{"certificate":{"description":"The certificate data.","$ref":"#/definitions/CertificateMonitorInfo"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"OK","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.","enum":["OK","DOWN","RECONNECTING","UNKNOWN","INVALID_CREDENTIALS","CANNOT_LOGIN","NOT_YET_CONNECTED"]},"thumbprint_accepted":{"type":"boolean","example":true,"description":"Indicates if the thumbprints of the Virtual Center was accepted."}},"title":"VCMonitorConnectionServer","description":"Information about connection to Virtual Center from Connection Server."},"VCMonitorConnectionServerV2":{"type":"object","properties":{"certificate":{"description":"The certificate data.","$ref":"#/definitions/CertificateMonitorInfo"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"last_updated_timestamp":{"type":"integer","format":"int64","example":1582029025748,"description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time."},"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"OK","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.","enum":["OK","DOWN","RECONNECTING","UNKNOWN","INVALID_CREDENTIALS","CANNOT_LOGIN","NOT_YET_CONNECTED"]},"thumbprint_accepted":{"type":"boolean","example":true,"description":"Indicates if the thumbprints of the Virtual Center was accepted."}},"title":"VCMonitorConnectionServerV2","description":"Information about connection to Virtual Center from Connection Server."},"VCMonitorDatastore":{"type":"object","properties":{"capacity_mb":{"type":"integer","format":"int32","example":12345,"description":"The capacity of the datastore in megabytes."},"details":{"description":"Details about the datastore.","$ref":"#/definitions/VCMonitorDatastoreDetails"},"free_space_mb":{"type":"integer","format":"int32","example":12345,"description":"The free space on the datastore in megabytes."},"status":{"type":"string","example":"ACCESSIBLE","description":"Status of the datastore.\n* ACCESSIBLE: The datastore is accessible.\n* NOT_ACCESSIBLE: The datastore is not accessible.","enum":["ACCESSIBLE","NOT_ACCESSIBLE"]},"type":{"type":"string","example":"VSAN","description":"Type of the datastore.\n* VMFS: VMFS datastore.\n* VSAN: VSAN datastore.\n* VVOL: VVOL datastore.","enum":["VMFS","VSAN","VVOL"]}},"title":"VCMonitorDatastore","description":"Information about the datastore of the host(s) connected to the given Virtual Center."},"VCMonitorDatastoreDetails":{"type":"object","properties":{"name":{"type":"string","example":"vsandatastore","description":"Datastore name."},"path":{"type":"string","example":"/datacenter1/vsandatastore","description":"Path to the datastore."},"url":{"type":"string","example":"ds:///vmfs/volumes/vsan:52654c2aa8e79416-8ea7a3309e82c7b7/","description":"Unique locator for datastore."}},"title":"VCMonitorDatastoreDetails","description":"Details about the datastore."},"VCMonitorDetails":{"type":"object","properties":{"api_version":{"type":"string","example":6.5,"description":"API Version of the Virtual Center."},"build":{"type":"string","example":"12345678.0.1","description":"Build number of the Virtual Center."},"version":{"type":"string","example":"6.5.0","description":"Version of the Virtual Center."}},"title":"VCMonitorDetails","description":"Details about the Virtual Center."},"VCMonitorHost":{"type":"object","properties":{"cpu_core_count":{"type":"integer","format":"int32","example":16,"description":"Number of physical CPU cores on the host."},"cpu_mhz":{"type":"integer","format":"int32","example":2194,"description":"CPU speed per core in Mhz. This might be an averaged value if the speed is not uniform across all cores."},"details":{"description":"Details of the ESX Host.","$ref":"#/definitions/VCMonitorHostDetails"},"memory_size_mb":{"type":"integer","format":"int32","example":12345,"description":"The physical memory size in mega bytes."},"status":{"type":"string","example":"CONNECTED","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.","enum":["CONNECTED","DISCONNECTED","NOT_RESPONDING"]}},"title":"VCMonitorHost","description":"Information about the host connected to a Virtual Center."},"VCMonitorHostDetails":{"type":"object","properties":{"api_version":{"type":"string","example":6.5,"description":"API Version of the ESX Host."},"cluster_name":{"type":"string","example":"cluster-1","description":"Name of the cluster of the ESX Host in the Virtual Center."},"name":{"type":"string","example":"host1.example.com","description":"ESX Host name or IP address."},"version":{"type":"string","example":"6.5.0","description":"ESX Host version."},"vgpu_types":{"type":"array","description":"Types of vGPUs supported by this host.","items":{"type":"string"}}},"title":"VCMonitorHostDetails","description":"Details of the ESX host of the Virtual Center."},"VMFolderInfo":{"type":"object","properties":{"children":{"type":"array","example":[],"description":"Child nodes of the VM folder.","items":{"$ref":"#/definitions/VMFolderInfo"}},"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter id for this VM folder."},"id":{"type":"string","example":"group-v1","description":"Unique ID representing the VM folder."},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this VM folder from being used in desktop pool or farm.","items":{"type":"string","enum":["IN_USE","REPLICA_FOLDER"]}},"name":{"type":"string","example":"Discovered virtual machine","description":"VM folder name."},"path":{"type":"string","example":"/Datacenter/vm/Discovered virtual machine","description":"VM folder path."},"type":{"type":"string","example":"FOLDER","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.","enum":["DATACENTER","FOLDER","OTHER"]},"vcenter_id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Virtual Center id for this VM folder."}},"title":"VMFolderInfo","description":"Information related to VM folder."},"VMTemplateInfo":{"type":"object","properties":{"datacenter_id":{"type":"string","example":"datacenter-1","description":"Datacenter id for this VM template."},"disk_size_in_bytes":{"type":"integer","format":"int64","example":42949672960,"description":"Sum of capacities of all the virtual disks in the template, in bytes."},"id":{"type":"string","example":"vm-1","description":"Unique ID representing a VM template."},"incompatible_reasons":{"type":"array","description":"Reasons that may preclude this VM template from being used in full clone desktop pool creation.","items":{"type":"string","enum":["UNSUPPORTED_OS"]}},"memory_mb":{"type":"integer","format":"int32","example":4096,"description":"Memory size of the VM template, in MB"},"name":{"type":"string","example":"Win10Template","description":"VM template name."},"operating_system":{"type":"string","example":"WINDOWS_10","description":"Operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"operating_system_display_name":{"type":"string","example":"Microsoft Windows 10 (64-bit)","description":"Operating system display name from Virtual Center."},"path":{"type":"string","example":"/Datacenter/vm/Templates/Win10Template","description":"VM template path."},"vcenter_id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"ID of the vCenter to which this VM template belongs to."},"vgpu_type":{"type":"string","description":"NVIDIA GRID vGPU type configured on this VM template."}},"title":"VMTemplateInfo","description":"Information related to VM template."},"ViewComposerMonitorConnectionServer":{"type":"object","properties":{"certificate":{"description":"Information related to certificate.","$ref":"#/definitions/CertificateMonitorInfo"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"OK","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.","enum":["OK","MALFORMED_URL","ERROR","CERT_ERROR"]},"thumbprint_accepted":{"type":"boolean","example":false,"description":"Indicates if the thumbprint of the View Composer was accepted."}},"title":"ViewComposerMonitorConnectionServer","description":"Information about the View Composer connection from connection server."},"ViewComposerMonitorConnectionServerV2":{"type":"object","properties":{"certificate":{"description":"Information related to certificate.","$ref":"#/definitions/CertificateMonitorInfo"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"last_updated_timestamp":{"type":"integer","format":"int64","example":1582029025748,"description":"The timestamp in milliseconds when the last update was obtained. Measured as epoch time."},"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"OK","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.","enum":["OK","MALFORMED_URL","ERROR","CERT_ERROR"]},"thumbprint_accepted":{"type":"boolean","example":false,"description":"Indicates if the thumbprint of the View Composer was accepted."}},"title":"ViewComposerMonitorConnectionServerV2","description":"Information about the View Composer connection from connection server."},"ViewComposerMonitorDetails":{"type":"object","properties":{"api_verion":{"type":"string","example":3.5,"description":"The version of the View Composer API used to communicate with the View Composer server."},"build":{"type":"string","example":1234567,"description":"The build of the View Composer server."},"min_esx_version":{"type":"string","example":5.5,"description":"The minimum ESX version required for compatibility with this View Composer server."},"min_vc_version":{"type":"string","example":5.5,"description":"The minimum Virtual Center version required for compatibility with this View Composer server."},"referenced_vcs":{"type":"array","description":"The Virtual Center servers referencing to this View Composer.","items":{"type":"string"}},"version":{"type":"string","example":"7.9.0.12345","description":"The version of the View Composer server."}},"title":"ViewComposerMonitorDetails","description":"Details of the View Composer."},"ViewComposerMonitorInfo":{"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the View Composer connections from each of the connection servers.","items":{"$ref":"#/definitions/ViewComposerMonitorConnectionServer"}},"details":{"description":"Details about the View Composer.","$ref":"#/definitions/ViewComposerMonitorDetails"},"name":{"type":"string","example":"composer1.example.com","description":"View Composer server host name or IP address."},"port":{"type":"integer","format":"int32","example":18443,"description":"View Composer server port number.","minimum":0,"maximum":65535,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"ViewComposerMonitorInfo","description":"Monitoring information related to View Composer."},"ViewComposerMonitorInfoV2":{"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the View Composer connections from each of the connection servers.","items":{"$ref":"#/definitions/ViewComposerMonitorConnectionServerV2"}},"details":{"description":"Details about the View Composer.","$ref":"#/definitions/ViewComposerMonitorDetails"},"name":{"type":"string","example":"composer1.example.com","description":"View Composer server host name or IP address."},"port":{"type":"integer","format":"int32","example":18443,"description":"View Composer server port number.","minimum":0,"maximum":65535,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"ViewComposerMonitorInfoV2","description":"Monitoring information related to View Composer."},"ViewStorageAcceleratorBlackoutTimeSettings":{"type":"object","properties":{"days":{"type":"array","example":["MONDAY", "TUESDAY"],"description":"List of days for a given range of time.","items":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY","ALL"]}},"end_time":{"type":"string","example":"22:00","description":"Ending time for the blackout in 24-hour format."},"start_time":{"type":"string","example":"10:00","description":"Starting time for the blackout in 24-hour format."}},"title":"ViewStorageAcceleratorBlackoutTimeSettings","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":{"type":"object","required":["days","end_time","start_time"],"properties":{"days":{"type":"array","example":["MONDAY", "TUESDAY"],"description":"List of days for a given range of time.","items":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY","ALL"]}},"end_time":{"type":"string","example":"22:00","description":"Ending time for the blackout in 24-hour format."},"start_time":{"type":"string","example":"10:00","description":"Starting time for the blackout in 24-hour format."}},"title":"ViewStorageAcceleratorBlackoutTimeSettingsCreateSpec","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":{"type":"object","required":["days","end_time","start_time"],"properties":{"days":{"type":"array","example":["MONDAY", "TUESDAY"],"description":"List of days for a given range of time.","items":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY","ALL"]}},"end_time":{"type":"string","example":"22:00","description":"Ending time for the blackout in 24-hour format."},"start_time":{"type":"string","example":"10:00","description":"Starting time for the blackout in 24-hour format."}},"title":"ViewStorageAcceleratorBlackoutTimeSettingsUpdateSpec","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."},"VirtualCenterInfo":{"type":"object","properties":{"certificate_override":{"description":"Virtual center certificate thumbprint should the client choose to override an invalid certificate.","$ref":"#/definitions/CertificateOverrideData"},"description":{"type":"string","example":"Virtual Center Server","description":"Human readable description of the Virtual Center instance."},"display_name":{"type":"string","example":"vc1.example.com","description":"Human readable name of the Virtual Center instance."},"enabled":{"type":"boolean","example":true,"description":"Indicates if the virtual center is enabled."},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Virtual Center."},"instance_uuid":{"type":"string","example":"6605d116-d1b5-4810-8e3a-b710b30993da","description":"Virtual center's instanceUuid."},"limits":{"description":"Virtual center's limits for the number of concurrent operations.","$ref":"#/definitions/VCLimits"},"port":{"type":"integer","format":"int32","example":443,"description":"Port of the virtual center to connect to."},"se_sparse_reclamation_enabled":{"type":"boolean","example":true,"description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled."},"server_name":{"type":"string","example":"vc1.example.com","description":"Virtual Center's server name or IP address."},"storage_accelerator_data":{"description":"Storage Accelerator configuration details.","$ref":"#/definitions/StorageAcceleratorData"},"use_ssl":{"type":"boolean","example":true,"description":"Indicates if SSL should be used when connecting to the server."},"user_name":{"type":"string","example":"administrator@vsphere.local","description":"User name to use for the connection."},"version":{"type":"string","example":"6.5.0","description":"Version of the Virtual Center."},"vmc_deployment":{"type":"boolean","example":false,"description":"Indicates if virtual center is deployed in VMC."}},"title":"VirtualCenterInfo","description":"Information related to Virtual Center."},"VirtualCenterInfoV2":{"type":"object","properties":{"certificate_override":{"description":"Virtual center certificate thumbprint should the client choose to override an invalid certificate.","$ref":"#/definitions/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","example":"Virtual Center Server","description":"Human readable description of the Virtual Center instance."},"display_name":{"type":"string","example":"vc1.example.com","description":"Human readable name of the Virtual Center instance."},"enabled":{"type":"boolean","example":true,"description":"Indicates if the virtual center is enabled."},"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","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Virtual Center."},"instance_uuid":{"type":"string","example":"6605d116-d1b5-4810-8e3a-b710b30993da","description":"Virtual center's instanceUuid."},"limits":{"description":"Virtual center's limits for the number of concurrent operations.","$ref":"#/definitions/VCLimits"},"maintenance_mode":{"type":"boolean","description":"Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts"},"port":{"type":"integer","format":"int32","example":443,"description":"Port of the virtual center to connect to."},"se_sparse_reclamation_enabled":{"type":"boolean","example":true,"description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled."},"server_name":{"type":"string","example":"vc1.example.com","description":"Virtual Center's server name or IP address."},"storage_accelerator_data":{"description":"Storage Accelerator configuration details.","$ref":"#/definitions/StorageAcceleratorData"},"use_ssl":{"type":"boolean","example":true,"description":"Indicates if SSL should be used when connecting to the server."},"user_name":{"type":"string","example":"administrator@vsphere.local","description":"User name to use for the connection."},"version":{"type":"string","example":"6.5.0","description":"Version of the Virtual Center."}},"title":"VirtualCenterInfoV2","description":"Information related to Virtual Center."},"VirtualCenterMonitorInfo":{"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the Virtual Center connections from each of the connection servers.","items":{"$ref":"#/definitions/VCMonitorConnectionServer"}},"datastores":{"type":"array","description":"Information about the datastores of the Virtual Center.","items":{"$ref":"#/definitions/VCMonitorDatastore"}},"desktops_count":{"type":"integer","format":"int32","description":"Number of Desktop Pools And Farms managed by the virtual center."},"details":{"description":"Details about the Virtual Center.","$ref":"#/definitions/VCMonitorDetails"},"hosts":{"type":"array","description":"Information about the ESX hosts added in the Virtual Center.","items":{"$ref":"#/definitions/VCMonitorHost"}},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Virtual Center."},"name":{"type":"string","example":"vc1.example.com","description":"Virtual Center server name or IP address."}},"title":"VirtualCenterMonitorInfo","description":"Monitoring information related to a Virtual Center"},"VirtualCenterMonitorInfoV2":{"type":"object","properties":{"connection_servers":{"type":"array","description":"Information about the Virtual Center connections from each of the connection servers.","items":{"$ref":"#/definitions/VCMonitorConnectionServerV2"}},"datastores":{"type":"array","description":"Information about the datastores of the Virtual Center.","items":{"$ref":"#/definitions/VCMonitorDatastore"}},"desktop_pools_and_farms_count":{"type":"integer","format":"int32","description":"Number of Desktop Pools And Farms managed by the virtual center"},"details":{"description":"Details about the Virtual Center.","$ref":"#/definitions/VCMonitorDetails"},"hosts":{"type":"array","description":"Information about the ESX hosts added in the Virtual Center.","items":{"$ref":"#/definitions/VCMonitorHost"}},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Virtual Center."},"name":{"type":"string","example":"vc1.example.com","description":"Virtual Center server name or IP address."}},"title":"VirtualCenterMonitorInfoV2","description":"Monitoring information related to a Virtual Center"},"VirtualDiskData":{"type":"object","properties":{"capacity_mb":{"type":"integer","format":"int64","example":102400,"description":"The disk capacity in MB."},"datastore_path":{"type":"string","example":"datastore1","description":"The virtual disk's datastore."},"path":{"type":"string","example":"/path/host","description":"The virtual disk path."}},"title":"VirtualDiskData","description":"Information related to a virtual disk."},"VirtualMachineInfo":{"type":"object","properties":{"hardware_version":{"type":"integer","format":"int32","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Hardware version for this VM."},"id":{"type":"string","example":"vm-416","description":"Unique ID representing a VM."},"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.","items":{"type":"string","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","example":"Win10","description":"VM name."},"operating_system":{"type":"string","example":"WINDOWS_10","description":"Operating system.\n* UNKNOWN: Unknown\n* WINDOWS_XP: Windows XP\n* WINDOWS_VISTA: Windows Vista\n* WINDOWS_7: Windows 7\n* WINDOWS_8: Windows 8\n* WINDOWS_10: Windows 10\n* WINDOWS_11: Windows 11\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* LINUX_OTHER: Linux (other)\n* LINUX_SERVER_OTHER: Linux server (other)\n* LINUX_UBUNTU: Linux (Ubuntu)\n* LINUX_RHEL: Linux (Red Hat Enterprise)\n* LINUX_SUSE: Linux (Suse)\n* LINUX_CENTOS: Linux (CentOS)","enum":["UNKNOWN","WINDOWS_XP","WINDOWS_VISTA","WINDOWS_7","WINDOWS_8","WINDOWS_10","WINDOWS_11","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016_OR_ABOVE","LINUX_OTHER","LINUX_SERVER_OTHER","LINUX_UBUNTU","LINUX_RHEL","LINUX_SUSE","LINUX_CENTOS"]},"operating_system_display_name":{"type":"string","example":"Microsoft Windows 10 (64-bit)","description":"Operating system display name from Virtual Center."},"path":{"type":"string","example":"/Datacenter/vm/VMs/Win10","description":"VM path."},"v_gputype":{"type":"string","example":"datacenter-1","description":"Virtual GPU type."}},"title":"VirtualMachineInfo","description":"Information related to a Virtual Machine."}}}