Horizon Server API Data Structures
Information about an active directory container.
{
"rdn": "CN=ComPartitions,CN=System"
}
The rdn of the active directory container, relative to the root of the domain.
Information related to untrusted Domain advance settings.
{
"ad_domain_auto_discovery": true,
"ad_domain_context": "dc=abc,dc=com",
"ad_domain_controllers": [
"example.com",
"example1.com"
],
"ad_domain_preferred_site": "Bengaluru",
"port": 389
}
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.
Active directory domain Context.
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.
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 of the server to connect to.
Information related to untrusted Domain advance settings.
{
"ad_domain_auto_discovery": true,
"ad_domain_context": "dc=abc,dc=com",
"ad_domain_controllers": [
"example.com"
],
"ad_domain_preferred_site": "Bengaluru",
"port": 389
}
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.
Active directory domain Context.
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.
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 of the server to connect to.
Specification of auxiliary accounts.
{
"auxiliary_accounts": [
{
"password": [
"<password>"
],
"username": "Administrator"
}
]
}
Auxiliary service account credentials.
Auxiliary accounts to delete.
{
"auxiliary_account_ids": [
"string"
]
}
Auxiliary account ID's.
Specification to update auxiliary accounts.
{
"auxiliary_accounts": [
{
"id": "1f95a15c-a7a5-4584-963f-2c3f5355b49f",
"password": [
"<password>"
]
}
]
}
Auxiliary service account credentials.
Information related to auxiliary service accounts of untrusted domain.
{
"id": "554c9fc8-d948-4fbb-9612-69cd640191e6_user1",
"username": "Administrator"
}
Unique SID representing auxiliary account.
Service account username.
ADDomain bind response.
{
"id": "S-1-5-21-3861703653-2745738756-3849765893"
}
Unique ID representing the AD domain.
Information related to AD Domains of the environment.
{
"dns_name": "example.com",
"id": "S-1-5-21-1085031214-1563985344-725345543",
"netbios_name": "AD-EXAMPLE1"
}
DNS name of the AD Domain.
Unique SID representing AD Domain.
NetBIOS name of the AD Domain.
Information related to AD Domains of the environment.
{
"ad_domain_advanced_settings": {
"ad_domain_auto_discovery": true,
"ad_domain_context": "dc=abc,dc=com",
"ad_domain_controllers": [
"example.com"
],
"ad_domain_preferred_site": "Bengaluru",
"port": 389
},
"dns_name": "example.com",
"domain_type": "CONNECTION_SERVER_DOMAIN",
"id": "S-1-5-21-1085031214-1563985344-725345543",
"netbios_name": "AD-EXAMPLE1",
"primary_account": {
"username": "Administrator"
}
}
DNS name of the AD Domain.
AD Domain Type.
- CONNECTION_SERVER_DOMAIN: The domain having trust with connection server domain.
- NO_TRUST_DOMAIN: The domain not having any trust with connection server domain.
Unique SID representing AD Domain.
NetBIOS name of the AD Domain.
Information related to AD Domains of the environment.
{
"ad_domain_advanced_settings": {
"ad_domain_auto_discovery": true,
"ad_domain_context": "dc=abc,dc=com",
"ad_domain_controllers": [
"example.com"
],
"ad_domain_preferred_site": "Bengaluru",
"port": 389
},
"auxiliary_accounts": [
{
"id": "554c9fc8-d948-4fbb-9612-69cd640191e6_user1",
"username": "Administrator"
}
],
"dns_name": "example.com",
"domain_type": "CONNECTION_SERVER_DOMAIN",
"id": "S-1-5-21-1085031214-1563985344-725345543",
"netbios_name": "AD-EXAMPLE1",
"primary_account": {
"username": "Administrator"
}
}
Auxiliary service accounts information of untrusted domain.
DNS name of the AD Domain.
AD Domain Type.
- CONNECTION_SERVER_DOMAIN: The domain having trust with connection server domain.
- NO_TRUST_DOMAIN: The domain not having any trust with connection server domain.
Unique SID representing AD Domain.
NetBIOS name of the AD Domain.
Information about the AD Domain connection from connection server.
{
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"name": "cs1.example.com",
"status": "FULLY_ACCESSIBLE",
"trust_relationship": "TWO_WAY"
}
Unique ID of the connection server.
Connection server host name or IP address.
Status of the connection to the domain.
- UNCONTACTABLE: No domain controllers appear to be present on the network for this domain.
- FULLY_ACCESSIBLE: The domain controller(s) are accepting bind operations.
- CANNOT_BIND: The domain controller(s) are only accepting LDAP ping operations.
- UNKNOWN: Cannot determine accessibility.
The trust relationship for the domain.
- PRIMARY_DOMAIN: The domain is the domain that the broker is present in.
- FROM_BROKER: The domain is trusted by the domain that the broker is in.
- TO_BROKER: The domain trusts the broker's domain (this is for completeness and generally will not be used).
- TWO_WAY: The domain has a two way trust relationship with the broker's domain.
- TWO_WAY_FOREST: The domain is in the same forest as the broker's domain, implies two way trust.
- MANUAL: The domain was manually configured (the trust has not been detected).
- NOTRUST: The domain not having trust with broker domain.
- UNKNOWN: The trust relationship could not be determined.
Information about the AD Domain connection from connection server.
{
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "cs1.example.com",
"status": "FULLY_ACCESSIBLE",
"trust_relationship": "TWO_WAY"
}
Unique ID of the connection server.
The timestamp in milliseconds when the last update was obtained. Measured as epoch time.
Connection server host name or IP address.
Status of the connection to the domain.
- UNCONTACTABLE: No domain controllers appear to be present on the network for this domain.
- FULLY_ACCESSIBLE: The domain controller(s) are accepting bind operations.
- CANNOT_BIND: The domain controller(s) are only accepting LDAP ping operations.
- UNKNOWN: Cannot determine accessibility.
The trust relationship for the domain.
- PRIMARY_DOMAIN: The domain is the domain that the broker is present in.
- FROM_BROKER: The domain is trusted by the domain that the broker is in.
- TO_BROKER: The domain trusts the broker's domain (this is for completeness and generally will not be used).
- TWO_WAY: The domain has a two way trust relationship with the broker's domain.
- TWO_WAY_FOREST: The domain is in the same forest as the broker's domain, implies two way trust.
- MANUAL: The domain was manually configured (the trust has not been detected).
- NOTRUST: The domain not having trust with broker domain.
- UNKNOWN: The trust relationship could not be determined.
Monitoring information related to AD Domain.
{
"connection_servers": [
{
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"name": "cs1.example.com",
"status": "FULLY_ACCESSIBLE",
"trust_relationship": "TWO_WAY"
}
],
"dns_name": "ad-example1.example.com",
"netbios_name": "AD-EXAMPLE1",
"nt4_domain": true
}
Information about the AD Domain connections from each of the connection servers.
The DNS name for the domain.
The NetBIOS name for the domain.
If this is an NT4 domain or not.
Monitoring information related to AD Domain.
{
"connection_servers": [
{
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "cs1.example.com",
"status": "FULLY_ACCESSIBLE",
"trust_relationship": "TWO_WAY"
}
],
"dns_name": "ad-example1.example.com",
"netbios_name": "AD-EXAMPLE1",
"nt4_domain": true
}
Information about the AD Domain connections from each of the connection servers.
The DNS name for the domain.
The NetBIOS name for the domain.
If this is an NT4 domain or not.
Monitoring information related to AD Domain.
{
"connection_servers": [
{
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "cs1.example.com",
"status": "FULLY_ACCESSIBLE",
"trust_relationship": "TWO_WAY"
}
],
"dns_name": "ad-example1.example.com",
"domain_type": "CONNECTION_SERVER_DOMAIN",
"netbios_name": "AD-EXAMPLE1",
"nt4_domain": true,
"service_accounts": [
{
"owner_id": "S-1-1-1-3965912346-1012345398-3123456564-123",
"status": "ACTIVE",
"username": "USER1"
}
]
}
Information about the AD Domain connections from each of the connection servers.
The DNS name for the domain.
AD Domain Type.
- CONNECTION_SERVER_DOMAIN: The domain having trust with connection server domain.
- NO_TRUST_DOMAIN: The domain not having any trust with connection server domain.
The NetBIOS name for the domain.
If this is an NT4 domain or not.
Information related to untrusted Domain service accounts.
{
"username": "Administrator"
}
Service account username.
Information related to untrusted Domain service accounts.
{
"password": [
"<password>"
],
"username": "Administrator"
}
Service account user password.
Service account username.
Specification of untrusted domain.
{
"ad_domain_advanced_settings": {
"ad_domain_auto_discovery": true,
"ad_domain_context": "dc=abc,dc=com",
"ad_domain_controllers": [
"example.com",
"example1.com"
],
"ad_domain_preferred_site": "Bengaluru",
"port": 389
},
"dns_name": "example.com",
"netbios_name": "EXAMPLE",
"primary_account": {
"password": [
"<password>"
],
"username": "Administrator"
}
}
The DNS name of the domain.
The NetBIOS name of the domain.
Untrusted domain object to be updated.
{
"ad_domain_advanced_settings": {
"ad_domain_auto_discovery": true,
"ad_domain_context": "dc=abc,dc=com",
"ad_domain_controllers": [
"example.com",
"example1.com"
],
"ad_domain_preferred_site": "Bengaluru",
"port": 389
},
"primary_account": {
"password": [
"<password>"
],
"username": "Administrator"
}
}
Information related to an AD site.
{
"ad_site_name": "Default-First-Site-Name"
}
Name of the AD Site.
AD user password object to be changed.
{
"domain": "example.com",
"key_id": "ut0yGq7CbhtBUGfW3ngjkvjQ2cc=",
"new_encrypted_password": "4TGdfggfwrrGUPSg4/JK/tYub7lUI8pGtyHd/ty5g8h5=",
"old_encrypted_password": "9QYxpdXrcrOGPSSz1/K/pJu8QlYT7pDkaKg/rb3hlw4=",
"protected_password_key": "Qvvjglg5iZinyuldroueo/hQFyqydMMDJPmfYGgIebqxbU9chJ9I8iM9SCBRHSkSW9y+RMQOfC",
"username": "testuser or [email protected]"
}
The domain of user. Note that domain is optional if UPN is supplied.
The keyId of the cluster's SSO KeyPair used to encrypt the password key.
New password for the user in encrypted format.
Old password for the user in encrypted format.
Decryption key for the password. This key is itself encrypted with cluster's SSO keypair.
The username or UPN.
AD user encrypted credentials object to be validated.
{
"domain": "example.com",
"encrypted_password": "9QYxpdXrcrOGPSSz1/K/pJu8QlYT7pDkaKg/rb3hlw4=",
"key_id": "ut0yGq7CbhtBUGfW3ngjkvjQ2cc=",
"protected_password_key": "Qvvjglg5iZinyuldroueo/hQFyqydMMDJPmfYGgIebqxbU9chJ9I8iM9SCBRHSkSW9y+RM",
"username": "testuser or [email protected]"
}
The domain of user. Note that domain is optional if UPN is supplied.
Encrypted password for the user.
The keyId of the cluster's SSO KeyPair used to encrypt the protectedPasswordKey.
Decryption key for the password. This key is itself encrypted with cluster's SSO keypair.
The username or UPN.
Information related to AD User.
{
"domain": "example.com",
"group_guids": [
"5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA",
"6H8S6Y4-35D3-6534-5ERC-A678E3YG4FAD"
],
"group_sids": [
"S-1-5-21-544",
"S-1-5-21-1111111111-2222222222-3333333333-513"
],
"user_guid": "5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA",
"user_principal_name": "[email protected]",
"user_sid": "S-1-5-21-544",
"username": "testuser"
}
DNS name of the domain in which this user or group belongs to.
Guids of the user's groups in RFC 4122 format.
List of unique SIDs of the groups, this user or group belongs to.
GUID of the user in RFC 4122 format.
User Principal name(UPN) of this user.
Unique SID representing this AD User.
Username of this user.
Information related to AD User or Group.
{
"container": "example.com/Users",
"description": "Test User account",
"display_name": "example.com\\\\testuser",
"distinguished_name": "CN=Test User,CN=Users,DC=example,DC=com",
"domain": "example.com",
"email": "[email protected]",
"first_name": "Test",
"group": "boolean",
"group_membership_ids": [
"S-1-5-21-544",
"S-1-5-21-1111111111-2222222222-3333333333-513"
],
"guid": "5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA",
"id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"kiosk_user": "boolean",
"last_name": "User",
"login_name": "testuser",
"long_display_name": "[email protected] (Test User)",
"name": "Test User",
"phone": "1-877-486-9273",
"sub_group_count": 2,
"user_count": 2,
"user_display_name": "Test User",
"user_principal_name": "[email protected]"
}
AD container for this user or group.
Description number of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'.
Login name with domain of this user or group.
Active Directory distinguished name for this user or group.
DNS name of the domain in which this user or group belongs. Supported Filters : 'Equals'. 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 address of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'.
First name of this user or group.
Indicates if this object represents a group. This field is NOT supported in filter string. To use any filter on 'group', use 'group_only' query param directly.
List of unique SIDs of the groups, this user or group belongs to.
GUID of the user or group in RFC 4122 format. Supported Filters : 'Equals'.
Unique SID representing this AD User or Group. Supported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.
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 of this user or group.
Login name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'.
Login name, domain and name for this user or group, else display name
Name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'.
Phone number of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'.
Number of subgroups in this group, or 0 if not a group.
Number of users in this group, or 0 if not a group.
User or group's display name. This corresponds with displayName attribute in AD.
User Principal name(UPN) of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'.
Summary information related to AD Users or Groups. 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'. See the field description to know the filter types it supports.
{
"container": "example.com/Users",
"description": "Test User account",
"display_name": "example.com\\\\testuser",
"distinguished_name": "CN=Test User,CN=Users,DC=example,DC=com",
"domain": "example.com",
"email": "[email protected]",
"first_name": "Test",
"group": "boolean",
"guid": "5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA",
"id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"kiosk_user": "boolean",
"last_name": "User",
"login_name": "testuser",
"long_display_name": "[email protected] (Test User)",
"name": "Test User",
"phone": "1-877-486-9273",
"user_display_name": "Test User",
"user_principal_name": "[email protected]"
}
AD container for this user or group.
Description number of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'.
Login name with domain of this user or group.
Active Directory distinguished name for this user or group.
DNS name of the domain in which this user or group belongs. Supported Filters : 'Equals'. 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 address of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'.
First name of this user or group.
Indicates if this object represents a group. This field is NOT supported in filter string. To use any filter on 'group', use 'group_only' query param directly.
GUID of the user or group in RFC 4122 format. Supported Filters : 'Equals'.
Unique SID representing this AD User or Group. Supported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.
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 of this user or group.
Login name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'.
Login name, domain and name for this user or group, else display name
Name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'.
Phone number of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'.
User or group's display name. This corresponds with displayName attribute in AD.
User Principal name(UPN) of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'.
Response for each API which results in error.
Contains a unique error key and localised version of error message.
{
"error_key": "inventory.machine.not.found",
"error_message": "username cannot be empty"
}
Error key configured in message bundle.
Error message translated in user's locale.
Access Token
{
"access_token": "<jwt.access.token>"
}
Access Token to be used in API calls.
Information about admin user or group permissions.
{
"federated_privileges_info": [
{
"access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"access_group_name": "root",
"privileges": [
"VC_CONFIG_VIEW",
"FEDERATED_LDAP_MANAGE",
"GLOBAL_CONFIG_MANAGEMENT"
]
}
],
"help_desk_admin": "boolean",
"id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"local_privileges_info": [
{
"access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"access_group_name": "root",
"privileges": [
"VC_CONFIG_VIEW",
"FEDERATED_LDAP_MANAGE",
"GLOBAL_CONFIG_MANAGEMENT"
]
}
]
}
Set of privileges information based on federated access groups for this user or group.
help_desk_admin
Unique SID representing the admin user or group.
Set of privileges information based on local access groups for this user or group.
Preferences for administrators of Horizon Console.
{
"admin_timeout_in_minutes": 400,
"grid_preferences": {
"desktopsListing": [
"DisplayName",
"Type"
]
}
}
UI console session timeout preference in minutes for Horizon Console.
Grid preferences for data grids on Horizon Console. Each entry will be the list of hidden columns for a grid identifier.
Preferences for administrators of Horizon Console.
{
"admin_timeout_in_minutes": 400,
"display_subscription_banner": true,
"grid_preferences": {
"desktopsListing": [
"DisplayName",
"Type"
]
}
}
UI console session timeout preference in minutes for Horizon Console.
Indicates whether a banner should be shown to prompt the customers with HUL license to connect to Titan CP and move to subscription based license.
Grid preferences for data grids on Horizon Console. Each entry will be the list of hidden columns for a grid identifier.
Information required to update Horizon Console administrator preferences.
{
"admin_timeout_in_minutes": 400,
"grid_preferences": {
"desktopsListing": [
"DisplayName",
"Type"
]
}
}
UI console session timeout preference in minutes for Horizon Console.
Grid preferences for data grids on Horizon Console.
Information required to update Horizon Console administrator preferences.
{
"admin_timeout_in_minutes": 400,
"display_subscription_banner": true,
"grid_preferences": {
"desktopsListing": [
"DisplayName",
"Type"
]
}
}
UI console session timeout preference in minutes for Horizon Console.
Indicates whether a banner should be shown to prompt the customers with HUL license to connect to Titan CP and move to subscription based license.
Grid preferences for data grids on Horizon Console.
Information about admin user or group privileges.
{
"access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"access_group_name": "root",
"privileges": [
"VC_CONFIG_VIEW",
"FEDERATED_LDAP_MANAGE",
"GLOBAL_CONFIG_MANAGEMENT"
]
}
ID of the access group.
Name of the access group.
The set of privileges on the access group.
Information about a registered agent installer package.
{
"build_number": "12345678",
"id": "087ae070-602e-4498-b67c-d7f5807ab5e4",
"url": "https://example.com/build.exe",
"version": "8.5.0"
}
Build number of the installer.
Unique identifier for this agent installer package.
URL of the installer executable.
Version of the installer MSI.
Response for agent installer package register operation.
{
"agent_installer_package_id": "d49e4ffa-2238-4bc7-a292-539b2ea96548"
}
Id of the installer registered.
Agent installer package to be registered
{
"metadata_file_url": "https://example.com/metadata.json"
}
URL of the metadata file concerning the agent installer package which is to be registered.
Information related to agent restriction settings.
{
"restricted_agent_data": [
{
"block_specific_versions": [
"7.6,0",
"8.0.0"
],
"type": "WINDOWS",
"version": "7.5.0"
}
],
"restricted_agent_message": "The system does not support this version of the Horizon Agent."
}
Information related to restricted Horizon Agents.
The message to be displayed to Horizon clients when agent version of requested session are blocked by the Connection Server.
Agent restriction settings object to be updated.
{
"restricted_agent_data": [
{
"block_specific_versions": [
"7.6,0",
"8.0.0"
],
"type": "WINDOWS",
"version": "7.5.0"
}
],
"restricted_agent_message": "The system does not support this version of the Horizon Agent."
}
Information related to restricted Horizon Agents.
The message to be displayed to Horizon clients when agent version of requested session are blocked by the Connection Server.
Information about agent upgrade history.
{
"agent_build": "8.10.0-12345678",
"cancelled_count": 5,
"failed_count": 10,
"skipped_count": 10,
"succeeded_count": 20,
"task_id": "7e0db15d-9c07-47b1-8e3a-f450adcac002",
"upgrade_window_end_time": 1665417715000,
"upgrade_window_start_time": 1660417715000
}
Build to which the agents were upgraded.
Number of machines/RDS servers for which the upgrade was cancelled.
Number of machines/RDS servers for which the upgrade failed.
Number of machines/RDS servers for which the upgrade was skipped.
Number of machines/RDS servers for which the upgrade succeeded.
Task id for the agent upgrade.
Time at which the upgrade window ended.
Time at which the upgrade window started.
Agent upgrade spec.
{
"agent_installer_package_id": "2b6eaeb8-2e91-11ed-a261-0242ac120002",
"batch_size": 20,
"custom_install_parameters": "ADDLOCAL=Core,USB",
"end_time": 1652079610000,
"failure_threshold": 10,
"machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"skip_for_logged_in_users": true,
"start_time": 1652079610000
}
ID of the agent installer package.
Indicates the size of the batch to be considered for agent upgrade, in percentage.
Indicates any parameters to be used by the agent for silent install.
Agent upgrade end time.
Indicates the threshold for tolerating failures, beyond which upgrades will be skipped, in percentage.
Machines or RDS servers on which the upgrade is to be scheduled.
Indicates whether to skip agent upgrade for logged in users.
Agent upgrade start time.
{
"agent_installer_package_id": "2b6eaeb8-2e91-11ed-a261-0242ac120002",
"cancelled_machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"end_time": 1652079610000,
"failed_machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"id": "16c2faaa-2e8c-11ed-a261-0242ac120002",
"in_progress_machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"not_started_machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"operation": "SCHEDULED",
"skipped_machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"start_time": 1652079610000,
"state": "string",
"succeeded_machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
]
}
ID of the agent installer package.
Machines or RDS servers for which upgrade has been cancelled.
Agent upgrade end time.
Machines or RDS servers for which upgrade has failed.
Task ID of the agent upgrade.
Machines or RDS servers for which upgrade are in progress.
Machines or RDS servers for which upgrade has not started.
The current agent upgrade task operation.
Machines or RDS servers for which upgrade has skipped.
Agent upgrade start time.
The state of an agent upgrade task.
Machines or RDS servers for which upgrade has succeeded.
{
"agent_installer_package_id": "2b6eaeb8-2e91-11ed-a261-0242ac120002",
"batch_size": 20,
"cancelled_machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"end_time": 1652079610000,
"failed_machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"failure_threshold": 10,
"id": "16c2faaa-2e8c-11ed-a261-0242ac120002",
"in_progress_machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"not_started_machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"operation": "SCHEDULED",
"skipped_machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"start_time": 1652079610000,
"state": "string",
"succeeded_machine_or_rds_server_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
]
}
ID of the agent installer package.
Indicates the size of the batch to be considered for agent upgrade, in percentage.
Machines or RDS servers for which upgrade has been cancelled.
Agent upgrade end time.
Machines or RDS servers for which upgrade has failed.
Indicates the threshold for tolerating failures, beyond which upgrades will be skipped, in percentage.
Task ID of the agent upgrade.
Machines or RDS servers for which upgrade are in progress.
Machines or RDS servers for which upgrade has not started.
The current agent upgrade task operation.
Machines or RDS servers for which upgrade has skipped.
Agent upgrade start time.
The state of an agent upgrade task.
Machines or RDS servers for which upgrade has succeeded.
{
"details": [
{
"error_messages": [
"Entity does not exist.",
"Property is mandatory."
],
"errors": [
{
"error_key": "inventory.machine.not.found",
"error_message": "username cannot be empty"
}
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"key": "user1",
"status_code": 200,
"timestamp": 1561939200000
}
],
"task_id": "7d01dc94-2e93-11ed-a261-0242ac120002"
}
List of BulkItemResponseInfo corresponding to each machine id in the action operation.
Unique ID representing the task.
Certificate details and type information, which can be used to override thumbprint details.
{
"certificate": "string",
"type": "PEM"
}
App Volume manage certificate
Type of Certificate.
- PEM: PEM encoded certificate type
- UNKNOWN: Unknown certificate type
Certificate data to be updated with App Volumes manager
{
"certificate": "string",
"type": "PEM"
}
App Volume Manager certificate
Type of Certificate.
- PEM: PEM encoded certificate type
- UNKNOWN: Unknown certificate type
Information about the application available in App volumes Manager.
{
"avm_shortcut_id": "1",
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"name": "Firefox",
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
],
"publisher": "Mozilla Corporation",
"version": "72.0.2"
}
Shortcut ID of AVM managed application.
Path to application executable.
Set of file types reported by the application as supported. If unset, this application does not present any file type support.
Application name information, as sent by RDSServer/machine during application discovery.
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.
Application publisher
Application version.
Certificate details and type information, which can be used to override thumbprint details.
{
"certificate": "string",
"type": "PEM"
}
App Volume Manager certificate
Type of Certificate.
- PEM: PEM encoded certificate type
- UNKNOWN: Unknown certificate type
App volumes manager object to be added.
{
"password": [
"<password>"
],
"port": 443,
"server_name": "avm.example.com",
"username": "administrator"
}
Password of the account.
Port of the App Volumes manager to connect to.
App Volumes Manager's server name or IP address.
Username to login to App Volumes Manager
App volumes manager object to be added.
{
"certificate_override": {
"certificate": "string",
"type": "PEM"
},
"password": [
"<password>"
],
"port": 443,
"server_name": "avm.example.com",
"username": "administrator"
}
Password of the account.
Port of the App Volumes manager to connect to.
App Volumes Manager's server name or IP address.
Username to login to App Volumes Manager
Information about App Volumes Manager.
{
"id": "625bdb01-7c4f-423e-a9b8-a2256c21447d ",
"port": 443,
"server_name": "avm.example.com",
"username": "administrator"
}
Unique Id of the App Volumes Manager.
Port of the App Volumes Manager to connect to.
App Volumes Manager's server name or IP address.
Username to login to App Volumes Manager.
Information about App Volumes Manager.
{
"certificate_override": {
"certificate": "string",
"type": "PEM"
},
"id": "625bdb01-7c4f-423e-a9b8-a2256c21447d ",
"port": 443,
"server_name": "avm.example.com",
"username": "administrator"
}
Unique Id of the App Volumes Manager.
Port of the App Volumes Manager to connect to.
App Volumes Manager's server name or IP address.
Username to login to App Volumes Manager.
Information about connection to App Volumes Manager from Connection Server.
{
"name": "cs1.example.com",
"status": "OK"
}
Connection server host name or IP address.
Status of the App Volumes Manager Connection with respect to this Connection Server.
- ERROR: There has been no contact from the App Volumes Manager.
- OK: The App Volumes Manager is working as expected.
Information about connection to App Volumes Manager from Connection Server.
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": true
}
Connection server host name or IP address.
Status of the App Volumes Manager Connection with respect to this Connection Server.
- ERROR: There has been no contact from the App Volumes Manager.
- OK: The App Volumes Manager is working as expected.
Indicates if the thumbprints of the App Volumes Manager was accepted.
Monitoring information related to App volumes Manager registered in the environment.
{
"connection_servers": [
{
"name": "cs1.example.com",
"status": "OK"
}
],
"description": "SUCCESS",
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"status": "OK",
"url": "avm.example.com",
"version": "App Volumes 4, version 2209 (4.9.0.2996)"
}
Information about the App volumes Manager connections from each of the connection servers.
App volumes Manager Connection description.
- SUCCESS: No problem detected.
- CERT_INVALID_THUMBPRINT_MATCHED: No problem detected. Certificate is untrusted but the thumbprint for the certificate is accepted.
- CERT_INVALID_THUMBPRINT_MATCH_FAILED: Certificate is untrusted and the thumbprint for the certificate is not accepted. Requires certificate revalidation.
- PROBLEM: Problem detected in connecting to App Volumes Manager.
Unique ID of the App volumes Manager.
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.
- ERROR: There has been no contact from the App Volumes Manager.
- OK: The App Volumes Manager is working as expected.
App volumes Manager url.
App volumes Manager version.
{
"connection_servers_v2": [
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": true
}
],
"description": "SUCCESS",
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"status": "OK",
"url": "avm.example.com",
"version": "App Volumes 4, version 2209 (4.9.0.2996)"
}
Information about the App volumes Manager connections from each of the connection servers.
App volumes Manager Connection description.
- SUCCESS: No problem detected.
- CERT_INVALID_THUMBPRINT_MATCHED: No problem detected. Certificate is untrusted but the thumbprint for the certificate is accepted.
- CERT_INVALID_THUMBPRINT_MATCH_FAILED: Certificate is untrusted and the thumbprint for the certificate is not accepted. Requires certificate revalidation.
- PROBLEM: Problem detected in connecting to App Volumes Manager.
Unique ID of the App volumes Manager.
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.
- ERROR: There has been no contact from the App Volumes Manager.
- OK: The App Volumes Manager is working as expected.
App volumes Manager url.
App volumes Manager version.
App volumes manager object to be updated.
{
"password": [
"<password>"
],
"port": 443,
"server_name": "avm.example.com",
"username": "administrator"
}
Password of the account.
Port of the app volumes manager to connect to.
App Volumes Manager's server name or IP address.
Username to login to App Volumes Manager
App volumes manager object to be updated.
{
"certificate_override": {
"certificate": "string",
"type": "PEM"
},
"password": [
"<password>"
],
"port": 443,
"server_name": "avm.example.com",
"username": "administrator"
}
Password of the account.
Port of the app volumes manager to connect to.
App Volumes Manager's server name or IP address.
Username to login to App Volumes Manager
Anti-affinity data required to create an application pool.
{
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
}
Maximum number of other applications that can be running on the RDS Server before the RDS Server is rejected for new application sessions.
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.
Information about Application.
{
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"publisher": "Mozilla Corporation",
"version": "72.0.2"
}
Path to application executable.
Application publisher.
Application version.
Information about the file type supported by the application.
{
"description": "Firefox Document",
"type": ".html"
}
Friendly name for the file type. If unset, no friendly name will be displayed.
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.
Icon id to be associated with the application pool.
{
"icon_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"
}
Unique ID representing an application icon.
Specification for associating application icon to list of application pools.
{
"application_pool_ids": [
"855ea6c5-720a-41e1-96f4-958c90e6e424",
"1453c2a3-e549-4301-af12-d62210d18d54"
],
"icon_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51"
}
An application icon could be shared by multiple application pools. This is a set of application pool IDs this icon represents.
Unique ID representing an application icon.
Application icon object to be created.
{
"data": "string",
"height": 16,
"width": 16
}
Icon image data in PNG format. This is the Base64 encoded binary data of the image.
Icon height.
Icon width.
Application icon information.
{
"application_pool_ids": [
"855ea6c5-720a-41e1-96f4-958c90e6e424",
"1453c2a3-e549-4301-af12-d62210d18d54"
],
"data": "string",
"height": 16,
"icon_hash": "13a5d8a8410445b51edf45b6eee2cd8d",
"icon_source": "HORIZON_AGENT",
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"width": 16
}
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.
Icon image data in PNG format.
Icon height.
MD5 hash of icon image data, to enable quick icon lookup.
Source of the application icon. The icon can be from Machine/RDS Agent or custom icon.
- HORIZON_AGENT: When the icon is from machine/RDS agent.
- HORIZON_CONNECTION_SERVER: When the icon is uploaded by the administrator through connection server.
Unique ID representing application icon.
Icon width.
List of Application pool Ids
{
"application_pool_ids": [
"855ea6c5-720a-41e1-96f4-958c90e6e424",
"1453c2a3-e549-4301-af12-d62210d18d54"
]
}
An application icon could be shared by multiple application pools. This is a set of application pool IDs this icon represents.
Information about different file types supported by Application that can be passed from agent to client via Connection Server.
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
Friendly name for the file type. If unset, no friendly name will be displayed.
The name for other file type data.
Other file type currently supported.
- URL: URL scheme types supported by application.
- OTHER: Other scheme types supported by application.
Application pool object to be created.
{
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"description": "Application pool description.",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"max_multi_sessions": 5,
"multi_session_mode": "DISABLED",
"name": "Firefox",
"parameters": "-p myprofile",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
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.
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.
Notes about the application pool.
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.
The display name is the name that users will see in Horizon client. If the display name is left blank, it defaults to name.
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.
Whether to pre-launch the application. Default value is false.
Indicates whether the application pool is enabled. Default value is true
Path to application executable.
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.
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 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"
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
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 to pass to application when launching.
Application publisher
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.
Starting folder for application
Application version.
Application pool object to be created.
{
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_brokered": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"description": "Application pool description.",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"max_multi_sessions": 5,
"multi_session_mode": "DISABLED",
"name": "Firefox",
"parameters": "-p myprofile",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
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.
Indicates whether the application pool is cloud brokered. Default value is false.
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.
Notes about the application pool.
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.
The display name is the name that users will see in Horizon client. If the display name is left blank, it defaults to name.
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.
Whether to pre-launch the application. Default value is false.
Indicates whether the application pool is enabled. Default value is true
Path to application executable.
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.
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 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"
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
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 to pass to application when launching.
Application publisher
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.
Starting folder for application
Application version.
Application pool object to be created.
{
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"avm_shortcut_id": "1",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_brokered": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"description": "Application pool description.",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"max_multi_sessions": 5,
"multi_session_mode": "DISABLED",
"name": "Firefox",
"parameters": "-p myprofile",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
Shortcut ID of AVM managed application.
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.
Indicates whether the application pool is cloud brokered. Default value is false.
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.
Notes about the application pool.
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.
The display name is the name that users will see in Horizon client. If the display name is left blank, it defaults to name.
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.
Whether to pre-launch the application. Default value is false.
Indicates whether the application pool is enabled. Default value is true
Path to application executable.
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.
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 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"
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
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 to pass to application when launching.
Application publisher
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.
Starting folder for application
Application version.
Application pool object to be created.
{
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"app_launch_limit_enabled": "boolean",
"avm_shortcut_id": "1",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_brokered": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"description": "Application pool description.",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"max_multi_sessions": 5,
"multi_session_mode": "DISABLED",
"name": "Firefox",
"parameters": "-p myprofile",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
Indicates whether application launch limit is enabled for the application pool. Default value is false.
Shortcut ID of AVM managed application.
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.
Indicates whether the application pool is cloud brokered. Default value is false.
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.
Notes about the application pool.
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.
The display name is the name that users will see in Horizon client. If the display name is left blank, it defaults to name.
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.
Whether to pre-launch the application. Default value is false.
Indicates whether the application pool is enabled. Default value is true
Path to application executable.
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.
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 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"
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
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 to pass to application when launching.
Application publisher
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.
Starting folder for application
Application version.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"customized_icon_ids": [
"e8d7bf41-0fcd-477a-b7e0-1338b3868d26",
"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"
],
"description": "string",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"icon_ids": [
"200fd5fd-26d6-490e-b023-509cbe19c0ac",
"920b7766-87b4-4712-9dac-1e7afcba28a6"
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"max_multi_sessions": 5,
"multi_session_mode": "ENABLED_ENFORCED",
"name": "Firefox",
"parameters": "string",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
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'.
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.
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.
List of customized icon IDs associated with the application which the user has configured.
Notes about the application pool.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of the desktop pool from which this application pool is created. Either this or farm id will be set.
Supported Filters: 'Equals'.
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'. This property can be used for sorting.
Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.
Supported Filters: 'Equals'. This property can be used for sorting.
Whether to pre-launch the application.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the application pool is enabled.
Supported Filters: 'Equals'. This property can be used for sorting.
Path to application executable.
Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
ID of the farm from which this application pool is created. Either this or desktop pool id will be set.
Supported Filters: 'Equals'.
List of icon IDs associated with the application which are fetched from the agent.
Unique ID representing application pool.
Supported Filters: 'Equals'.
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 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'. This property can be used for sorting.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
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'. This property can be used for sorting.
Parameters to pass to application when launching.
Application publisher.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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.
Starting folder for application.
Application version.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"customized_icon_ids": [
"e8d7bf41-0fcd-477a-b7e0-1338b3868d26",
"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"
],
"description": "string",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"global_application_entitlement_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"icon_ids": [
"200fd5fd-26d6-490e-b023-509cbe19c0ac",
"920b7766-87b4-4712-9dac-1e7afcba28a6"
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"max_multi_sessions": 5,
"multi_session_mode": "ENABLED_ENFORCED",
"name": "Firefox",
"parameters": "string",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
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'.
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.
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.
List of customized icon IDs associated with the application which the user has configured.
Notes about the application pool.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of the desktop pool from which this application pool is created. Either this or farm id will be set.
Supported Filters: 'Equals'.
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'. This property can be used for sorting.
Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.
Supported Filters: 'Equals'. This property can be used for sorting.
Whether to pre-launch the application.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the application pool is enabled.
Supported Filters: 'Equals'. This property can be used for sorting.
Path to application executable.
Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
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 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'.
List of icon IDs associated with the application which are fetched from the agent.
Unique ID representing application pool.
Supported Filters: 'Equals'.
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 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'. This property can be used for sorting.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
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'. This property can be used for sorting.
Parameters to pass to application when launching.
Application publisher.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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.
Starting folder for application.
Application version.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_brokered": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"customized_icon_ids": [
"e8d7bf41-0fcd-477a-b7e0-1338b3868d26",
"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"
],
"description": "string",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"global_application_entitlement_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"icon_ids": [
"200fd5fd-26d6-490e-b023-509cbe19c0ac",
"920b7766-87b4-4712-9dac-1e7afcba28a6"
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"max_multi_sessions": 5,
"multi_session_mode": "ENABLED_ENFORCED",
"name": "Firefox",
"parameters": "string",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
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'.
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.
Indicates whether the application pool is cloud brokered.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
List of customized icon IDs associated with the application which the user has configured.
Notes about the application pool.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of the desktop pool from which this application pool is created. Either this or farm id will be set.
Supported Filters: 'Equals'.
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'. This property can be used for sorting.
Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.
Supported Filters: 'Equals'. This property can be used for sorting.
Whether to pre-launch the application.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the application pool is enabled.
Supported Filters: 'Equals'. This property can be used for sorting.
Path to application executable.
Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
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 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'.
List of icon IDs associated with the application which are fetched from the agent.
Unique ID representing application pool.
Supported Filters: 'Equals'.
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 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'. This property can be used for sorting.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
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'. This property can be used for sorting.
Parameters to pass to application when launching.
Application publisher.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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.
Starting folder for application.
Application version.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"avm_shortcut_id": "1",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_brokered": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"customized_icon_ids": [
"e8d7bf41-0fcd-477a-b7e0-1338b3868d26",
"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"
],
"description": "string",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"global_application_entitlement_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"icon_ids": [
"200fd5fd-26d6-490e-b023-509cbe19c0ac",
"920b7766-87b4-4712-9dac-1e7afcba28a6"
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"max_multi_sessions": 5,
"multi_session_mode": "ENABLED_ENFORCED",
"name": "Firefox",
"parameters": "string",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
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'.
Shortcut ID of AVM managed application.
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.
Indicates whether the application pool is cloud brokered.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
List of customized icon IDs associated with the application which the user has configured.
Notes about the application pool.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of the desktop pool from which this application pool is created. Either this or farm id will be set.
Supported Filters: 'Equals'.
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'. This property can be used for sorting.
Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.
Supported Filters: 'Equals'. This property can be used for sorting.
Whether to pre-launch the application.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the application pool is enabled.
Supported Filters: 'Equals'. This property can be used for sorting.
Path to application executable.
Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
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 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'.
List of icon IDs associated with the application which are fetched from the agent.
Unique ID representing application pool.
Supported Filters: 'Equals'.
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 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'. This property can be used for sorting.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
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'. This property can be used for sorting.
Parameters to pass to application when launching.
Application publisher.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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.
Starting folder for application.
Application version.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"app_launch_limit_enabled": "boolean",
"avm_shortcut_id": "1",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_brokered": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"customized_icon_ids": [
"e8d7bf41-0fcd-477a-b7e0-1338b3868d26",
"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"
],
"description": "string",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"global_application_entitlement_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"icon_ids": [
"200fd5fd-26d6-490e-b023-509cbe19c0ac",
"920b7766-87b4-4712-9dac-1e7afcba28a6"
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"max_multi_sessions": 5,
"multi_session_mode": "ENABLED_ENFORCED",
"name": "Firefox",
"parameters": "string",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
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'.
Indicates whether application launch limit is enabled for the application pool.
Supported Filters: 'Equals'. This property can be used for sorting.
Shortcut ID of AVM managed application.
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.
Indicates whether the application pool is cloud brokered.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
List of customized icon IDs associated with the application which the user has configured.
Notes about the application pool.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of the desktop pool from which this application pool is created. Either this or farm id will be set.
Supported Filters: 'Equals'.
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'. This property can be used for sorting.
Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.
Supported Filters: 'Equals'. This property can be used for sorting.
Whether to pre-launch the application.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the application pool is enabled.
Supported Filters: 'Equals'. This property can be used for sorting.
Path to application executable.
Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
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 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'.
List of icon IDs associated with the application which are fetched from the agent.
Unique ID representing application pool.
Supported Filters: 'Equals'.
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 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'. This property can be used for sorting.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
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'. This property can be used for sorting.
Parameters to pass to application when launching.
Application publisher.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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.
Starting folder for application.
Application version.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Application pool object to be updated.
{
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"description": "Application pool description.",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"max_multi_sessions": 5,
"multi_session_mode": "ENABLED_ENFORCED",
"parameters": "-p myprofile",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
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.
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.
Notes about the application pool.
The display name is the name that users will see in Horizon client.
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.
Whether to pre-launch the application.
Indicates whether the application pool is enabled.
Path to application executable.
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 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"
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Parameters to pass to application when launching.
Application publisher
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.
Starting folder for application
Application version.
Application pool object to be updated.
{
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_brokered": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"description": "Application pool description.",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"max_multi_sessions": 5,
"multi_session_mode": "ENABLED_ENFORCED",
"parameters": "-p myprofile",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
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.
Indicates whether the application pool is cloud brokered. Default value is false.
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.
Notes about the application pool.
The display name is the name that users will see in Horizon client.
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.
Whether to pre-launch the application.
Indicates whether the application pool is enabled.
Path to application executable.
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 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"
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Parameters to pass to application when launching.
Application publisher
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.
Starting folder for application
Application version.
Application pool object to be updated.
{
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"avm_shortcut_id": "1",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_brokered": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"description": "Application pool description.",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"max_multi_sessions": 5,
"multi_session_mode": "ENABLED_ENFORCED",
"parameters": "-p myprofile",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
Shortcut ID of AVM managed application.
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.
Indicates whether the application pool is cloud brokered. Default value is false.
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.
Notes about the application pool.
The display name is the name that users will see in Horizon client.
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.
Whether to pre-launch the application.
Indicates whether the application pool is enabled.
Path to application executable.
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 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"
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Parameters to pass to application when launching.
Application publisher
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.
Starting folder for application
Application version.
Application pool object to be updated.
{
"anti_affinity_data": {
"anti_affinity_count": 10,
"anti_affinity_patterns": [
"*pad.exe",
"*notepad.???"
]
},
"app_launch_limit_enabled": "boolean",
"avm_shortcut_id": "1",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_brokered": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"description": "Application pool description.",
"display_name": "Firefox",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"max_multi_sessions": 5,
"multi_session_mode": "ENABLED_ENFORCED",
"parameters": "-p myprofile",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"supported_file_types_data": {
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
},
"version": "72.0.2"
}
Indicates whether application launch limit is enabled for the application pool. Default value is false.
Shortcut ID of AVM managed application.
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.
Indicates whether the application pool is cloud brokered. Default value is false.
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.
Notes about the application pool.
The display name is the name that users will see in Horizon client.
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.
Whether to pre-launch the application.
Indicates whether the application pool is enabled.
Path to application executable.
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 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"
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Parameters to pass to application when launching.
Application publisher
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.
Starting folder for application
Application version.
Information about the file types supported by the application.
{
"enable_auto_update_file_types": true,
"enable_auto_update_other_file_types": true,
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
]
}
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.
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.
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.
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.
Extended attributes related to events.
{
"event_data": {
"AttrChangeType": "MODIFY",
"AttrName": "generalData.clientIdleSessionTimeoutMinutes",
"AttrValue": "15",
"UserDisplayName": "domain\\administrator"
},
"id": 1001
}
Key value pairs representing Extended attributes related to the event.
Unique id representing an event.
Information related to Audit Events.
Supported Filters : 'And', 'Or', 'Equals' and 'Between'.
See the field description to know the filter types it supports.
{
"application_pool_name": "calculator",
"desktop_pool_name": "manual pool",
"id": 1001,
"machine_dns_name": "broker.domain.com",
"machine_id": "3d78ef58-20a6-4f0e-923d-cb61938002bb",
"message": "Broker broker1 has started handling events",
"module": "Broker",
"severity": "AUDIT_SUCCESS",
"time": 1582181831000,
"type": "AGENT_CONNECTED",
"user_id": "S-1-5-21-1111111111-2222222222-3333333333-500"
}
Application Pool associated with this event. Will be unset if there is no application association for this event. Supported Filters : 'Equals'. This property can be used for sorting.
Desktop Pool associated with this event. Will be unset if there is no desktop association for this event. Supported Filters : 'Equals'. This property can be used for sorting.
Unique id representing an event. Supported Filters : 'Equals'.
FQDN of the machine in the Pod that has logged this event. Supported Filters : 'Equals'. This property can be used for sorting.
Machine associated with this event. Will be unset if there is no machine association for this event. Supported Filters : 'Equals'.
Audit event message.
Horizon component that has logged this event. Supported Filters : 'Equals'. This property can be used for sorting.
Severity type of the event. Supported Filters : 'Equals'. This property can be used for sorting.
- INFO: Audit event is of INFO severity.
- WARNING: Audit event is of WARNING severity
- ERROR: Audit event is of ERROR severity
- AUDIT_SUCCESS: Audit event is of AUDIT_SUCCESS severity
- AUDIT_FAIL: Audit event is of AUDIT_FAIL severity
- UNKNOWN: Not able to identify severity
Time at which the event occurred. Supported Filters : 'Between'. This property can be used for sorting.
Event name that corresponds to an item in the message catalog. Supported Filters : 'Equals'. This property can be used for sorting.
Sid of the user associated with this event. Supported Filters : 'Equals'.
Information related to Audit Events.
Supported Filters : 'And', 'Or', 'Equals' and 'Between'.
See the field description to know the filter types it supports.
{
"application_pool_name": "calculator",
"desktop_pool_name": "manual pool",
"id": 1001,
"machine_dns_name": "broker.domain.com",
"machine_id": "3d78ef58-20a6-4f0e-923d-cb61938002bb",
"message": "Broker broker1 has started handling events",
"module": "Broker",
"persistent_disk_id": "c1d5aec7-2126-3c55-aefa-11949003c9c2",
"severity": "AUDIT_SUCCESS",
"time": 1582181831000,
"type": "AGENT_CONNECTED",
"user_id": "S-1-5-21-1111111111-2222222222-3333333333-500"
}
Application Pool associated with this event. Will be unset if there is no application association for this event. Supported Filters : 'Equals'. This property can be used for sorting.
Desktop Pool associated with this event. Will be unset if there is no desktop association for this event. Supported Filters : 'Equals'. This property can be used for sorting.
Unique id representing an event. Supported Filters : 'Equals'.
FQDN of the machine in the Pod that has logged this event. Supported Filters : 'Equals'. This property can be used for sorting.
Machine associated with this event. Will be unset if there is no machine association for this event. Supported Filters : 'Equals'.
Audit event message.
Horizon component that has logged this event. Supported Filters : 'Equals'. This property can be used for sorting.
Persistent disk associated with this event.
Will be unset if there is no persistent disk association for this event. Supported Filters : 'Equals'.
Severity type of the event. Supported Filters : 'Equals'. This property can be used for sorting.
- INFO: Audit event is of INFO severity.
- WARNING: Audit event is of WARNING severity
- ERROR: Audit event is of ERROR severity
- AUDIT_SUCCESS: Audit event is of AUDIT_SUCCESS severity
- AUDIT_FAIL: Audit event is of AUDIT_FAIL severity
- UNKNOWN: Not able to identify severity
Time at which the event occurred. Supported Filters : 'Between'. This property can be used for sorting.
Event name that corresponds to an item in the message catalog. Supported Filters : 'Equals'. This property can be used for sorting.
Sid of the user associated with this event. Supported Filters : 'Equals'.
Login credentials needed for Authentication
{
"domain": "AD-TEST-DOMAIN",
"password": [
"<password>"
],
"username": "Administrator"
}
Domain
User password
User Name
Authentication Tokens
{
"access_token": "<jwt.access.token>",
"refresh_token": "<jwt.refresh.token>"
}
Access Token to be used in API calls.
Refresh Token to be used to get a new Access token.
Auxiliary service account credentials.
{
"id": "1f95a15c-a7a5-4584-963f-2c3f5355b49f",
"password": [
"<password>"
]
}
Auxiliary Service account ID.
Service account user password.
{
"type": "string"
}
Allowable values - And, Or, Not, NotEquals, Equals, Contains, StartsWith, EndsWith, Between.
Information related to VM snapshot.
{
"created_timestamp": 1582181947320,
"description": "Base image snapshot",
"disk_size_mb": 42949,
"hardware_version": 13,
"id": "snapshot-4",
"incompatible_reasons": [
"string"
],
"max_number_of_monitors": 1,
"max_resolution_of_any_one_monitor": "1600x1200",
"memory_mb": 4096,
"memory_reservation_mb": "integer",
"name": "Snapshot1",
"path": "/Snapshot1",
"renderer3d": "DISABLED",
"total_video_memory_mb": 8,
"vcenter_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"vgpu_type": "string"
}
Epoch time in milli seconds, when the VM snapshot was created. Supported Filters : 'Between', 'Equals'.
Description of the VM snapshot. Supported Filters : 'Equals'.
Sum of capacities of all the virtual disks in the VM snapshot, in MB. Supported Filters : 'Between','Equals'.
VM snapshot hardware version Supported Filters : 'Equals'.
Unique ID representing the VM snapshot. Supported Filters : 'Equals'.
Reasons that may preclude this VM snapshot from being used in linked/instant clone desktop pool or farm creation. Supported Filters : 'Equals'.
Maximum number of monitors set in SVGA settings for the VM snapshot in vCenter. Supported Filters : 'Equals'.
Maximum resolution of any one monitor set in SVGA settings for the VM snapshot in vCenter. Supported Filters : 'Equals'.
The physical memory size of VM snapshot, in MB Supported Filters : 'Equals'.
Amount of memory that is guaranteed available to the virtual machine, in MB. Supported Filters : 'Equals'.
VM snapshot name. Supported Filters : 'Equals','StartsWith', 'Contains'.
VM snapshot path. Supported Filters : 'Equals'.
Indicate how the virtual video device for the VM snapshot renders 3D graphics. Will be set only if VM snapshot supports 3D functions. Supported Filters : 'Equals'.
- AUTOMATIC: 3D rendering is automatic.
- DISABLED: 3D rendering is disabled.
- 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.
- MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.
- SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.
Total video memory in MB set in SVGA settings for the VM snapshot in vCenter. Supported Filters : 'Equals'.
Virtual Center id for this VM snapshot. Supported Filters : 'Equals'.
NVIDIA GRID vGPU type configured on this VM snapshot. Supported Filters : 'Equals'.
Information related to VM snapshot.
{
"created_timestamp": 1582181947320,
"description": "Base image snapshot",
"disk_size_mb": 42949,
"hardware_version": 13,
"id": "snapshot-4",
"incompatible_reasons": [
"string"
],
"max_number_of_monitors": 1,
"max_resolution_of_any_one_monitor": "1600x1200",
"memory_mb": 4096,
"memory_reservation_mb": "integer",
"name": "Snapshot1",
"num_cores_per_socket": 2,
"num_cpus": 4,
"path": "/Snapshot1",
"renderer3d": "DISABLED",
"total_video_memory_mb": 8,
"vcenter_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"vgpu_type": "string"
}
Epoch time in milli seconds, when the VM snapshot was created. Supported Filters : 'Between', 'Equals'.
Description of the VM snapshot. Supported Filters : 'Equals'.
Sum of capacities of all the virtual disks in the VM snapshot, in MB. Supported Filters : 'Between','Equals'.
VM snapshot hardware version Supported Filters : 'Equals'.
Unique ID representing the VM snapshot. Supported Filters : 'Equals'.
Reasons that may preclude this VM snapshot from being used in linked/instant clone desktop pool or farm creation. Supported Filters : 'Equals'.
Maximum number of monitors set in SVGA settings for the VM snapshot in vCenter. Supported Filters : 'Equals'.
Maximum resolution of any one monitor set in SVGA settings for the VM snapshot in vCenter. Supported Filters : 'Equals'.
The physical memory size of VM snapshot, in MB Supported Filters : 'Equals'.
Amount of memory that is guaranteed available to the virtual machine, in MB. Supported Filters : 'Equals'.
VM snapshot name. Supported Filters : 'Equals','StartsWith', 'Contains'.
Number of cores per socket present on the VM snapshot. Supported Filters : 'Equals'.
Number of CPUs present on the VM snapshot. Supported Filters : 'Equals'.
VM snapshot path. Supported Filters : 'Equals'.
Indicate how the virtual video device for the VM snapshot renders 3D graphics. Will be set only if VM snapshot supports 3D functions. Supported Filters : 'Equals'.
- AUTOMATIC: 3D rendering is automatic.
- DISABLED: 3D rendering is disabled.
- 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.
- MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.
- SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.
Total video memory in MB set in SVGA settings for the VM snapshot in vCenter. Supported Filters : 'Equals'.
Virtual Center id for this VM snapshot. Supported Filters : 'Equals'.
NVIDIA GRID vGPU type configured on this VM snapshot. Supported Filters : 'Equals'.
Information related to base VM.
{
"datacenter_id": "datacenter-1",
"id": "vm-416",
"incompatible_reasons": [
"string"
],
"name": "Win10",
"network_type": "STANDARD_NETWORK",
"operating_system": "WINDOWS_10",
"operating_system_display_name": "Microsoft Windows 10 (64-bit)",
"path": "/Datacenter/vm/VMs/Win10",
"vcenter_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e"
}
Datacenter id for this VM. Supported Filters : 'Equals'.
Unique ID representing a VM. Supported Filters : 'Equals'.
Reasons that may preclude this BaseVM from having its snapshots used in linked or instant clone desktop or farm creation. Supported Filters : 'Equals'.
VM name. Supported Filters : 'Equals','StartsWith','Contains'.
Type of network base VM belongs to. Supported Filters : 'Equals'.
- STANDARD_NETWORK: Standard network.
- OPAQUE_NETWORK: Opaque network.
- DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS port group.
Operating system. Supported Filters : 'Equals'.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
Operating system display name from Virtual Center. Supported Filters : 'Equals','StartsWith','Contains'.
VM path. Supported Filters : 'Equals','StartsWith','Contains'.
Virtual Center id for this VM. Supported Filters : 'Equals'.
Information related to base VM.
{
"datacenter_id": "datacenter-1",
"id": "vm-416",
"incompatible_reasons": [
"string"
],
"name": "Win10",
"network_type": "STANDARD_NETWORK",
"num_nics": 2,
"operating_system": "WINDOWS_10",
"operating_system_display_name": "Microsoft Windows 10 (64-bit)",
"path": "/Datacenter/vm/VMs/Win10",
"vcenter_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e"
}
Datacenter id for this VM. Supported Filters : 'Equals'.
Unique ID representing a VM. Supported Filters : 'Equals'.
Reasons that may preclude this BaseVM from having its snapshots used in linked or instant clone desktop or farm creation. Supported Filters : 'Equals'.
VM name. Supported Filters : 'Equals','StartsWith','Contains'.
Type of network base VM belongs to. Supported Filters : 'Equals'.
- STANDARD_NETWORK: Standard network.
- OPAQUE_NETWORK: Opaque network.
- DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS port group.
Number of network interface cards in a VM. Supported Filters : 'Equals'.
Operating system. Supported Filters : 'Equals'.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
Operating system display name from Virtual Center. Supported Filters : 'Equals','StartsWith','Contains'.
VM path. Supported Filters : 'Equals','StartsWith','Contains'.
Virtual Center id for this VM. Supported Filters : 'Equals'.
Information related to Blast Performance Data.
{
"audio_bytes_received": 1652079610000,
"audio_bytes_transmitted": 1652079610000,
"cdr_bytes_received": 1652079610000,
"cdr_bytes_transmitted": 1652079610000,
"imaging_bytes_received": 1652079610000,
"imaging_bytes_transmitted": 1652079610000,
"imaging_encoder_type": "test",
"imaging_frames_per_second": 1652079610000,
"session_bandwidth_uplink": 3872079619320,
"session_bytes_transmitted": 1652079610000,
"session_packet_loss_uplink": 1652079610000,
"session_round_trip_time": 1652079610000
}
The number of bytes of audio data that have been received.
The number of bytes of audio data that have been transmitted.
The number of bytes of CDR data that have been received.
The number of bytes of CDR data that have been transmitted.
The number of bytes of imaging data that have been received.
The number of bytes of imaging data that have been transmitted.
The codec value for Blast Performance Data
Number of image frames per second.
Uplink bandwidth averaged over the sampling period, in kilobits per second.
Transmitted bytes on the connection.
Network packet loss for uplink.
The round trip time in milliseconds between the server and the client.
Response for each of the entitlement operation for a resource in a bulk entitlement operation.
{
"details": [
{
"ad_user_or_group_id": "S-1-5-21-2898529287-1016622242-505487308-500",
"error_messages": [
"Entity does not exists.",
"Property is mandatory."
],
"errors": [
{
"error_key": "inventory.machine.not.found",
"error_message": "username cannot be empty"
}
],
"status_code": 200,
"timestamp": 1561939200000
}
],
"error_messages": [
"Entity does not exists.",
"Property is mandatory."
],
"errors": [
{
"error_key": "inventory.machine.not.found",
"error_message": "username cannot be empty"
}
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"status_code": 200,
"timestamp": 1561939200000
}
List of entitlement response info objects corresponding to each of the given ad-user-or-group SID.
Reasons for the failure of the operation. This field is deprecated since 2203 release.
Unique ID representing the resource for the entitlement operation.
Response HTTP status code of the operation.
Timestamp in milliseconds when the operation failed. Measured as epoch time.
Response corresponding to each pod in a bulk global session action operation.
{
"details": [
{
"error_messages": [
"Entity does not exist.",
"Property is mandatory."
],
"errors": [
{
"error_key": "inventory.machine.not.found",
"error_message": "username cannot be empty"
}
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"key": "user1",
"status_code": 200,
"timestamp": 1561939200000
}
],
"error_messages": [
"Entity does not exist."
],
"errors": [
{
"error_key": "inventory.machine.not.found",
"error_message": "username cannot be empty"
}
],
"pod_id": "54c122e0-d6b5-476c-af91-fd00392e5983",
"status_code": 200,
"timestamp": 1611939200000
}
List of BulkItemResponseInfo corresponding to each session id in the action operation.
Reasons for failure of the operation. This field is deprecated since 2203 release.
ID of the hosting pod for the sessions.
HTTP Status Code of the operation.
Timestamp in milliseconds when the operation failed. Measured as epoch time.
Response for each of the operation in a bulk operation.
{
"error_messages": [
"Entity does not exist.",
"Property is mandatory."
],
"errors": [
{
"error_key": "inventory.machine.not.found",
"error_message": "username cannot be empty"
}
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"key": "user1",
"status_code": 200,
"timestamp": 1561939200000
}
Reasons for the failure of the operation. This field is deprecated since 2203 release.
Unique ID representing the entity on which the operation was performed. Will not be populated for create operation if the operation fails.
Key on which the operation was performed.
Response HTTP status code of the operation.
Timestamp in milliseconds when the operation failed. Measured as epoch time.
Configuration information for the customer experience improvement program.
{
"company_size": "SIZE_1_100",
"enabled": true,
"geolocation": "ASIA_PACIFIC",
"vertical": "BANKING_FINANCE"
}
The size of the company.
- SIZE_1_100: Company size between 1 and 100.
- SIZE_101_500: Company size between 101 and 500.
- SIZE_501_1000: Company size between 501 and 1000.
- SIZE_1001_5000: Company size between 1001 and 5000.
- SIZE_5001_10000: Company size between 5001 and 10000.
- SIZE_10001: Company size greater than 10000.
Indicates whether to send information to VMware.
The geolocation of the company.
The vertical of the company.
CEIP object to be updated.
{
"company_size": "SIZE_1_100",
"enabled": true,
"geolocation": "ASIA_PACIFIC",
"vertical": "BANKING_FINANCE"
}
The size of the company.
- SIZE_1_100: Company size between 1 and 100.
- SIZE_101_500: Company size between 101 and 500.
- SIZE_501_1000: Company size between 501 and 1000.
- SIZE_1001_5000: Company size between 1001 and 5000.
- SIZE_5001_10000: Company size between 5001 and 10000.
- SIZE_10001: Company size greater than 10000.
Indicates whether to send information to VMware.
The geolocation of the company.
- AFRICA: Africa
- AMERICA_NORTH: North America
- AMERICA_SOUTH_CENTRAL: Central or South America
- ASIA_PACIFIC: Asia Pacific
- AUSTRALIA: Australia
- EUROPE: Europe
- MIDDLE_EAST: Middle East
The vertical of the company.
- AGRICULTURE: Agriculture
- BANKING_FINANCE: Banking and Finance
- BUSINESS_SERVICES: Business Services
- COMMUNICATIONS: Communications
- CONSTRUCTION: Construction
- EDUCATION: Education
- ENERGY_MINING: Energy and Mining
- GOV_FEDERAL_NATIONAL: Federal or National Government
- GOV_STATE_LOCAL: State or Local Government
- HEALTH_CARE: Health Care
- HIGH_TECH: High Tech
- LIFE_SCIENCES: Life Sciences
- MANUFACTURING_DISCRETE: Discrete Manufacturing
- MANUFACTURING_PROCESS: Manufacturing Processes
- MEDIA_ENTERTAINMENT: Media and Entertainment
- OTHER: Other
- PHARMACEUTICAL: Pharmaceutical
- RETAIL_WHOLESALE: Retail and Wholesale
- SERVICES: Services
- TRANSPORTATION: Transportation
- UTILITIES: Utilities
The specification for removing a pod from pod federation.
{
"pod_id": "9e94a90d-e7c2-40b6-a702-bd781512408d"
}
The ID of the pod that has to be removed from Pod Federation.
The specification for joining the pod federation.
{
"password": [
"<password>"
],
"remote_pod_address": "cs1.example.com",
"username": "AD-TEST-DOMAIN\\Administrator"
}
The password for the user.
The IP address or hostname for the remote pod.
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.
The specification for rotating CPA key pair.
{
"retain_latest_key_pair": 1
}
Number of key pairs to retain from existing generations of CPA key pair. Default value is 0.
CPA action response.
{
"task_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe"
}
Unique ID representing the task.
Pod Federation object to be updated.
{
"name": "Horizon Cloud Pod Federation"
}
Name of the pod federation.
Certificate information of the remote server.
{
"allow_admin_override": true,
"certificate": "<certificate>",
"certificate_encoding": "DER_BASE64_PEM",
"invalid_reasons": [
"NOT_TRUSTED",
"CANT_CHECK_REVOKED"
],
"ssl_cert_thumbprint": "<thumbprint>",
"ssl_cert_thumbprint_algorithm": "SHA-1",
"valid": true
}
Indicates if admin override is allowed.
The certificate in string form.
The encoding of the certificate.
The reason(s) why the certificate could not be validated.
A digest of the certificate.
Algorithm used to compute the thumbprint.
Indicates if certificate is valid.
Identifies the certificates of connection server.
{
"certificate_usage": "MACHINE",
"id": "a76b1ce3-5c12-ce90-449d-61a02f4e54b6"
}
Indicates how the certificate would be used.
- MACHINE: vdm certificates
- CLUSTER: vdm.ec certificates
Indicates the certificate Id.
Certificate information of connection server.
Supported Filters : 'And', 'Or' and 'Equals', 'StartsWithFilter' and 'ContainsFilter'.
See the field description to know the filter types it supports.
{
"certificate_usage": "MACHINE",
"dnssubject_alternative_names": [
"string"
],
"in_use": true,
"invalid_reasons": [
"NAME_MISMATCH",
"NOT_TRUSTED"
],
"is_valid": true,
"issuer_name": "CN=Horizon-server.example.local, OU=VMware Horizon View default certificate, O=VMware, Inc.",
"serial_number": "8e8fc36503833556",
"sha1_thumbprint": "0F:E0:80:6E:7E:0F:BA:EE:0E:BC:0E:A3:8D:FA:19:D8:BD:C0:5E:DF",
"signature_algorithm": "SHA384withRSA",
"subject_name": "CN=Horizon-server.example.local, OU=VMware Horizon View default certificate, O=VMware, Inc.",
"valid_from": "20221010113220",
"valid_until": "20250112113220"
}
Indicates how the certificate would be used.
Supported Filters: 'Equals'. This property can be used for sorting.
- MACHINE: vdm certificates
- CLUSTER: vdm.ec certificates
dnssubject_alternative_names
Indicates whether certificate is currently used by server or not.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates the reason for invalid certificate.
Indicates whether certificate is valid or not.
Supported Filters: 'Equals'. This property can be used for sorting.
Issuer name of certificate.
Serial number of certificate.
SHA1 thumbprint of certificate.
Signature algorithm of certificate.
Subject name of certificate.
Certificate valid from. Numeric version of ISO 8601 format.
Supported Filters: 'StartsWithFilter', 'ContainsFilter'. This property can be used for sorting.
Certificate valid until. Numeric version of ISO 8601 format.
Supported Filters: 'StartsWithFilter', 'ContainsFilter'. This property can be used for sorting.
Certificate information of connection server.
Supported Filters : 'And', 'Or' and 'Equals', 'StartsWithFilter' and 'ContainsFilter'.
See the field description to know the filter types it supports.
{
"certificate_usage": "MACHINE",
"deleted": "boolean",
"dnssubject_alternative_names": [
"string"
],
"id": "a76b1ce3-5c12-ce90-449d-61a02f4e54b6",
"in_use": true,
"invalid_reasons": [
"NAME_MISMATCH",
"NOT_TRUSTED"
],
"isDeleted": "boolean",
"is_valid": true,
"issuer_name": "CN=Horizon-server.example.local, OU=VMware Horizon View default certificate, O=VMware, Inc.",
"serial_number": "8e8fc36503833556",
"sha1_thumbprint": "0F:E0:80:6E:7E:0F:BA:EE:0E:BC:0E:A3:8D:FA:19:D8:BD:C0:5E:DF",
"signature_algorithm": "SHA384withRSA",
"subject_name": "CN=Horizon-server.example.local, OU=VMware Horizon View default certificate, O=VMware, Inc.",
"valid_from": "20221010113220",
"valid_until": "20250112113220"
}
Indicates how the certificate would be used.
Supported Filters: 'Equals'. This property can be used for sorting.
- MACHINE: vdm certificates
- CLUSTER: vdm.ec certificates
deleted
dnssubject_alternative_names
Id.
Indicates whether certificate is currently used by server or not.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates the reason for invalid certificate.
isDeleted
Indicates whether certificate is valid or not.
Supported Filters: 'Equals'. This property can be used for sorting.
Issuer name of certificate.
Serial number of certificate.
SHA1 thumbprint of certificate.
Signature algorithm of certificate.
Subject name of certificate.
Certificate valid from. Numeric version of ISO 8601 format.
Supported Filters: 'StartsWithFilter', 'ContainsFilter'. This property can be used for sorting.
Certificate valid until. Numeric version of ISO 8601 format.
Supported Filters: 'StartsWithFilter', 'ContainsFilter'. This property can be used for sorting.
Monitoring data about server's certificate.
{
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
}
Indicates if the certificate is valid.
Start time of the certificate validity in milliseconds. Measured as epoch time.
Expiration time of the certificate validity in milliseconds. Measured as epoch time.
Certificate details and type information, which can be used to override thumbprint details.
{
"certificate": "string",
"type": "PEM"
}
Virtual Center certificate
Type of Certificate.
- PEM: PEM encoded certificate type
- UNKNOWN: Unknown certificate type
Certificate details and type information, which can be used to override thumbprint details.
{
"certificate": "string",
"type": "PEM"
}
Virtual Center certificate
Type of Certificate.
- PEM: PEM encoded certificate type
- UNKNOWN: Unknown certificate type
Certificate details and type information, which can be used to override thumbprint details.
{
"certificate": "string",
"type": "PEM"
}
Virtual Center certificate
Type of Certificate.
- PEM: PEM encoded certificate type
- UNKNOWN: Unknown certificate type
Certificate properties.
{
"key_length": 2048,
"validity": 365
}
Certificate generation SSO Key length.
Certificate generation SSO key validity period in days.
Details of each certificate server.
{
"name": "SSOConnector",
"status": "OK"
}
Certificate Server name.
Certificate Server status.
- OK: The state of the certificate server is OK as reported by the enrollment servers.
- WARN: At least one enrollment server reports a warning on this certificate server.
- ERROR: At least one enrollment server reports an error on this certificate server.
Certificate Spec.
{
"certificate_chain": "<certificate in byte array format>",
"certificate_password": [
"password"
],
"certificate_usage": "MACHINE",
"format": "pem"
}
Certificate chain.
Password for pfx certificate type.
Indicates the type of certificate based on usage.
- MACHINE: vdm certificates
- CLUSTER: vdm.ec certificates
Certificate Type.
Information about the SSL Certificate thumbprints
{
"ssl_cert_thumbprint": "8f:92:9d:3b:a7:85:55:88:60:cd:e1:c8:1e:70:9a:8b:37:6d:a6:e6",
"ssl_cert_thumbprint_algorithm": "SHA_1"
}
A digest of the certificate.
Algorithm used to compute the thumbprint.
- SHA_1: SHA-1 hashing algorithm.
- SHA_256: SHA-256 hashing algorithm.
Certificate details and type information, which can be used to override thumbprint details.
{
"certificate": "string",
"type": "PEM"
}
Virtual Center certificate
Type of Certificate.
- PEM: PEM encoded certificate type
- UNKNOWN: Unknown certificate type
Client data associated with the session.
{
"address": "127.0.0.1",
"location_id": "6bda20e66cda315084edc8b5c67f9cf1e3b0f4559ba990b1004a",
"name": "EXAMPLE-CLIENT1",
"type": "WINDOWS",
"version": "5.4.0"
}
IP address of the client machine for the session. This property need not be set.
Supported Filters : 'Equals'. This property can be used for sorting.
Client location for the session. This property need not be set.
Supported Filters : 'Equals'.
Client machine hostname for the session. This property need not be set.
Supported Filters : 'Equals'. This property can be used for sorting.
Client type for the session. This property need not be set.
Supported Filters : 'Equals'. This property can be used for sorting.
- WINDOWS: Client type is Windows client.
- MAC: Client type is Mac client.
- HTMLACCESS: Client type is Web client.
- LINUX: Client type is Linux client.
- IOS: Client type is iOS client.
- ANDROID: Client type is Android client.
- OTHER: Client type is other.
Client version for the session. This property need not be set.
Supported Filters : 'Equals'. This property can be used for sorting.
Client key derivation spec.
{
"identifier": "V2luZG93c0xPQ0FUSU9OSUQ6NTIyNTI0NTM0NTM0NjM0MzQ2MzYzNDYzNjc1MzI0NjUyMzY3NDUyNzY1NDIzNjc1NDY3MjM1NDI0Mw==",
"nonce": "DaY+kne1X2B6h8a4gLZu2w==",
"public_key": "<public key>",
"supported_schemes": [
"SCHEME-AES2"
]
}
Identifier as Base64 encoded binary data.
Nonce as Base64 encoded binary data.
Diffie Hellman public key as Base64 encoded binary data.
List of client supported schemes for key derivation.
Information related to client policy
{
"enforcement_state": "REQUIRED",
"policy": "CERTIFICATE_VALIDATION",
"policy_values": [
"ENFORCE"
]
}
Enforcement State configured in server
- REQUIRED: Enforcement state is REQUIRED.
- PREFERRED: Enforcement state is PREFERRED.
- FREE: Enforcement state is FREE.
- UNKNOWN: Enforcement state is UNKNOWN.
Name of the client policy
- CERTIFICATE_VALIDATION: Client Policy is CERTIFICATE_VALIDATION.
- UNKNOWN: Client Policy is UNKNOWN.
List of policy values
Information required to update single client policy.
{
"enforcement_state": "REQUIRED",
"policy": "CERTIFICATE_VALIDATION",
"policy_values": [
"ENFORCE"
]
}
Enforcement State configured in server
- REQUIRED: Enforcement state is REQUIRED.
- PREFERRED: Enforcement state is PREFERRED.
- FREE: Enforcement state is FREE.
- UNKNOWN: Enforcement state is UNKNOWN.
Name of the client policy
- CERTIFICATE_VALIDATION: Client Policy is CERTIFICATE_VALIDATION.
- UNKNOWN: Client Policy is UNKNOWN.
List of policy values
Client properties of Security configuration.
{
"cipher_suites": [
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384"
],
"named_groups": [
"SECP384_R1",
"FFDHE_2048"
],
"signature_algorithms": [
"RSA_PSS_RSAE_SHA512",
"RSA_PKCS1_SHA512",
"ECDSA_SECP521R1_SHA512"
],
"thumbprint_algorithms": [
"SHA_512",
"SHA_384"
]
}
List of cipher suites of client.
List of named groups of client.
List of signature algorithms of client.
List of thumbprint algorithms of client.
Information related to client settings.
{
"client_policies": [
{
"enforcement_state": "REQUIRED",
"policy": "CERTIFICATE_VALIDATION",
"policy_values": [
"ENFORCE"
]
}
]
}
Client Settings object to be updated.
{
"client_policies": [
{
"enforcement_state": "REQUIRED",
"policy": "CERTIFICATE_VALIDATION",
"policy_values": [
"ENFORCE"
]
}
]
}
Information required to update client settings.
Information related to connection server GSS API configuration.
{
"allow_receiving_ntlm": "boolean",
"gss_apiauthenticator_id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"gss_apienabled": "boolean"
}
Indicates whether connection server supports NTLM or not.
ID of the GSS API authenticator to use.
Indicates whether GSSAPI authentication is enabled.
Information related to connection server GSS API configuration.
{
"gss_apienabled": "boolean"
}
Indicates whether GSSAPI authentication is enabled.
Information related to Connection Server.
{
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"jwt_info": {
"jwt_authenticator_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"jwt_support": "DISABLED"
}
}
Unique Id of the Connection Server.
Information related to Connection server.
{
"auxillary_external_pcoip_ipv4_address": "127.0.0.1:4172",
"bypass_app_blast_gateway": "boolean",
"bypass_pcoip_gateway": true,
"bypass_tunnel": "boolean",
"cluster_name": "Cluster-CS1",
"direct_htmlabsg": "boolean",
"disclose_service_principal_name": "boolean",
"enable_smart_card_user_name_hint": "boolean",
"enabled": true,
"external_appblast_url": "https://cs1.example.com:8443",
"external_pcoip_url": "127.0.0.1:4172",
"external_url": "https://cs1.example.com:443",
"fips_mode_enabled": "boolean",
"fqhn": "cs1.example.com",
"gss_apiinfo": {
"allow_receiving_ntlm": "boolean",
"gss_apiauthenticator_id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"gss_apienabled": "boolean"
},
"has_blast_gateway_support": true,
"has_pcoip_gateway_support": true,
"host_redirection": "boolean",
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"ip_mode": "IPv4",
"jwt_info": {
"jwt_authenticator_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"jwt_support": "DISABLED"
},
"ldap_backup_info": {
"backup_in_progress": "boolean",
"frequency_time": "DAY_1",
"last_ldap_backup_status": "OK",
"last_ldap_backup_time": 1652079610000,
"ldap_backup_folder": "C:\\ProgramData\\VMware\\VDM\\backups",
"max_number": 10,
"time_offset": "integer"
},
"load_balancer_hosts": [
"10.217.68.253",
"10.217.68.254"
],
"local_connection_server": true,
"logoff_when_remove_smart_card": "boolean",
"message_security_enhanced_mode_supported": "boolean",
"msg_security_public_key": "MIHwMIGoBgcqhkjOOAQBMIGcAkEA/KaCzo4Syrom78z3EQ5SbbB4sF7ey80etKII864WF64B81uRpH5t9jQTxeEu0Imbz\r\nRMqzVDZkVG9xD7nN1kuFwIVAJYu3cw2nLqOuyYO5rahJtk0bjjFAkBnhHGyepz0TukaScUUfbGpqvJE8FpDTWSGkx0tFCcbn\r\njUDC3H9c9oXkGmzLik1Yw4cIGI1TQ2iCmxBblC+eUykA0MAAkBTVayCjCDm9x1oPkzxvlRrn2ZJWJPnEAMvxnyBOA8rJ/uD0BkQ/iSV/Q3HoR5Mkwc/mMeMuo9VpLK0wgb0BUZ9",
"name": "cs1.example.com",
"radius_info": {
"radius_authenticator_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"radius_enabled": "boolean",
"radius_name_mapping": "boolean",
"radius_sso": "boolean"
},
"router_ssl_thumbprints": [
"d9:46:70:13:d1:1c:37:47:ba:c7:5f:9b:55:fc:e7:48:9b:1e:4b:ef:6c:62:bf:e7:0b:43:69:31:29:c0:b9:fa#SHA_256",
"74:84:31:a5:86:ce:b8:f6:f7:f4:8b:d5:de:b6:a9:f9:be:ce:62:06:7a:01:d8:f9:d1:19:ce:9b:2d:bf:e2:2c#SHA_256"
],
"rsa_secure_id_info": {
"clear_node_secret": "boolean",
"name_mapping": "boolean",
"secure_id_enabled": "boolean",
"security_file_uploaded": "boolean"
},
"saml_info": {
"saml_authenticator_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"saml_support": "DISABLED",
"workspace_one_block_old_clients": "boolean",
"workspace_one_host_name": "workspaceone.com",
"workspace_one_mode_enabled": "boolean"
},
"server_url": "https://cs1.example.com:443",
"smart_card_support": "OPTIONAL",
"smart_card_support_for_admin": "OFF",
"tags": [
"tag1",
"tag2"
],
"unauthenticated_access_info": {
"block_unsupported_clients": "boolean",
"client_puzzle_difficulty": 21,
"default_unauth_user_id": "11bd230b-87ce-3306-a943-810affe7b68a",
"enabled": "boolean",
"user_idle_timeout": 10
},
"version": "8.6.0-19754208"
}
This is set only if external_pcoip_url is set and contains a host part that represents an IPv6 address or DNS name. As 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. If bypass_pcoip_gateway is set to true, this property will not be set.
Indicates whether a bypassing blast secure gateway is enabled for this connection server instance. If this is set to true, web browsers make direct connections to Horizon machines bypassing connection server.
Indicates whether the PCoIP traffic bypasses the secure gateway.
Indicates whether a secure tunnel on this connection server instance is enabled. If 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, which carries RDP and other data over HTTPS. PCoIP and HTML Access connections use separate secure gateways.
Cluster name.
Indicates whether only HTML clients use blast secure gateway for this connection server instance. This property will not be set if bypass_appblast_gateway is set to false.
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.
Indicates whether username hints for smart card is enabled.
Indicate whether the connection server is enabled. A disabled connection server will not accept connection requests from Horizon Clients.
The Blast External URL enables browser access to Horizon machines through this connection server instance. To enable Blast, you must install HTML Access. The Blast External URL must not be load balanced. If bypass_appblast_gateway is set to true, this property will not be set.
Horizon Clients use the PCoIP External URL to establish a PCoIP connection through this Connection Server instance. The PCoIP External URL must not be load balanced. If bypass_pcoip_gateway is set to true, this property will not be set.
Horizon Clients use the External URL to establish a secure tunnel to this Connection Server instance. If a server name is specified, it must be resolvable by each Horizon Client. The External URL must not be load balanced. If bypass_tunnel is set to true, this property will not be set.
Indicates whether this server has FIPS mode enabled.
Fully qualified host name.
Indicates whether Blast gateway is supported or not.
Indicates whether PCoIP gateway is supported or not.
Indicates whether connection server supports HTTP host redirection.
Unique Id of the Connection Server.
Indicates the Connection Server IP environment.
- IPv4: The ip mode is IPv4.
- IPv6: The ip mode is IPv6.
List of load balancer host names or IP address.
Indicates whether this is the local connection server that handled the connection server service request.
Indicates whether user is logged off on removal of Smart Card.
Indicates whether ENHANCED message security mode is currently supported by this Connection Server.
The JMS message security public key.
Name of the Connection Server.
The JMS router SSL thumbprints
General URL for the connection server.
Smart Card support option.
- OPTIONAL: Indicates that the SmartCard usage is optional.
- REQUIRED: Indicates that the SmartCard usage is necessary.
- OFF: Indicates that the SmartCard usage is not allowed.
Indicates Smart card authentication configuration for administrators to login.
- OPTIONAL: Indicates that the SmartCard usage is optional.
- REQUIRED: Indicates that the SmartCard usage is necessary.
- OFF: Indicates that the SmartCard usage is not allowed.
Tags to restrict accessibility to desktop pools through this server.
unauthenticated_access_info
Version attribute to indicate functionalities supported by current connection server.
Information related to connection server JWT authentication settings.
{
"jwt_authenticator_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"jwt_support": "DISABLED"
}
List of configured JWT authenticators for this Connection Server.
JWT support option.
- DISABLED: Indicates that the JWT support is disabled.
- MULTI_ENABLED: Indicates that the JWT multi-auth support is enabled.
- MULTI_REQUIRED: Indicates that the JWT multi-auth support is mandatory.
Settings related to Connection Server JWT authentication
{
"jwt_authenticator_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"jwt_support": "DISABLED"
}
List of JWT authenticators to be configured for this Connection Server.
JWT support option. Possible values are "DISABLED", "MULTI_ENABLED", "MULTI_REQUIRED". If not present,default is "DISABLED".
- DISABLED: Indicates that the JWT support is disabled.
- MULTI_ENABLED: Indicates that the JWT multi-auth support is enabled.
- MULTI_REQUIRED: Indicates that the JWT multi-auth support is mandatory.
Information related to connection server LDAP backup.
{
"backup_in_progress": "boolean",
"frequency_time": "DAY_1",
"last_ldap_backup_status": "OK",
"last_ldap_backup_time": 1652079610000,
"ldap_backup_folder": "C:\\ProgramData\\VMware\\VDM\\backups",
"max_number": 10,
"time_offset": "integer"
}
backup_in_progress
Ldap Backup Frequency.
- HOUR_1: Backup every 1 hour.
- HOUR_6: Backup every 6 hours.
- HOUR_12: Backup every 12 hours.
- DAY_1: Backup every 1 day.
- DAY_2: Backup every 2 days.
- WEEK_1: Backup every 1 week.
- WEEK_2: Backup every 2 weeks.
- HOUR_0: Never Backup.
Last Ldap Backup Status.
- OK: Indicates that the status is OK.
- DISK_FULL: Indicates that Disk is full for LDAP to be backed up.
- UNABLE_TO_CREATE_DIR: Indicates that unable to create directory.
- ERROR_UNKNOWN: Indicates that the error is unknown.
Last Ldap Backup Time.
Location of the backup folder.
Maximum number of backups.
Ldap backup time offset in minutes
Information related to connection server LDAP backup.
{
"frequency_time": "DAY_1",
"ldap_backup_folder": "C:\\ProgramData\\VMware\\VDM\\backups",
"max_number": 10,
"time_offset": "integer"
}
Ldap Backup Frequency.
- HOUR_1: Backup every 1 hour.
- HOUR_6: Backup every 6 hours.
- HOUR_12: Backup every 12 hours.
- DAY_1: Backup every 1 day.
- DAY_2: Backup every 2 days.
- WEEK_1: Backup every 1 week.
- WEEK_2: Backup every 2 weeks.
- HOUR_0: Never Backup.
Location of the backup folder.
Maximum number of backups.
Ldap backup time offset in minutes
Replication status with respect to Peer Connection Servers in the same cluster.
{
"server_name": "cs1.example.com",
"status": "OK"
}
Connection Server host name or IP address.
LDAP replication status.
- OK: The connection to the Connection Server is working properly.
- ERROR: There is a problem with LDAP replication to the Connection Server.
Details of the Connection Server.
{
"build": "12345678.0.1",
"version": "7.9.0"
}
Connection Server build number.
Connection Server version number.
Monitoring information related to Connection Server.
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"connection_count": 1234,
"cs_replications": [
{
"server_name": "cs1.example.com",
"status": "OK"
}
],
"default_certificate": "boolean",
"details": {
"build": "12345678.0.1",
"version": "7.9.0"
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"name": "cs1.example.com",
"services": [
{
"service_name": "BLAST_SECURE_GATEWAY",
"status": "UP"
}
],
"session_protocol_data": [
{
"session_count": 341,
"session_protocol": "BLAST"
}
],
"session_threshold": 2000,
"status": "OK",
"tunnel_connection_count": 1234
}
Number of connections to this Connection Server.
Connection Server replication status with respect to the Peer Connection Servers in the same cluster.
Indicates whether server has the default certificate.
Unique ID of the Connection Server.
Connection Server host name or IP address.
Connection Server related Windows services information.
PCoIP, RDP or BLAST protocol sessions details when clients connect directly to the connection server.
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 of the Connection Server.
- OK: The Connection Server is working properly.
- ERROR: Error occurred when connecting to Connection Server.
- NOT_RESPONDING: The Connection Server is not responding.
- UNKNOWN: Status of Connection Server is unknown.
- RESTART_REQUIRED: Connection Server needs a Restart.
Number of connections tunneled through this Connection Server.
Monitoring information related to Connection Server.
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"connection_count": 1234,
"cs_replications": [
{
"server_name": "cs1.example.com",
"status": "OK"
}
],
"default_certificate": "boolean",
"details": {
"build": "12345678.0.1",
"version": "7.9.0"
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "cs1.example.com",
"services": [
{
"service_name": "BLAST_SECURE_GATEWAY",
"status": "UP"
}
],
"session_protocol_data": [
{
"session_count": 341,
"session_protocol": "BLAST"
}
],
"session_threshold": 2000,
"status": "OK",
"tunnel_connection_count": 1234
}
Number of connections to this Connection Server.
Connection Server replication status with respect to the Peer Connection Servers in the same cluster.
Indicates whether server has the default certificate.
Unique ID of the Connection Server.
The timestamp in milliseconds when the last update was obtained. Measured as epoch time.
Connection Server host name or IP address.
Connection Server related Windows services information.
PCoIP, RDP or BLAST protocol sessions details when clients connect directly to the connection server.
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 of the Connection Server.
- OK: The Connection Server is working properly.
- ERROR: Error occurred when connecting to Connection Server.
- NOT_RESPONDING: The Connection Server is not responding.
- UNKNOWN: Status of Connection Server is unknown.
- RESTART_REQUIRED: Connection Server needs a Restart.
Number of connections tunneled through this Connection Server.
Monitoring information related to Connection Server.
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"connection_count": 1234,
"cs_replications": [
{
"server_name": "cs1.example.com",
"status": "OK"
}
],
"default_certificate": "boolean",
"details": {
"build": "12345678.0.1",
"version": "7.9.0"
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "cs1.example.com",
"services": [
{
"service_name": "BLAST_SECURE_GATEWAY",
"status": "UP"
}
],
"session_protocol_data": [
{
"session_count": 341,
"session_protocol": "BLAST"
}
],
"session_threshold": 2000,
"status": "OK",
"tunnel_connection_count": 1234,
"unrecognized_pcoip_requests_count": 3,
"unrecognized_tunnel_requests_count": 4,
"unrecognized_xmlapi_requests_count": 5
}
Number of connections to this Connection Server.
Connection Server replication status with respect to the Peer Connection Servers in the same cluster.
Indicates whether server has the default certificate.
Unique ID of the Connection Server.
The timestamp in milliseconds when the last update was obtained. Measured as epoch time.
Connection Server host name or IP address.
Connection Server related Windows services information.
PCoIP, RDP or BLAST protocol sessions details when clients connect directly to the connection server.
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 of the Connection Server.
- OK: The Connection Server is working properly.
- ERROR: Error occurred when connecting to Connection Server.
- NOT_RESPONDING: The Connection Server is not responding.
- UNKNOWN: Status of Connection Server is unknown.
- RESTART_REQUIRED: Connection Server needs a Restart.
Number of connections tunneled through this Connection Server.
Number of unrecognized PCoIP secure gateway requests.
Number of unrecognized tunnel requests.
Number of unrecognized XML API requests.
Status of Connection Server related Windows service.
{
"service_name": "BLAST_SECURE_GATEWAY",
"status": "UP"
}
Service name of the Connection Server.
- PCOIP_SECURE_GATEWAY: PCoIP Secure Gateway service.
- BLAST_SECURE_GATEWAY: BLAST Secure Gateway service.
- SECURITY_GATEWAY_COMPONENT: Security Gateway Component service.
- CRL_PREFETCH: CRL prefetch service
Status of the service.
- UP: The Windows service is UP and running.
- DOWN: The Windows service is not UP.
- UNKNOWN: The Windows service state is Unknown.
Information related to connection server RADIUS authentication settings.
{
"radius_authenticator_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"radius_enabled": "boolean",
"radius_name_mapping": "boolean",
"radius_sso": "boolean"
}
The RADIUS Authenticator to use.
Flag to specify if RADIUS authentication is enabled.
Flag to specify if RADIUS name mapping is enabled.
Flag to specify if RADIUS Windows Single Sign-On is enabled.
Information related to connection server RADIUS authentication settings.
{
"radius_authenticator_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"radius_enabled": "boolean",
"radius_name_mapping": "boolean",
"radius_sso": "boolean"
}
The RADIUS Authenticator to use.
Indicates whether RADIUS authentication is enabled.
Indicates whether RADIUS name mapping is enabled.
Indicates whether RADIUS Windows Single Sign-On is enabled.
Information related to Connection server RSA SecureId authentication settings.
{
"clear_node_secret": "boolean",
"name_mapping": "boolean",
"secure_id_enabled": "boolean",
"security_file_uploaded": "boolean"
}
When set to TRUE the SecureID node secret is cleared
Indicates how SecureID names map to AD usernames. It is false for not mapped.
Indicates whether SecureID authentication is required.
If SecureID sdconf.rec file is already uploaded. The client can never download the file.
Information related to Connection server RSA SecureId authentication settings.
{
"clear_node_secret": "boolean",
"name_mapping": "boolean",
"secure_id_enabled": "boolean",
"security_file_data": "string"
}
When set to TRUE the SecureID node secret is cleared
Indicates how SecureID names map to AD usernames. It is false for not mapped.
Indicates whether SecureID authentication is required.
Binary contents of the SecurID sdconf.rec file.
Information related to connection server SAML authentication settings.
{
"saml_authenticator_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"saml_support": "DISABLED",
"workspace_one_block_old_clients": "boolean",
"workspace_one_host_name": "workspaceone.com",
"workspace_one_mode_enabled": "boolean"
}
List of SamlAuthenticators to use.
SAML support option.
- DISABLED: Indicates that the SAML support is disabled.
- MULTI_ENABLED: Indicates that the SAML multi auth support is enabled.
- MULTI_REQUIRED: Indicates that the SAML multi auth support is mandatory.
Block old clients that don't support Workspace ONE mode.
The hostname of the Workspace ONE Server.
Indicates whether Workspace ONE mode is enabled.
Information related to connection server SAML authentication settings.
{
"saml_authenticator_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"saml_support": "DISABLED",
"workspace_one_block_old_clients": "boolean",
"workspace_one_host_name": "workspaceone.com",
"workspace_one_mode_enabled": "boolean"
}
List of SamlAuthenticators to use.
Indicates SAML support option configuration for the end user
- DISABLED: Indicates that the SAML support is disabled.
- MULTI_ENABLED: Indicates that the SAML multi auth support is enabled.
- MULTI_REQUIRED: Indicates that the SAML multi auth support is mandatory.
Indicates whether old clients that don't support Workspace ONE mode are blocked.
The hostname of the Workspace ONE Server.
Indicates whether Workspace ONE mode is enabled.
Details of connected session count for each session protocol.
{
"session_count": 341,
"session_protocol": "BLAST"
}
Number of active sessions launched using the protocol.
Protocol used in launching the session.
- PCOIP: Display protocol is PCoIP.
- RDP: Display protocol is RDP.
- BLAST: Display protocol is BLAST.
- CONSOLE: Display protocol is console.
- UNKNOWN: Display protocol is unknown.
CPA status for a connection server.
{
"id": "c617fd51-e118-4cae-970c-54a7144aaadc",
"message": "OK",
"message_code": "LMV_OP_OK",
"name": "CS1",
"pending_percentage": 80,
"status": "ENABLED"
}
Unique ID of the connection server to which this status pertains.
The CPA error message for the connection server if any, is populated, or a success message.
Message code of the message.
- LMV_OP_OK: Pod Federation operation is successful.
- LMV_OP_ERROR: Pod Federation operation failed.
- LMV_OP_ERROR_UNKNOWN: Pod Federation operation failed with unknown error.
- LMV_OP_CANNOT_APPLY_DATA: Pod Federation operation could not apply data.
- LMV_OP_CANNOT_APPLY_SCHEMA: Pod Federation operation could not apply schema.
- LMV_OP_FILESYSTEM_ERROR: Pod Federation operation encountered file system error.
- LMV_OP_NO_TIME_SYNC: Pod Federation operation encountered time synchronization error.
- LMV_OP_NO_PERMISSION: No permission to perform Pod Federation operation.
- LMV_OP_REPLICATION_ERROR: Pod Federation operation encountered replication error.
- LMV_OP_UNREACHABLE_SERVER: The server is unreachable to perform Pod Federation operation.
Name of the connection server.
Value between 0 and 100 representing CPA operation completion percentage when connection server status is pending.
CPA status of the connection server.
- ENABLED: CPA is enabled.
- DISABLED: CPA is disabled.
- PENDING: CPA is undergoing an operation related to initialization, uninitialization, joining, or unjoining.
- 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.
- DISABLE_ERROR: The connection server has failed to reach the DISABLED status in a timely manner.
Information related to connection server unauthenticated access settings.
{
"block_unsupported_clients": "boolean",
"client_puzzle_difficulty": 21,
"default_unauth_user_id": "11bd230b-87ce-3306-a943-810affe7b68a",
"enabled": "boolean",
"user_idle_timeout": 10
}
Block older clients which don't support client puzzles to prevent DOS attack on RDSH servers for Unauthenticated Access.
Client puzzle difficulty for DoS attack prevention for Unauthenticated Access. Higher difficulty might increase login time and affect user experience.
Default user for unauthenticated access in this connection server.
Indicates whether unauthenticated access is enabled in this connection server.
Unauthenticated Access user idle session timeout in minutes.
Information related to connection server unauthenticated access settings.
{
"block_unsupported_clients": "boolean",
"client_puzzle_difficulty": 21,
"default_unauth_user_id": "11bd230b-87ce-3306-a943-810affe7b68a",
"enabled": "boolean",
"user_idle_timeout": 10
}
Block older clients which don't support client puzzles to prevent DOS attack on RDSH servers for Unauthenticated Access.
Client puzzle difficulty for DoS attack prevention for Unauthenticated Access. Higher difficulty might increase login time and affect user experience. This property has a default value of 21
Default user for unauthenticated access in this connection server.
Indicates whether unauthenticated access is enabled in this connection server.
Unauthenticated Access user idle session timeout in minutes.
Connection Server object whose settings need to be updated.
{
"jwt_info": {
"jwt_authenticator_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"jwt_support": "DISABLED"
}
}
Connection Server object whose settings need to be updated.
{
"auxillary_external_pcoip_ipv4_address": "127.0.0.1:4172",
"bypass_app_blast_gateway": "boolean",
"bypass_pcoip_gateway": true,
"bypass_tunnel": "boolean",
"direct_htmlabsg": "boolean",
"disclose_service_principal_name": "boolean",
"enable_smart_card_user_name_hint": "boolean",
"enabled": true,
"external_appblast_url": "https://cs1.example.com:8443",
"external_pcoip_url": "127.0.0.1:4172",
"external_url": "https://cs1.example.com:443",
"gss_apiinfo": {
"gss_apienabled": "boolean"
},
"host_redirection": "boolean",
"jwt_info": {
"jwt_authenticator_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"jwt_support": "DISABLED"
},
"ldap_backup_info": {
"frequency_time": "DAY_1",
"ldap_backup_folder": "C:\\ProgramData\\VMware\\VDM\\backups",
"max_number": 10,
"time_offset": "integer"
},
"logoff_when_remove_smart_card": "boolean",
"radius_info": {
"radius_authenticator_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"radius_enabled": "boolean",
"radius_name_mapping": "boolean",
"radius_sso": "boolean"
},
"rsa_secure_id_info": {
"clear_node_secret": "boolean",
"name_mapping": "boolean",
"secure_id_enabled": "boolean",
"security_file_data": "string"
},
"saml_info": {
"saml_authenticator_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"saml_support": "DISABLED",
"workspace_one_block_old_clients": "boolean",
"workspace_one_host_name": "workspaceone.com",
"workspace_one_mode_enabled": "boolean"
},
"smart_card_support": "OFF",
"smart_card_support_for_admin": "OPTIONAL",
"tags": [
"tag1",
"tag2"
],
"unauthenticated_access_info": {
"block_unsupported_clients": "boolean",
"client_puzzle_difficulty": 21,
"default_unauth_user_id": "11bd230b-87ce-3306-a943-810affe7b68a",
"enabled": "boolean",
"user_idle_timeout": 10
}
}
This can be set only if external_pcoip_url is set and contains a host part that represents an IPv6 address or DNS name. As 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. If bypass_pcoip_gateway is set to true, this property will be ignored.
Indicates whether a bypassing blast secure gateway is enabled for this connection server instance. If this is set to true, web browsers make direct connections to Horizon machines bypassing connection server.
Indicates whether the PCoIP traffic bypasses the secure gateway.
Indicates whether a secure tunnel on this connection server instance is enabled. If 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, which carries RDP and other data over HTTPS. PCoIP and HTML Access connections use separate secure gateways.
Indicates whether only HTML clients use blast secure gateway for this connection server instance. This property will not be set if bypass_appblast_gateway is set to false.
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.
Indicates whether username hints for smart card is enabled.
Indicate whether the connection server is enabled. A disabled connection server will not accept connection requests from Horizon Clients.
The Blast External URL enables browser access to Horizon machines through this connection server instance. To enable Blast, you must install HTML Access. The Blast External URL must not be load balanced. If bypass_appblast_gateway is set to true, this property will be ignored.
Horizon Clients use the PCoIP External URL to establish a PCoIP connection through this Connection Server instance. The PCoIP External URL must not be load balanced. If bypass_pcoip_gateway is set to true, this property will be ignored.
Horizon Clients use the External URL to establish a secure tunnel to this Connection Server instance. If a server name is specified, it must be resolvable by each Horizon Client. The External URL must not be load balanced. If bypass_tunnel is set to true, this property will be ignored.
Indicates whether connection server supports HTTP host redirection.
Indicates whether user is logged off on removal of Smart Card.
Indicates whether the smart card is supported for client or not
- OPTIONAL: Indicates that the SmartCard usage is optional.
- REQUIRED: Indicates that the SmartCard usage is necessary.
- OFF: Indicates that the SmartCard usage is not allowed.
Indicates Smart card authentication configuration for administrators to login.
- OPTIONAL: Indicates that the SmartCard usage is optional.
- REQUIRED: Indicates that the SmartCard usage is necessary.
- OFF: Indicates that the SmartCard usage is not allowed.
Tags to restrict accessibility to desktop pools through this server.
unauthenticated_access_info
Response for generate CSR operation.
{
"csr": "MIIC8DCCAdgCAQAwfDF6MHgGA1UEAxNxqRkDxR4gWqAoe26YU1S4...XRdFpQPhpkDRQ13yeO+oq"
}
Generated CSR.
CSR Spec.
{
"certificate_usage": "MACHINE",
"dns_subject_alternative_names": [
"server.example.com",
"www.vmware.com"
],
"subject_name": "CN=Horizon-server.example.local, OU=VMware Horizon View default certificate, O=VMware, S=California, C=CALIFORNIA"
}
Indicates the type of certificate based on usage.
- MACHINE: vdm certificates
- CLUSTER: vdm.ec certificates
Subject alternative DNS names. If the 'certificateUsage' is set to 'CLUSTER', the cluster GUID can be provided in this field. If the cluster GUID is not provided in 'dnsSubjectAlternativeNames', the CSR generation process will automatically append it, along with the value provided in dnsSubjectAlternativeNames
Subject name. If the 'certificateUsage' is set to 'CLUSTER', the cluster GUID can be provided in this field. If the cluster GUID is not provided in the subject name, the CSR generation process will automatically append the cluster GUID to the 'dnsSubjectAlternativeNames' field, ensuring that the generated CSR is specific to the cluster and does not conflict with other clusters.
Information related to customization specification created in vCenter.
{
"description": "windows customization specification",
"guest_os": "Windows",
"id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"incompatible_reasons": [
"string"
],
"name": "windows specification"
}
Customization specification description.
Guest Operating system.
- UNKNOWN: Unknown
- WINDOWS: Windows
- LINUX: Linux
Unique ID representing the customization specification.
Reasons that may preclude this customization specification from being used in desktop pool creation.
Name of the customization specification.
Information related to datacenter.
{
"id": "datacenter-1",
"name": "datacenter",
"path": "/datacenter"
}
Unique ID representing a datacenter.
Name of the datacenter.
Datacenter path.
{
"capacity_mb": 946176,
"datacenter_id": "datacenter-1",
"datastore_ids": [
"datastore-29",
"datastore-12"
],
"free_space_mb": 88239,
"host_or_cluster_id": "domain-c15",
"id": "group-p1",
"name": "datastoreCluster1",
"path": "/DC/host/cls/datastoreCluster1",
"vcenter_id": "42e47f15-aad0-221a-b231-ea4a3a134ec9"
}
Maximum capacity of this datastore cluster, in MB.
ID of the datacenter for this datastore cluster.
IDs of datastores which are a part of this datastore cluster.
Available capacity of this datastore cluster, in MB.
ID of the host or cluster for this datastore cluster.
Unique ID representing this datastore cluster.
Datastore cluster name.
Datastore cluster path.
ID of the virtual center for this datastore cluster.
Information related to datastore.
{
"capacity_mb": 946176,
"datacenter_id": "datacenter-1",
"disk_type": "NON_SSD",
"file_system_type": "VMFS",
"free_space_mb": 88239,
"host_or_cluster_id": "domain-c85",
"id": "datastore-29",
"incompatible_reasons": [
"string"
],
"local_datastore": true,
"name": "Datastore1",
"number_of_vms": 15,
"path": "/Datacenter/host/Cluster/Datastore1",
"vcenter_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"vmfs_major_version": "5"
}
Maximum capacity of this datastore, in MB.
Datacenter id for this datastore.
Disk type of the datastore.
- SSD: Solid State Drive disk type.
- NON_SSD: NON-Solid State Drive disk type.
- UNKNOWN: Unknown disk type.
- NON_VMFS: NON-VMFS disk type.
File system type of the datastore.
- VMFS: Virtual Machine File System.
- NFS: Network File System.
- VSAN: vSAN File System.
- VVOL: Virtual Volumes.
- UNKNOWN: Unknown File System type.
Available capacity of this datastore, in MB.
Host or Cluster id for this datastore.
Unique ID representing the datastore.
Reasons that may preclude this Datastore from being used in desktop pool/farm.
Indicates if this datastore is local to a single host.
Datastore name.
Indicates the number of virtual machines the datastore has for desktop pool/farm when applicable
Datastore path.
Virtual Center id for this datastore.
The VMFS major version number.
Information related to datastore paths.
{
"id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"path": "\"[datastore1] ISO images\""
}
Unique ID representing the datastore path.
Datastore path.
Information about Datastore Space Requirement.
{
"disk_type": "string",
"max_size_disk_gb": 15,
"mid_size_disk_gb": 10,
"min_size_disk_gb": 5
}
Indicates the type of disk used for storage.
- OS: Disk to store operating system related data.
- REPLICA: Disk for placement of replica VMs created by instant clone engine.
Indicates maximum recommended disk space, in GB.
Indicates recommended disk space with 50% utilization, in GB.
Indicates minimum recommended disk space, in GB.
Datastore space requirement to be computed.
{
"base_snapshot_id": "snapshot-22",
"base_vm_id": "vm-34",
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"pool_size": "integer",
"source": "INSTANT_CLONE",
"type": "FARM",
"use_separate_replica_and_os_disk": "boolean",
"use_vsan": "boolean",
"user_assignment": "string",
"vcenter_id": "ed3f92f3-0eef-4bf1-a405-de69f138d382",
"vm_template_id": "vm-344"
}
Parent VM snapshot ID. Must be set if source is INSTANT_CLONE.
Parent VM ID. Must be set if source is INSTANT_CLONE.
Id of inventory resource for which space requirement is to be found. Can be desktop pool or farm id.
Desired size of the desktop pool or farm.
Source or provisioning type of machines.
- FULL_CLONE: Virtual Machines created from a vCenter Server template.
- INSTANT_CLONE: Virtual Machines created by instant clone engine.
Type of inventory resource for which space requirement is to be found.
- DESKTOP_POOL: Desktop pool inventory resource.
- FARM: Farm inventory resource.
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.
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 of the desktop pool. Will be ignored if type is FARM. Default value is FLOATING.
- DEDICATED: Dedicated user assignment.
- FLOATING: Floating user assignment.
ID of virtual center where parent VM or master image is present.
VM template ID. Must be set if source is FULL_CLONE.
Settings for ClonePrep customization. This setting is only applicable to instant clone desktop pools.
{
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
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.
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.
Instant Clone publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.
Settings for CLONE_PREP customization for instant clone desktop pool.
{
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "priming"
}
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.
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.
Instant Clone publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.
Settings for CLONE_PREP customization for Instant Clone desktop pool.
{
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "priming"
}
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.
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.
Instant Clone publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.
Desktop pool object to be created.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_multiple_user_assignments": "boolean",
"allow_rds_pool_multi_session_per_user": "boolean",
"automatic_user_assignment": true,
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_brokered": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "priming"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"description": "Desktop pool description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": "boolean",
"display_name": "ManualPool",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "DISABLED",
"session_collaboration_enabled": "boolean",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"enable_provisioning": true,
"enabled": true,
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"machines": [
"string"
],
"name": "ManualPool",
"naming_method": "SPECIFIED",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "UP_FRONT"
},
"provisioning_settings": {
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
},
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "TAKE_NO_POWER_ACTION",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30,
"session_timeout_policy": "DEFAULT"
},
"session_type": "DESKTOP",
"shortcut_locations_v2": [
"DESKTOP"
],
"source": "INSTANT_CLONE",
"specific_naming_settings": {
"num_unassigned_machines_kept_powered_on": 1,
"specified_names": [
{
"name": "machine1",
"user_id": "S-1-1-1-3965912346-1012345398-3123456564-123"
}
],
"start_machines_in_maintenance_mode": "boolean"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean"
}
],
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"type": "AUTOMATED",
"user_assignment": "DEDICATED",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
"view_storage_accelerator_settings": {
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean"
}
}
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.
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.
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 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.
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.
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.
Applicable To: RDS Desktop Pools with default value as false.
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.
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.
Description of the desktop pool.
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.
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 of the desktop pool. If the display name is left blank, it defaults to name.
display_protocol_settings
Client restrictions to be applied to the desktop pool.
Default value is false.
Applicable To: Automated desktop pools with default value as true.
Indicates whether provisioning is enabled.
Indicates whether the desktop pool is enabled for brokering. Default value is true.
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.
Applicable To: Manual desktop pools.
List of machines to add to this desktop pool during creation.
Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.
Applicable To: Automated desktop pool.
Naming method for the desktop pool. This is required for Automated desktop pools.
- SPECIFIED: List of specified names. All provisioning is done up-front.
- PATTERN: Naming pattern.
Network interface card settings for machines provisioned for this desktop.
pattern_naming_settings
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.
- APPLICATION: Only application sessions are supported.
- DESKTOP: Only desktop sessions are supported.
- DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
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.
Applicable To: Manual and Automated desktop pools.
Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.
- INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
- 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.
- VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.
specific_naming_settings
Applicable for Automated pools only with default value as true.
Applicable To: Managed Manual and Automated desktop pools with default value as VM.
Transparent page sharing scope for this Desktop Pool.
- DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
Type of the Desktop Pool.
- AUTOMATED: Automated Desktop Pool.
- MANUAL: Manual Desktop Pool.
- RDS: RDS Desktop Pool.
Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.
- DEDICATED: With dedicated assignment, a user returns to the same machine at each session.
- FLOATING: With floating assignment, a user may return to one of the available machines for the next session.
ID of the virtual center server.
This is required for all desktop pool except Unmanaged Manual and RDS desktop pool.
view_storage_accelerator_settings
Desktop pool object to be created.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_multiple_user_assignments": "boolean",
"allow_rds_pool_multi_session_per_user": "boolean",
"automatic_user_assignment": true,
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_brokered": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "priming"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"description": "Desktop pool description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": "boolean",
"display_name": "ManualPool",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "DISABLED",
"session_collaboration_enabled": "boolean",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"enable_provisioning": true,
"enabled": true,
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"machines": [
"string"
],
"name": "ManualPool",
"naming_method": "SPECIFIED",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "UP_FRONT"
},
"provisioning_settings": {
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
},
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "TAKE_NO_POWER_ACTION",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30,
"session_timeout_policy": "DEFAULT"
},
"session_type": "DESKTOP",
"shortcut_locations_v2": [
"DESKTOP"
],
"source": "INSTANT_CLONE",
"specific_naming_settings": {
"num_unassigned_machines_kept_powered_on": 1,
"specified_names": [
{
"name": "machine1",
"user_id": "S-1-1-1-3965912346-1012345398-3123456564-123"
}
],
"start_machines_in_maintenance_mode": "boolean"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean"
}
],
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"type": "AUTOMATED",
"user_assignment": "DEDICATED",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
"view_storage_accelerator_settings": {
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean"
}
}
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.
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.
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 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.
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.
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.
Applicable To: RDS Desktop Pools with default value as false.
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.
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.
Description of the desktop pool.
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.
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 of the desktop pool. If the display name is left blank, it defaults to name.
display_protocol_settings
Client restrictions to be applied to the desktop pool.
Default value is false.
Applicable To: Automated desktop pools with default value as true.
Indicates whether provisioning is enabled.
Indicates whether the desktop pool is enabled for brokering. Default value is true.
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.
Applicable To: Manual desktop pools.
List of machines to add to this desktop pool during creation.
Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.
Applicable To: Automated desktop pool.
Naming method for the desktop pool. This is required for Automated desktop pools.
- SPECIFIED: List of specified names. All provisioning is done up-front.
- PATTERN: Naming pattern.
Network interface card settings for machines provisioned for this desktop.
pattern_naming_settings
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.
- APPLICATION: Only application sessions are supported.
- DESKTOP: Only desktop sessions are supported.
- DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
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.
Applicable To: Manual and Automated desktop pools.
Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.
- INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
- 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.
- VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.
specific_naming_settings
Applicable for Automated pools only with default value as true.
Applicable To: Managed Manual and Automated desktop pools with default value as VM.
Transparent page sharing scope for this Desktop Pool.
- DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
Type of the Desktop Pool.
- AUTOMATED: Automated Desktop Pool.
- MANUAL: Manual Desktop Pool.
- RDS: RDS Desktop Pool.
Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.
- DEDICATED: With dedicated assignment, a user returns to the same machine at each session.
- FLOATING: With floating assignment, a user may return to one of the available machines for the next session.
ID of the virtual center server.
This is required for all desktop pool except Unmanaged Manual and RDS desktop pool.
view_storage_accelerator_settings
Desktop pool object to be created.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_multiple_user_assignments": "boolean",
"allow_rds_pool_multi_session_per_user": "boolean",
"automatic_user_assignment": true,
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_brokered": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "priming"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"description": "Desktop pool description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": "boolean",
"display_name": "ManualPool",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "DISABLED",
"session_collaboration_enabled": "boolean",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"enable_provisioning": true,
"enabled": true,
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"machines": [
"string"
],
"name": "ManualPool",
"naming_method": "SPECIFIED",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "UP_FRONT"
},
"provisioning_settings": {
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
},
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "TAKE_NO_POWER_ACTION",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30,
"session_timeout_policy": "DEFAULT"
},
"session_type": "DESKTOP",
"shortcut_locations_v2": [
"DESKTOP"
],
"source": "INSTANT_CLONE",
"specific_naming_settings": {
"num_unassigned_machines_kept_powered_on": 1,
"specified_names": [
{
"name": "machine1",
"user_id": "S-1-1-1-3965912346-1012345398-3123456564-123"
}
],
"start_machines_in_maintenance_mode": "boolean"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean"
}
],
"persistent_disk_drive_letter": "D",
"persistent_disk_size_mb": 2048,
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"redirect_windows_profile": "boolean",
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"type": "AUTOMATED",
"user_assignment": "DEDICATED",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
"view_storage_accelerator_settings": {
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean"
}
}
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.
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.
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 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.
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.
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.
Applicable To: RDS Desktop Pools with default value as false.
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.
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.
Description of the desktop pool.
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.
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 of the desktop pool. If the display name is left blank, it defaults to name.
display_protocol_settings
Client restrictions to be applied to the desktop pool.
Default value is false.
Applicable To: Automated desktop pools with default value as true.
Indicates whether provisioning is enabled.
Indicates whether the desktop pool is enabled for brokering. Default value is true.
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.
Applicable To: Manual desktop pools.
List of machines to add to this desktop pool during creation.
Name of the desktop pool. This property must contain only alphanumerics, underscores and dashes.
Applicable To: Automated desktop pool.
Naming method for the desktop pool. This is required for Automated desktop pools.
- SPECIFIED: List of specified names. All provisioning is done up-front.
- PATTERN: Naming pattern.
Network interface card settings for machines provisioned for this desktop.
pattern_naming_settings
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.
- APPLICATION: Only application sessions are supported.
- DESKTOP: Only desktop sessions are supported.
- DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
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.
Applicable To: Manual and Automated desktop pools.
Source of the Machines in this Desktop Pool. This is required for Manual and Automated desktop pools.
- INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
- 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.
- VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.
specific_naming_settings
Applicable for Automated pools only with default value as true.
Applicable To: Managed Manual and Automated desktop pools with default value as VM.
Transparent page sharing scope for this Desktop Pool.
- DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
Type of the Desktop Pool.
- AUTOMATED: Automated Desktop Pool.
- MANUAL: Manual Desktop Pool.
- RDS: RDS Desktop Pool.
Applicable To: Automated and Manual Desktop pools. User assignment scheme. This is required for Automated and Manual Desktop Pools.
- DEDICATED: With dedicated assignment, a user returns to the same machine at each session.
- FLOATING: With floating assignment, a user may return to one of the available machines for the next session.
ID of the virtual center server.
This is required for all desktop pool except Unmanaged Manual and RDS desktop pool.
view_storage_accelerator_settings
Customization settings.
{
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"quickprep_customization_settings": {
"post_synchronization_script_parameters": "p1 p2 p3",
"post_synchronization_script_path": "quickprep_postsync_script",
"power_off_script_parameters": "p1 p2 p3",
"power_off_script_path": "quickprep_poweroff_script"
},
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"view_composer_domain_account_id": "0ebb464a-8780-4860-924f-8b2d1d1b33ef"
}
Applicable To: Full/instant clone automated desktop pools.
Full clone and Instant Clone Engine Active Directory container for SysPrep and ClonePrep. This property can be used for sorting.
cloneprep_customization_settings
Type of customization to use. This property can be used for sorting.
- 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. - NONE: Applicable To: Full clone desktop pools.
No customization. - 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.
Whether to power on VMs after creation. This is the settings when customization will be done manually. This property can be used for sorting.
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
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. This property can be used for sorting.
Customization specification to use when Sysprep customization is requested.
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.
Applicable To: Automated desktop pool.
Customization settings for Automated desktop pool.
{
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "priming"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
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
Type of customization to use.
- 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. - NONE: Applicable To: Full clone desktop pools.
No customization. - 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.
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.
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.
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.
This is required when customization_type is set as SYS_PREP.
Customization specification to use when Sysprep customization is requested.
Applicable To: Automated desktop pools.
Customization settings for this desktop pool.
{
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "priming"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
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.
Applicable To: Instant Clone desktop pools.
The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone pool provisioning.
cloneprep_customization_settings
Type of customization to use.
- 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. - NONE: Applicable To: Full clone desktop pools.
No customization. - 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.
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.
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.
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.
This is required when customization_type is set as SYS_PREP.
Customization specification to use when Sysprep customization is requested.
Applicable To: Automated Desktop pool.
Customization settings for Automated desktop pool.
{
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "priming"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
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
Type of customization to use.
- 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. - NONE: Applicable To: Full clone desktop pools.
No customization. - 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.
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.
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.
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.
This is required when customization_type is set as SYS_PREP.
Customization specification to use when Sysprep customization is requested.
Applicable To: Automated desktop pools.
Customization settings for this desktop pool.
{
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "priming"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
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.
Applicable To: Instant Clone desktop pools.
The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone pool provisioning.
cloneprep_customization_settings
Type of customization to use.
- 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. - NONE: Applicable To: Full clone desktop pools.
No customization. - 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.
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.
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.
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.
This is required when customization_type is set as SYS_PREP.
Customization specification to use when Sysprep customization is requested.
Applicable To: Automated desktop pools.
Customization settings for this desktop pool.
{
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"quickprep_customization_settings": {
"post_synchronization_script_parameters": "p1 p2 p3",
"post_synchronization_script_path": "quickprep_postsync_script",
"power_off_script_parameters": "p1 p2 p3",
"power_off_script_path": "quickprep_poweroff_script"
},
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"view_composer_domain_account_id": "0ebb464a-8780-4860-924f-8b2d1d1b33ef"
}
Applicable To: Full/instant clone automated desktop pools.
Full clone and Instant Clone Engine Active Directory container for SysPrep and ClonePrep. This property can be used for sorting.
Applicable To: Instant Clone desktop pools.
The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone pool provisioning.
cloneprep_customization_settings
Type of customization to use. This property can be used for sorting.
- 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. - NONE: Applicable To: Full clone desktop pools.
No customization. - 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.
Whether to power on VMs after creation. This is the settings when customization will be done manually. This property can be used for sorting.
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
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. This property can be used for sorting.
Customization specification to use when Sysprep customization is requested.
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.
Settings for a Virtual Center datastore.
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
Id of the datastore.
Whether datastore represents a Storage DRS cluster.
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.
- NONE: No overcommit.
- CONSERVATIVE: Conservative.
- MODERATE: Moderate.
- AGGRESSIVE: Aggressive.
- UNBOUNDED: Unbounded.
Settings for a Virtual Center datastore.
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean"
}
Id of the datastore.
Applicable to full clone desktop pools with default value as false. Indicates whether datastore represents a Storage DRS cluster.
Settings for a Virtual Center datastore.
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean"
}
Id of the datastore.
Indicates whether datastore represents a Storage DRS cluster.
Desktop pool object to be deleted.
{
"delete_from_disk": "boolean"
}
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.
Settings for the networking protocol to display the remote machine.
{
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"grid_vgpus_enabled": "boolean",
"html_access_enabled": true,
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "true",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile",
"vram_size_mb": 64
}
Indicates whether the users can choose the protocol. Default value is true. This property can be used for sorting.
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. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
List of supported display protocols for this desktop pool.Default value is [PCOIP, RDP, BLAST].
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. This property can be used for sorting.
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. This property can be used for sorting.
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. This property can be used for sorting.
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. This property can be used for sorting.
- UHD: 3840x2160 resolution.
- UHD_5K: 5120x2880 resolution.
- UHD_8K: 7680x4320 resolution.
- WQXGA: 2560x1600 resolution.
- WSXGA_PLUS: 1680x1050 resolution.
- WUXGA: 1920x1200 resolution.
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. This property can be used for sorting.
- AUTOMATIC: 3D rendering is automatic.
- DISABLED: 3D rendering is disabled.
- 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.
- MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.
- SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.
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. This property can be used for sorting.
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. This property can be used for sorting.
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. This property can be used for sorting.
Applicable To: Automated and Manual desktop pool.
Display protocol settings for Automated and Manual desktop pool.
{
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "DISABLED",
"session_collaboration_enabled": "boolean",
"vram_size_mb": 64
}
Indicates whether the users can choose the protocol. Default value is true.
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.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
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.
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.
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.
- UHD: 3840x2160 resolution.
- UHD_5K: 5120x2880 resolution.
- UHD_8K: 7680x4320 resolution.
- WQXGA: 2560x1600 resolution.
- WSXGA_PLUS: 1680x1050 resolution.
- WUXGA: 1920x1200 resolution.
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.
- AUTOMATIC: 3D rendering is automatic.
- DISABLED: 3D rendering is disabled.
- 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.
- MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.
- SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.
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 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.
Applicable To: Automated and Manual desktop pool.
Display protocol setting for Automated and Manual desktop pool.
{
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "DISABLED",
"session_collaboration_enabled": "boolean",
"vram_size_mb": 64
}
Indicates whether the users can choose the protocol.
The default display protocol for the desktop pool.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
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.
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.
- UHD: 3840x2160 resolution.
- UHD_5K: 5120x2880 resolution.
- UHD_8K: 7680x4320 resolution.
- WQXGA: 2560x1600 resolution.
- WSXGA_PLUS: 1680x1050 resolution.
- WUXGA: 1920x1200 resolution.
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.
- AUTOMATIC: 3D rendering is automatic.
- DISABLED: 3D rendering is disabled.
- 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.
- MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.
- SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.
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 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.
Information related to Desktop Pool.
{
"description": "Desktop pool description",
"display_name": "pool",
"enabled": true,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"name": "sales-pool1",
"settings": {
"allow_mutilple_sessions_per_user": "boolean",
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"delete_in_progress": "boolean",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"grid_vgpus_enabled": "boolean",
"html_access_enabled": true,
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "true",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30
},
"session_type": "DESKTOP",
"shortcut_locations": [
"Desktop"
]
},
"source": "INSTANT_CLONE",
"type": "AUTOMATED"
}
Description of the Desktop Pool. The maximum length is 1024 characters.
Display name of the Desktop Pool. The maximum length is 256 characters.
Indicates whether the Desktop Pool is enabled for brokering.
Unique ID representing Desktop Pool.
Name of the Desktop Pool. The maximum length is 64 characters.
Source of the Machines in this Desktop Pool.
- INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
- 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.
- VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.
Type of the Desktop Pool.
- AUTOMATED: Automated Desktop Pool.
- MANUAL: Manual Desktop Pool.
- RDS: RDS Desktop Pool.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_multiple_user_assignments": true,
"allow_rds_pool_multi_session_per_user": "boolean",
"automatic_user_assignment": "boolean",
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"quickprep_customization_settings": {
"post_synchronization_script_parameters": "p1 p2 p3",
"post_synchronization_script_path": "quickprep_postsync_script",
"power_off_script_parameters": "p1 p2 p3",
"power_off_script_path": "quickprep_poweroff_script"
},
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"view_composer_domain_account_id": "0ebb464a-8780-4860-924f-8b2d1d1b33ef"
},
"delete_in_progress": "boolean",
"description": "Desktop pool description",
"display_assigned_machine_name": "boolean",
"display_name": "pool",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"grid_vgpus_enabled": "boolean",
"html_access_enabled": true,
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "true",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"enable_provisioning": true,
"enabled": true,
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"image_source": "VIRTUAL_CENTER",
"name": "sales-pool1",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "ON_DEMAND"
},
"provisioning_settings": {
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"min_ready_vms_on_vcomposer_maintenance": 10,
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_operation": "NONE",
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_push_image_settings": {
"add_virtual_tpm": "boolean",
"logoff_policy": "WAIT_FOR_LOGOFF",
"start_time": 1587081283000,
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000
},
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30
},
"session_type": "DESKTOP",
"shortcut_locations": [
"Desktop"
],
"source": "INSTANT_CLONE",
"specific_naming_settings": {
"num_machines": 10,
"num_unassigned_machines_kept_powered_on": 1,
"start_machines_in_maintenance_mode": "boolean"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"non_persistent_disk_drive_letter": "Auto",
"non_persistent_disk_size_mb": 4096,
"non_persistent_redirect_disposable_files": true,
"persistent_disk_datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"persistent_disk_drive_letter": "D",
"persistent_disk_size_mb": 2048,
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"redirect_windows_profile": "boolean",
"replica_disk_datastore_id": "datastore-1",
"use_native_snapshots": "boolean",
"use_separate_datastores_persistent_and_os_disks": "boolean",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"type": "AUTOMATED",
"user_assignment": "DEDICATED",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
"view_storage_accelerator_settings": {
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean",
"view_storage_accelerator_disk_types": "OS_DISKS"
}
}
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'.
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'. This property can be used for sorting.
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. This property can be used for sorting.
Applicable To: Dedicated manual and automated desktop pools.
Automatic assignment of a user the first time they access the machine.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
Indicates whether the desktop pool is in the process of being deleted.Default value is false.
Supported Filters: 'Equals'. This property can be used for sorting.
Description of the Desktop Pool. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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'. This property can be used for sorting.
Display name of the Desktop Pool. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Client restrictions to be applied to the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
Applicable To: Automated desktop pools.
Whether provisioning is enabled.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the Desktop Pool is enabled for brokering.
Supported Filters: 'Equals'. This property can be used for sorting.
Applicable To: RDS desktop pools.
Farm needed to create RDS desktop pool.
Supported Filters: 'Equals'.
Unique ID representing Desktop Pool.
Supported Filters: 'Equals'.
Applicable To: Automated desktop pools.
Source of image used in the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- IMAGE_CATALOG: Image was created in image catalog.
- VIRTUAL_CENTER: Image was created in virtual center.
Name of the Desktop Pool. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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.
pattern_naming_settings
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'. This property can be used for sorting.
- APPLICATION: Only application sessions are supported.
- DESKTOP: Only desktop sessions are supported.
- DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
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.
Source of the Machines in this Desktop Pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
- 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.
- VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.
specific_naming_settings
Applicable To: Automated desktop pools.
Whether provisioning on all machines stops on error. This property can be used for sorting.
Applicable To: Manual and automated desktop pools.
The transparent page sharing scope. This property can be used for sorting.
- DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
Type of the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- AUTOMATED: Automated Desktop Pool.
- MANUAL: Manual Desktop Pool.
- RDS: RDS Desktop Pool.
Applicable To: Manual and automated desktop pools.
User assignment scheme.
Supported Filters: 'Equals'. This property can be used for sorting.
- DEDICATED: With dedicated assignment, a user returns to the same machine at each session.
- FLOATING: With floating assignment, a user may return to one of the available machines for the next session.
Applicable To: Manual and automated desktop pools.
Virtual Center that manages the machines of the desktop pool.
Supported Filters: 'Equals'.
view_storage_accelerator_settings
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_multiple_user_assignments": true,
"allow_rds_pool_multi_session_per_user": "boolean",
"automatic_user_assignment": "boolean",
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"quickprep_customization_settings": {
"post_synchronization_script_parameters": "p1 p2 p3",
"post_synchronization_script_path": "quickprep_postsync_script",
"power_off_script_parameters": "p1 p2 p3",
"power_off_script_path": "quickprep_poweroff_script"
},
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"view_composer_domain_account_id": "0ebb464a-8780-4860-924f-8b2d1d1b33ef"
},
"delete_in_progress": "boolean",
"description": "Desktop pool description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "pool",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"grid_vgpus_enabled": "boolean",
"html_access_enabled": true,
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "true",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"enable_provisioning": true,
"enabled": true,
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"global_desktop_entitlement_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"image_source": "VIRTUAL_CENTER",
"name": "sales-pool1",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "ON_DEMAND"
},
"provisioning_settings": {
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"min_ready_vms_on_vcomposer_maintenance": 10,
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_operation": "NONE",
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_push_image_settings": {
"add_virtual_tpm": "boolean",
"logoff_policy": "WAIT_FOR_LOGOFF",
"start_time": 1587081283000,
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000
},
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30
},
"session_type": "DESKTOP",
"shortcut_locations": [
"Desktop"
],
"source": "INSTANT_CLONE",
"specific_naming_settings": {
"num_machines": 10,
"num_unassigned_machines_kept_powered_on": 1,
"start_machines_in_maintenance_mode": "boolean"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"non_persistent_disk_drive_letter": "Auto",
"non_persistent_disk_size_mb": 4096,
"non_persistent_redirect_disposable_files": true,
"persistent_disk_datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"persistent_disk_drive_letter": "D",
"persistent_disk_size_mb": 2048,
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"redirect_windows_profile": "boolean",
"replica_disk_datastore_id": "datastore-1",
"use_native_snapshots": "boolean",
"use_separate_datastores_persistent_and_os_disks": "boolean",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"type": "AUTOMATED",
"user_assignment": "DEDICATED",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
"view_storage_accelerator_settings": {
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean",
"view_storage_accelerator_disk_types": "OS_DISKS"
}
}
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'.
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'. This property can be used for sorting.
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. This property can be used for sorting.
Applicable To: Dedicated manual and automated desktop pools.
Automatic assignment of a user the first time they access the machine.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
Indicates whether the desktop pool is in the process of being deleted.Default value is false.
Supported Filters: 'Equals'. This property can be used for sorting.
Description of the Desktop Pool. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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'. This property can be used for sorting.
Decides the visibility of the machine alias to the user. This property can be used for sorting.
Display name of the Desktop Pool. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Client restrictions to be applied to the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
Applicable To: Automated desktop pools.
Whether provisioning is enabled.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the Desktop Pool is enabled for brokering.
Supported Filters: 'Equals'. This property can be used for sorting.
Applicable To: RDS desktop pools.
Farm needed to create RDS desktop pool.
Supported Filters: 'Equals'.
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'.
Unique ID representing Desktop Pool.
Supported Filters: 'Equals'.
Applicable To: Automated desktop pools.
Source of image used in the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- IMAGE_CATALOG: Image was created in image catalog.
- VIRTUAL_CENTER: Image was created in virtual center.
Name of the Desktop Pool. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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.
pattern_naming_settings
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'. This property can be used for sorting.
- APPLICATION: Only application sessions are supported.
- DESKTOP: Only desktop sessions are supported.
- DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
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.
Source of the Machines in this Desktop Pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
- 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.
- VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.
specific_naming_settings
Applicable To: Automated desktop pools.
Whether provisioning on all machines stops on error. This property can be used for sorting.
Applicable To: Manual and automated desktop pools.
The transparent page sharing scope. This property can be used for sorting.
- DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
Type of the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- AUTOMATED: Automated Desktop Pool.
- MANUAL: Manual Desktop Pool.
- RDS: RDS Desktop Pool.
Applicable To: Manual and automated desktop pools.
User assignment scheme.
Supported Filters: 'Equals'. This property can be used for sorting.
- DEDICATED: With dedicated assignment, a user returns to the same machine at each session.
- FLOATING: With floating assignment, a user may return to one of the available machines for the next session.
Applicable To: Manual and automated desktop pools.
Virtual Center that manages the machines of the desktop pool.
Supported Filters: 'Equals'.
view_storage_accelerator_settings
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_multiple_user_assignments": true,
"allow_rds_pool_multi_session_per_user": "boolean",
"automatic_user_assignment": "boolean",
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_brokered": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"quickprep_customization_settings": {
"post_synchronization_script_parameters": "p1 p2 p3",
"post_synchronization_script_path": "quickprep_postsync_script",
"power_off_script_parameters": "p1 p2 p3",
"power_off_script_path": "quickprep_poweroff_script"
},
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"view_composer_domain_account_id": "0ebb464a-8780-4860-924f-8b2d1d1b33ef"
},
"delete_in_progress": "boolean",
"description": "Desktop pool description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "pool",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"grid_vgpus_enabled": "boolean",
"html_access_enabled": true,
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "true",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"enable_provisioning": true,
"enabled": true,
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"global_desktop_entitlement_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"image_source": "VIRTUAL_CENTER",
"name": "sales-pool1",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "ON_DEMAND"
},
"provisioning_settings": {
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"min_ready_vms_on_vcomposer_maintenance": 10,
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_operation": "NONE",
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_push_image_settings": {
"add_virtual_tpm": "boolean",
"logoff_policy": "WAIT_FOR_LOGOFF",
"start_time": 1587081283000,
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000
},
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30
},
"session_type": "DESKTOP",
"shortcut_locations": [
"Desktop"
],
"source": "INSTANT_CLONE",
"specific_naming_settings": {
"num_machines": 10,
"num_unassigned_machines_kept_powered_on": 1,
"start_machines_in_maintenance_mode": "boolean"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"non_persistent_disk_drive_letter": "Auto",
"non_persistent_disk_size_mb": 4096,
"non_persistent_redirect_disposable_files": true,
"persistent_disk_datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"persistent_disk_drive_letter": "D",
"persistent_disk_size_mb": 2048,
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"redirect_windows_profile": "boolean",
"replica_disk_datastore_id": "datastore-1",
"use_native_snapshots": "boolean",
"use_separate_datastores_persistent_and_os_disks": "boolean",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"type": "AUTOMATED",
"user_assignment": "DEDICATED",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
"view_storage_accelerator_settings": {
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean",
"view_storage_accelerator_disk_types": "OS_DISKS"
}
}
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'.
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'. This property can be used for sorting.
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. This property can be used for sorting.
Applicable To: Dedicated manual and automated desktop pools.
Automatic assignment of a user the first time they access the machine.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
Indicates whether the desktop pool is in the process of being deleted.Default value is false.
Supported Filters: 'Equals'. This property can be used for sorting.
Description of the Desktop Pool. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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'. This property can be used for sorting.
Decides the visibility of the machine alias to the user. This property can be used for sorting.
Display name of the Desktop Pool. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Client restrictions to be applied to the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
Applicable To: Automated desktop pools.
Whether provisioning is enabled.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the Desktop Pool is enabled for brokering.
Supported Filters: 'Equals'. This property can be used for sorting.
Applicable To: RDS desktop pools.
Farm needed to create RDS desktop pool.
Supported Filters: 'Equals'.
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'.
Unique ID representing Desktop Pool.
Supported Filters: 'Equals'.
Applicable To: Automated desktop pools.
Source of image used in the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- IMAGE_CATALOG: Image was created in image catalog.
- VIRTUAL_CENTER: Image was created in virtual center.
Name of the Desktop Pool. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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.
pattern_naming_settings
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'. This property can be used for sorting.
- APPLICATION: Only application sessions are supported.
- DESKTOP: Only desktop sessions are supported.
- DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
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.
Source of the Machines in this Desktop Pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
- 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.
- VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.
specific_naming_settings
Applicable To: Automated desktop pools.
Whether provisioning on all machines stops on error. This property can be used for sorting.
Applicable To: Manual and automated desktop pools.
The transparent page sharing scope. This property can be used for sorting.
- DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
Type of the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- AUTOMATED: Automated Desktop Pool.
- MANUAL: Manual Desktop Pool.
- RDS: RDS Desktop Pool.
Applicable To: Manual and automated desktop pools.
User assignment scheme.
Supported Filters: 'Equals'. This property can be used for sorting.
- DEDICATED: With dedicated assignment, a user returns to the same machine at each session.
- FLOATING: With floating assignment, a user may return to one of the available machines for the next session.
Applicable To: Manual and automated desktop pools.
Virtual Center that manages the machines of the desktop pool.
Supported Filters: 'Equals'.
view_storage_accelerator_settings
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_multiple_user_assignments": true,
"allow_rds_pool_multi_session_per_user": "boolean",
"automatic_user_assignment": "boolean",
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_brokered": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"quickprep_customization_settings": {
"post_synchronization_script_parameters": "p1 p2 p3",
"post_synchronization_script_path": "quickprep_postsync_script",
"power_off_script_parameters": "p1 p2 p3",
"power_off_script_path": "quickprep_poweroff_script"
},
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"view_composer_domain_account_id": "0ebb464a-8780-4860-924f-8b2d1d1b33ef"
},
"delete_in_progress": "boolean",
"description": "Desktop pool description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "pool",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"grid_vgpus_enabled": "boolean",
"html_access_enabled": true,
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "true",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"enable_provisioning": true,
"enabled": true,
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"global_desktop_entitlement_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"image_source": "VIRTUAL_CENTER",
"name": "sales-pool1",
"naming_method": "SPECIFIED",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "ON_DEMAND"
},
"provisioning_settings": {
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"min_ready_vms_on_vcomposer_maintenance": 10,
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_operation": "NONE",
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_push_image_settings": {
"add_virtual_tpm": "boolean",
"logoff_policy": "WAIT_FOR_LOGOFF",
"start_time": 1587081283000,
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000
},
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30,
"session_timeout_policy": "DEFAULT"
},
"session_type": "DESKTOP",
"shortcut_locations_v2": [
"DESKTOP"
],
"source": "INSTANT_CLONE",
"specific_naming_settings": {
"num_machines": 10,
"num_unassigned_machines_kept_powered_on": 1,
"start_machines_in_maintenance_mode": "boolean"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"non_persistent_disk_drive_letter": "Auto",
"non_persistent_disk_size_mb": 4096,
"non_persistent_redirect_disposable_files": true,
"persistent_disk_datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"persistent_disk_drive_letter": "D",
"persistent_disk_size_mb": 2048,
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"redirect_windows_profile": "boolean",
"replica_disk_datastore_id": "datastore-1",
"use_native_snapshots": "boolean",
"use_separate_datastores_persistent_and_os_disks": "boolean",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"type": "AUTOMATED",
"user_assignment": "DEDICATED",
"user_group_count": 1,
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
"view_storage_accelerator_settings": {
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean",
"view_storage_accelerator_disk_types": "OS_DISKS"
}
}
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'.
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'. This property can be used for sorting.
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. This property can be used for sorting.
Applicable To: Dedicated manual and automated desktop pools.
Automatic assignment of a user the first time they access the machine.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
Indicates whether the desktop pool is in the process of being deleted.Default value is false.
Supported Filters: 'Equals'. This property can be used for sorting.
Description of the Desktop Pool. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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'. This property can be used for sorting.
Decides the visibility of the machine alias to the user. This property can be used for sorting.
Display name of the Desktop Pool. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Client restrictions to be applied to the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
Applicable To: Automated desktop pools.
Whether provisioning is enabled.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the Desktop Pool is enabled for brokering.
Supported Filters: 'Equals'. This property can be used for sorting.
Applicable To: RDS desktop pools.
Farm needed to create RDS desktop pool.
Supported Filters: 'Equals'.
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'.
Unique ID representing Desktop Pool.
Supported Filters: 'Equals'.
Applicable To: Automated desktop pools.
Source of image used in the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- IMAGE_CATALOG: Image was created in image catalog.
- VIRTUAL_CENTER: Image was created in virtual center.
Name of the Desktop Pool. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Naming method for the desktop pool. This property can be used for sorting.
- SPECIFIED: List of specified names. All provisioning is done up-front.
- PATTERN: Naming pattern.
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.
pattern_naming_settings
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'. This property can be used for sorting.
- APPLICATION: Only application sessions are supported.
- DESKTOP: Only desktop sessions are supported.
- DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
Locations of the category folder in the user's OS containing a shortcut to the desktop pool.
Source of the Machines in this Desktop Pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
- 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.
- VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.
specific_naming_settings
Applicable To: Automated desktop pools.
Whether provisioning on all machines stops on error. This property can be used for sorting.
Applicable To: Manual and automated desktop pools.
The transparent page sharing scope. This property can be used for sorting.
- DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
Type of the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- AUTOMATED: Automated Desktop Pool.
- MANUAL: Manual Desktop Pool.
- RDS: RDS Desktop Pool.
Applicable To: Manual and automated desktop pools.
User assignment scheme.
Supported Filters: 'Equals'. This property can be used for sorting.
- DEDICATED: With dedicated assignment, a user returns to the same machine at each session.
- FLOATING: With floating assignment, a user may return to one of the available machines for the next session.
Count of user or group entitlements present for the desktop pool. This property can be used for sorting.
Applicable To: Manual and automated desktop pools.
Virtual Center that manages the machines of the desktop pool.
Supported Filters: 'Equals'.
view_storage_accelerator_settings
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_multiple_user_assignments": true,
"allow_rds_pool_multi_session_per_user": "boolean",
"automatic_user_assignment": "boolean",
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_brokered": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"quickprep_customization_settings": {
"post_synchronization_script_parameters": "p1 p2 p3",
"post_synchronization_script_path": "quickprep_postsync_script",
"power_off_script_parameters": "p1 p2 p3",
"power_off_script_path": "quickprep_poweroff_script"
},
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"view_composer_domain_account_id": "0ebb464a-8780-4860-924f-8b2d1d1b33ef"
},
"delete_in_progress": "boolean",
"description": "Desktop pool description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "pool",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"grid_vgpus_enabled": "boolean",
"html_access_enabled": true,
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "true",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"enable_provisioning": true,
"enabled": true,
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"global_desktop_entitlement_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"image_source": "VIRTUAL_CENTER",
"name": "sales-pool1",
"naming_method": "SPECIFIED",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "ON_DEMAND"
},
"provisioning_settings": {
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"min_ready_vms_on_vcomposer_maintenance": 10,
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_operation": "NONE",
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_push_image_settings": {
"add_virtual_tpm": "boolean",
"logoff_policy": "WAIT_FOR_LOGOFF",
"start_time": 1587081283000,
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000,
"pending_compute_profile_num_cores_per_socket": 1,
"pending_compute_profile_num_cpus": 4,
"pending_compute_profile_ram_mb": 4096
},
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30,
"session_timeout_policy": "DEFAULT"
},
"session_type": "DESKTOP",
"shortcut_locations_v2": [
"DESKTOP"
],
"source": "INSTANT_CLONE",
"specific_naming_settings": {
"num_machines": 10,
"num_unassigned_machines_kept_powered_on": 1,
"start_machines_in_maintenance_mode": "boolean"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"non_persistent_disk_drive_letter": "Auto",
"non_persistent_disk_size_mb": 4096,
"non_persistent_redirect_disposable_files": true,
"persistent_disk_datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"persistent_disk_drive_letter": "D",
"persistent_disk_size_mb": 2048,
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"redirect_windows_profile": "boolean",
"replica_disk_datastore_id": "datastore-1",
"use_native_snapshots": "boolean",
"use_separate_datastores_persistent_and_os_disks": "boolean",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"type": "AUTOMATED",
"user_assignment": "DEDICATED",
"user_group_count": 1,
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
"view_storage_accelerator_settings": {
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean",
"view_storage_accelerator_disk_types": "OS_DISKS"
}
}
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'.
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'. This property can be used for sorting.
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. This property can be used for sorting.
Applicable To: Dedicated manual and automated desktop pools.
Automatic assignment of a user the first time they access the machine.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
Indicates whether the desktop pool is in the process of being deleted.Default value is false.
Supported Filters: 'Equals'. This property can be used for sorting.
Description of the Desktop Pool. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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'. This property can be used for sorting.
Decides the visibility of the machine alias to the user. This property can be used for sorting.
Display name of the Desktop Pool. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Client restrictions to be applied to the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
Applicable To: Automated desktop pools.
Whether provisioning is enabled.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the Desktop Pool is enabled for brokering.
Supported Filters: 'Equals'. This property can be used for sorting.
Applicable To: RDS desktop pools.
Farm needed to create RDS desktop pool.
Supported Filters: 'Equals'.
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'.
Unique ID representing Desktop Pool.
Supported Filters: 'Equals'.
Applicable To: Automated desktop pools.
Source of image used in the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- IMAGE_CATALOG: Image was created in image catalog.
- VIRTUAL_CENTER: Image was created in virtual center.
Name of the Desktop Pool. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Naming method for the desktop pool. This property can be used for sorting.
- SPECIFIED: List of specified names. All provisioning is done up-front.
- PATTERN: Naming pattern.
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.
pattern_naming_settings
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'. This property can be used for sorting.
- APPLICATION: Only application sessions are supported.
- DESKTOP: Only desktop sessions are supported.
- DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
Locations of the category folder in the user's OS containing a shortcut to the desktop pool.
Source of the Machines in this Desktop Pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
- 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.
- VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.
specific_naming_settings
Applicable To: Automated desktop pools.
Whether provisioning on all machines stops on error. This property can be used for sorting.
Applicable To: Manual and automated desktop pools.
The transparent page sharing scope. This property can be used for sorting.
- DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
Type of the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- AUTOMATED: Automated Desktop Pool.
- MANUAL: Manual Desktop Pool.
- RDS: RDS Desktop Pool.
Applicable To: Manual and automated desktop pools.
User assignment scheme.
Supported Filters: 'Equals'. This property can be used for sorting.
- DEDICATED: With dedicated assignment, a user returns to the same machine at each session.
- FLOATING: With floating assignment, a user may return to one of the available machines for the next session.
Count of user or group entitlements present for the desktop pool. This property can be used for sorting.
Applicable To: Manual and automated desktop pools.
Virtual Center that manages the machines of the desktop pool.
Supported Filters: 'Equals'.
view_storage_accelerator_settings
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_multiple_user_assignments": true,
"allow_rds_pool_multi_session_per_user": "boolean",
"automatic_user_assignment": "boolean",
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_brokered": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"quickprep_customization_settings": {
"post_synchronization_script_parameters": "p1 p2 p3",
"post_synchronization_script_path": "quickprep_postsync_script",
"power_off_script_parameters": "p1 p2 p3",
"power_off_script_path": "quickprep_poweroff_script"
},
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"view_composer_domain_account_id": "0ebb464a-8780-4860-924f-8b2d1d1b33ef"
},
"delete_in_progress": "boolean",
"description": "Desktop pool description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "pool",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"grid_vgpus_enabled": "boolean",
"html_access_enabled": true,
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "true",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"enable_provisioning": true,
"enabled": true,
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"global_desktop_entitlement_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"image_source": "VIRTUAL_CENTER",
"name": "sales-pool1",
"naming_method": "SPECIFIED",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "ON_DEMAND"
},
"provisioning_settings": {
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"min_ready_vms_on_vcomposer_maintenance": 10,
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_operation": "NONE",
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_push_image_settings": {
"add_virtual_tpm": "boolean",
"logoff_policy": "WAIT_FOR_LOGOFF",
"start_time": 1587081283000,
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000,
"pending_compute_profile_num_cores_per_socket": 1,
"pending_compute_profile_num_cpus": 4,
"pending_compute_profile_ram_mb": 4096
},
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30,
"session_timeout_policy": "DEFAULT"
},
"session_type": "DESKTOP",
"shortcut_locations_v2": [
"DESKTOP"
],
"source": "INSTANT_CLONE",
"specific_naming_settings": {
"num_machines": 10,
"num_unassigned_machines_kept_powered_on": 1,
"start_machines_in_maintenance_mode": "boolean"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"non_persistent_disk_drive_letter": "Auto",
"non_persistent_disk_size_mb": 4096,
"non_persistent_redirect_disposable_files": true,
"persistent_disk_datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"persistent_disk_drive_letter": "D",
"persistent_disk_size_mb": 2048,
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"redirect_windows_profile": "boolean",
"replica_disk_datastore_id": "datastore-1",
"use_native_snapshots": "boolean",
"use_separate_datastores_persistent_and_os_disks": "boolean",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"type": "AUTOMATED",
"user_assignment": "DEDICATED",
"user_group_count": 1,
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
"view_storage_accelerator_settings": {
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean",
"view_storage_accelerator_disk_types": "OS_DISKS"
}
}
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'.
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'. This property can be used for sorting.
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. This property can be used for sorting.
Applicable To: Dedicated manual and automated desktop pools.
Automatic assignment of a user the first time they access the machine.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the RDS desktop pool is cloud brokered. This property will be unset for non RDS desktop pools.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
Indicates whether the desktop pool is in the process of being deleted.Default value is false.
Supported Filters: 'Equals'. This property can be used for sorting.
Description of the Desktop Pool. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
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'. This property can be used for sorting.
Decides the visibility of the machine alias to the user. This property can be used for sorting.
Display name of the Desktop Pool. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Client restrictions to be applied to the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
Applicable To: Automated desktop pools.
Whether provisioning is enabled.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the Desktop Pool is enabled for brokering.
Supported Filters: 'Equals'. This property can be used for sorting.
Applicable To: RDS desktop pools.
Farm needed to create RDS desktop pool.
Supported Filters: 'Equals'.
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'.
Unique ID representing Desktop Pool.
Supported Filters: 'Equals'.
Applicable To: Automated desktop pools.
Source of image used in the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- IMAGE_CATALOG: Image was created in image catalog.
- VIRTUAL_CENTER: Image was created in virtual center.
Name of the Desktop Pool. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Naming method for the desktop pool. This property can be used for sorting.
- SPECIFIED: List of specified names. All provisioning is done up-front.
- PATTERN: Naming pattern.
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.
pattern_naming_settings
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'. This property can be used for sorting.
- APPLICATION: Only application sessions are supported.
- DESKTOP: Only desktop sessions are supported.
- DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
Locations of the category folder in the user's OS containing a shortcut to the desktop pool.
Source of the Machines in this Desktop Pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
- 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.
- VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.
specific_naming_settings
Applicable To: Automated desktop pools.
Whether provisioning on all machines stops on error. This property can be used for sorting.
Applicable To: Manual and automated desktop pools.
The transparent page sharing scope. This property can be used for sorting.
- DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
Type of the desktop pool.
Supported Filters: 'Equals'. This property can be used for sorting.
- AUTOMATED: Automated Desktop Pool.
- MANUAL: Manual Desktop Pool.
- RDS: RDS Desktop Pool.
Applicable To: Manual and automated desktop pools.
User assignment scheme.
Supported Filters: 'Equals'. This property can be used for sorting.
- DEDICATED: With dedicated assignment, a user returns to the same machine at each session.
- FLOATING: With floating assignment, a user may return to one of the available machines for the next session.
Count of user or group entitlements present for the desktop pool. This property can be used for sorting.
Applicable To: Manual and automated desktop pools.
Virtual Center that manages the machines of the desktop pool.
Supported Filters: 'Equals'.
view_storage_accelerator_settings
Settings for the push image operation.
{
"add_virtual_tpm": "boolean",
"logoff_policy": "WAIT_FOR_LOGOFF",
"start_time": 1587081283000,
"stop_on_first_error": true
}
Whether to add Virtual TPM device.
Determines when to perform the operation on machines which have an active session.
- 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.
- WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time.
Indicates that the operation should stop on first error.
Metrics related to desktop pool.
{
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"num_connected_sessions": 50,
"num_machines": 100,
"occupancy_count": 60
}
Unique ID of the desktop pool.
Number of connected sessions of the desktop pool.
Number of machines in the desktop pool.
Occupancy count for the desktop pool.
- For dedicated assignment desktop, it is the number of assigned machine count.
- For floating assignment desktop, it is the summation of the connected and disconnected sessions.
Network interface card settings for machines provisioned for this desktop pool.
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
The network interface card id for these settings.
The network interface card name.
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.
Any changes to these settings will be applicable only to machines provisioned after the change. Already provisioned machines will never have their network label assignments altered by this feature.
Applicable To: Instant clone desktop pool.
Network interface card settings for machines provisioned for the instant clone desktop pool.
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
The network interface card id for these settings.
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.
Applicable To: Instant Clone desktop pool.
Network interface card settings for machines provisioned for Instant Clone desktop pool.
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
The network interface card id for these settings.
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.
Any changes to these settings will be applicable only to machines provisioned after the change. Already provisioned machines will never have their network label assignments altered by this feature.
Specification for an individual network label assignment, stipulating the label and how many times it may be assigned to machines with this spec.
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
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.
The maximum number of times this network label can be assigned to a machine.
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.
- UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.
- LIMITED: The network label assignment specification has a limited number of labels to assign.
The network label name.
Specification for an individual network label assignment, stipulating the label and how many times it may be assigned to machines with this spec.
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
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.
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.
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.
- UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.
- LIMITED: The network label assignment specification has a limited number of labels to assign.
The network label id for this spec. This network label must not have any incompatibility reasons that would preclude it from automatic machine assignment.
Desktop Pool or Farm usage information for a given datastore.
{
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"name": "ICPool",
"other_datastore_names": [
"Datastore1",
"Datastore2"
],
"source": "INSTANT_CLONE",
"used_space_in_gb": 32,
"user_assignment": "DEDICATED"
}
Unique ID representing Desktop Pool.
Unique ID representing Farm.
Desktop Pool or Farm name.
Other datastore(s) in-use for this Desktop pool or Farm.
Source or provisioning type of machines.
- FULL_CLONE: Virtual Machines created from a vCenter Server template.
- INSTANT_CLONE: Virtual Machines created by instant clone engine.
Used capacity of the datastore (in GB) for this Desktop pool or Farm.
User assignment of the Desktop.
- DEDICATED: Dedicated user assignment.
- FLOATING: Floating user assignment.
Virtual Center provisioning settings for the automated desktop pool.
{
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"min_ready_vms_on_vcomposer_maintenance": 10,
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
}
Whether to add Virtual TPM device. This property can be used for sorting.
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 within which the desktop pool is configured.
Host or cluster where the machines are deployed in.
Applicable To: Full/instant clone automated desktop pools.
Image management stream used in desktop pool when Image Management feature is enabled.
Supported Filters: 'Equals'.
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'.
Applicable To: Linked clone automated desktop pools.
Minimum number of ready (provisioned) machines during View Composer maintenance operations. This property can be used for sorting.
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 to deploy the machines.
VM folder where the machines are deployed to.
Applicable To: Full clone automated desktop pools.
Template from which full clone machines are deployed.
Applicable To: Automated desktop pool.
Virtual center provisioning settings for Automated desktop pool.
{
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
}
Indicates whether to add Virtual TPM device.
Default value is false.
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 within which the desktop pool is configured.
Host or cluster where the machines are deployed in.
For Instant clone desktops it can only be set to a cluster id.
Applicable To: Automated desktop pools.
This is required when vm_template_id, parent_vm_id and base_snapshot_id are not set.
Applicable To: Automated desktop pools.
This is required when im_stream_Id is set.
This property can be set only when source is set to INSTANT_CLONE.
Resource pool to deploy the machines.
VM folder where the machines are deployed to.
Applicable To: Full clone desktop pools.
This is required if parent_vm_id and base_snapshot_id are not set.
Virtual center provisioning settings for automated desktop pool
{
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
}
Indicates whether to add Virtual TPM device.
Default value is false.
This property can be set only when source is set to INSTANT_CLONE, vm_template_id is unset and parent_vm_id is set.
Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones. If set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set.
Indicates the number of CPUs in the compute profile to be configured on clones. If set, this must be a multiple of compute_profile_num_cores_per_socket.
Indicates the RAM in MB in the compute profile to be configured on clones.
Datacenter within which the desktop pool is configured.
Host or cluster where the machines are deployed in.
For Instant clone desktops it can only be set to a cluster id.
Applicable To: Automated desktop pools.
This is required when vm_template_id, parent_vm_id and base_snapshot_id are not set.
Applicable To: Automated desktop pools.
This is required when im_stream_Id is set.
This property can be set only when source is set to INSTANT_CLONE.
Resource pool to deploy the machines.
VM folder where the machines are deployed to.
Applicable To: Full clone desktop pools.
This is required if parent_vm_id and base_snapshot_id are not set.
Applicable To: Automated desktop pool.
Virtual Center provisioning settings for automated desktop pool.
{
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"resource_pool_id": "resgroup-1",
"vm_template_id": "vm-1"
}
Host or cluster where the machines are deployed in.
Applicable To: Full clone desktop pools.
This is required when vm_template_id is not set.
Applicable To: Full clone desktop pools.
This is required when im_stream_id is set.
Resource pool to deploy the machines.
Applicable To: Full clone desktop pools.
Template from which full clone machines are deployed.
Virtual Center provisioning settings for the automated desktop pool.
{
"add_virtual_tpm": "boolean",
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"min_ready_vms_on_vcomposer_maintenance": 10,
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1",
"vm_template_id": "vm-1"
}
Whether to add Virtual TPM device. This property can be used for sorting.
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.
Indicates the number of cores per socket for the CPU in the compute profile configured on clones.
Indicates the number of CPUs in the compute profile configured on clones.
Indicates the RAM in MB in the compute profile configured on clones.
Datacenter within which the desktop pool is configured.
Host or cluster where the machines are deployed in.
Applicable To: Full/instant clone automated desktop pools.
Image management stream used in desktop pool when Image Management feature is enabled.
Supported Filters: 'Equals'.
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'.
Applicable To: Linked clone automated desktop pools.
Minimum number of ready (provisioned) machines during View Composer maintenance operations. This property can be used for sorting.
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 to deploy the machines.
VM folder where the machines are deployed to.
Applicable To: Full clone automated desktop pools.
Template from which full clone machines are deployed.
Provisioning status data about this automated desktop pool.
{
"instant_clone_current_image_state": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_operation": "NONE",
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_push_image_settings": {
"add_virtual_tpm": "boolean",
"logoff_policy": "WAIT_FOR_LOGOFF",
"start_time": 1587081283000,
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000
}
Applicable To: instant clone automated desktop pools.
This represents the state of the current image of this instant clone desktop pool. This property can be used for sorting.
- FAILED: This is the state of the current image if instant clone delete operation has failed or timed out.
- PENDING_UNPUBLISH: This is the state of the current image before instant clone delete or cluster edit or datastore(s) edit operation(s) begins.
- 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.
- 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.
Applicable To: instant clone automated desktop pools.
The operation that this instant clone desktop pool is undergoing. This property can be used for sorting.
- CANCEL_SCHEDULED_PUSH_IMAGE: The scheduled push operation on the desktop pool is being cancelled.
- FINAL_UNPUBLISH: A desktop pool has been deleted and is undergoing final unpublishing.
- INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the desktop pool.
- INITIAL_PUBLISH: The desktop pool has just been created and is undergoing initial publishing.
- NONE: There is no current operation on the desktop pool.
- SCHEDULE_PUSH_IMAGE: The push operation is scheduled on the desktop pool.
Applicable To: instant clone automated desktop pools.
Pending image management stream for instant clone desktop pools.
Supported Filters: 'Equals'.
Applicable To: instant clone automated desktop pools.
Pending image management tag for instant clone desktop pools
Supported Filters: 'Equals'.
Applicable To: instant clone automated desktop pools.
This represents the error message if publishing of push image operation is failed. This property can be used for sorting.
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.
Applicable To: instant clone automated desktop pools.
This represents the pending image publish progress in percentage for an instant clone desktop pool. This property can be used for sorting.
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.
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. This property can be used for sorting.
- FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.
- PENDING_PUBLISH: This is the initial transient state of the pending image before instant clone creation operation has started.
- PUBLISHING: This is the transient state of the pending image when creation of instant clone operation is going on.
- 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.
- 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.
- 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.
instant_clone_push_image_settings
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. This property can be used for sorting.
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. This property can be used for sorting.
Provisioning status data about this automated desktop pool.
{
"instant_clone_current_image_state": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_operation": "NONE",
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_push_image_settings": {
"add_virtual_tpm": "boolean",
"logoff_policy": "WAIT_FOR_LOGOFF",
"start_time": 1587081283000,
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000,
"pending_compute_profile_num_cores_per_socket": 1,
"pending_compute_profile_num_cpus": 4,
"pending_compute_profile_ram_mb": 4096
}
Applicable To: instant clone automated desktop pools.
This represents the state of the current image of this instant clone desktop pool. This property can be used for sorting.
- FAILED: This is the state of the current image if instant clone delete operation has failed or timed out.
- PENDING_UNPUBLISH: This is the state of the current image before instant clone delete or cluster edit or datastore(s) edit operation(s) begins.
- 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.
- 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.
Applicable To: instant clone automated desktop pools.
The operation that this instant clone desktop pool is undergoing. This property can be used for sorting.
- CANCEL_SCHEDULED_PUSH_IMAGE: The scheduled push operation on the desktop pool is being cancelled.
- FINAL_UNPUBLISH: A desktop pool has been deleted and is undergoing final unpublishing.
- INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the desktop pool.
- INITIAL_PUBLISH: The desktop pool has just been created and is undergoing initial publishing.
- NONE: There is no current operation on the desktop pool.
- SCHEDULE_PUSH_IMAGE: The push operation is scheduled on the desktop pool.
Applicable To: instant clone automated desktop pools.
Pending image management stream for instant clone desktop pools.
Supported Filters: 'Equals'.
Applicable To: instant clone automated desktop pools.
Pending image management tag for instant clone desktop pools
Supported Filters: 'Equals'.
Applicable To: instant clone automated desktop pools.
This represents the error message if publishing of push image operation is failed. This property can be used for sorting.
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.
Applicable To: instant clone automated desktop pools.
This represents the pending image publish progress in percentage for an instant clone desktop pool. This property can be used for sorting.
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.
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. This property can be used for sorting.
- FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.
- PENDING_PUBLISH: This is the initial transient state of the pending image before instant clone creation operation has started.
- PUBLISHING: This is the transient state of the pending image when creation of instant clone operation is going on.
- 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.
- 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.
- 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.
instant_clone_push_image_settings
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. This property can be used for sorting.
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. This property can be used for sorting.
Indicates the pending number of cores per socket for the CPU in the compute profile configured on clones.
Indicates the pending number of CPUs in the compute profile configured on clones.
Indicates the pending RAM in MB in the compute profile configured on clones.
Specification for the push image operation.
{
"add_virtual_tpm": "boolean",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"logoff_policy": "WAIT_FOR_LOGOFF",
"parent_vm_id": "vm-1",
"snapshot_id": "snapshot-1",
"start_time": 1587081283000,
"stop_on_first_error": true
}
Indicates whether to add Virtual TPM device. Default: false
New image management stream for the desktop pool.
Either parent VM and snapshot or image management stream and tag are to be specified.
New image management tag for the desktop pool. This must be a tag of the image management stream.
Determines when to perform the operation on machines which have an active session.
- 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.
- WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
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.
New base image snapshot for the desktop pool. This must be a snapshot of the parent VM.
When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time.
Indicates that the operation should stop on first error. Default: true
Specification for the push image operation.
{
"add_virtual_tpm": "boolean",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"logoff_policy": "WAIT_FOR_LOGOFF",
"machine_ids": [
"816d44cb-b486-3c97-adcb-cf3806d53657",
"414927f3-1a3b-3e4c-81b3-d39602f634dc"
],
"parent_vm_id": "vm-1",
"selective_push_image": true,
"snapshot_id": "snapshot-1",
"start_time": 1587081283000,
"stop_on_first_error": true
}
Indicates whether to add Virtual TPM device. Default: false
Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones. If set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set.
Indicates the number of CPUs in the compute profile to be configured on clones. If set, this must be a multiple of compute_profile_num_cores_per_socket.
Indicates the RAM in MB in the compute profile to be configured on clones.
New image management stream for the desktop pool.
Either parent VM and snapshot or image management stream and tag are to be specified.
New image management tag for the desktop pool. This must be a tag of the image management stream.
Determines when to perform the operation on machines which have an active session.
- 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.
- WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
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.
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.
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.
New base image snapshot for the desktop pool. This must be a snapshot of the parent VM.
When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time.
Indicates that the operation should stop on first error. Default: true
Settings for QuickPrep customization.
{
"post_synchronization_script_parameters": "p1 p2 p3",
"post_synchronization_script_path": "quickprep_postsync_script",
"power_off_script_parameters": "p1 p2 p3",
"power_off_script_path": "quickprep_poweroff_script"
}
Post synchronization script parameters.
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.
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.
Machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare.
{
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30
}
Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false. This property can be used for sorting.
Indicates whether the user can be allowed to reset or restart their machines. Default value is false. This property can be used for sorting.
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. This property can be used for sorting.
- DELETE: Delete the machine after user logoff.
- NEVER: Never delete or refresh the machine in the desktop pool.
- REFRESH: Refresh the machine after user logoff.
Disconnected sessions timeout (in minutes). Will be set when disconnected_session_timeout_policy is set to AFTER. This property can be used for sorting.
Log-off policy after disconnected session. Default value is NEVER. This property can be used for sorting.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
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. This property can be used for sorting.
Application empty session timeout policy. Default value is AFTER. This property can be used for sorting.
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.Default value is false. This property can be used for sorting.
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. This property can be used for sorting.
- ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.
- 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.
- 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.
- TAKE_NO_POWER_ACTION: No action will be taken when user logs off.
Whether and when to refresh the OS disks for dedicated-assignment, linked-clone and instant-clone machines.Default value is NEVER. This property can be used for sorting.
- ALWAYS: The OS disk is refreshed every time the user logs off.
- 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.
- 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.
- NEVER: The OS disk is never refreshed.
Regular interval at which to refresh the OS disk. Will be set when refresh_os_disk_after_logoff set to EVERY. This property can be used for sorting.
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. This property can be used for sorting.
Applicable To: Automated and Manual desktop pool.
Session related settings for Automated and Manual desktop pool.
{
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "TAKE_NO_POWER_ACTION",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30,
"session_timeout_policy": "DEFAULT"
}
Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false.
Indicates whether the user can be allowed to reset or restart their machines. Default value is false.
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.
- DELETE: Delete the machine after user logoff.
- NEVER: Never delete or refresh the machine in the desktop pool.
- REFRESH: Refresh the machine after user logoff.
Disconnected sessions timeout (in minutes). This is required if disconnected_session_timeout_policy is set to AFTER.
Log-off policy after disconnected session. Default value is NEVER.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
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.
Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION.
Application empty session timeout policy. Default value is AFTER.
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
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.
Applicable to managed machines with default value as TAKE_NO_POWER_ACTION. Power policy for the machines in the desktop pool after logoff.
- ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.
- 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.
- 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.
- TAKE_NO_POWER_ACTION: No action will be taken when user logs off.
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.
Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION.
Application pre-launch session timeout policy. Default value is AFTER.
- AFTER: Pre-launched session is disconnected after specified number of minutes.
- NEVER: Pre-launched session is never disconnected.
Indicates whether and when to refresh the OS disks. Applicable To: dedicated instant-clone desktop pools with default value as NEVER.
- ALWAYS: The OS disk is refreshed every time the user logs off.
- 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.
- 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.
- NEVER: The OS disk is never refreshed.
Regular interval at which to refresh the OS disk. This is required if refresh_os_disk_after_logoff is set to EVERY.
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.
Session timeout policy. Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION with default value as DEFAULT.
- DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
- NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
Applicable To: Automated and Manual desktop pool.
Session related setting for Automated and Manual desktop pool.
{
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30,
"session_timeout_policy": "DEFAULT"
}
Indicates whether multiple sessions are allowed per user in case of Floating User Assignment.
Indicates whether the user can be allowed to reset or restart their machines.
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.
- DELETE: Delete the machine after user logoff.
- NEVER: Never delete or refresh the machine in the desktop pool.
- REFRESH: Refresh the machine after user logoff.
Disconnected sessions timeout (in minutes). This is required if disconnected_session_timeout_policy is set to AFTER.
Log-off policy after disconnected session.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
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.
Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION.
Desktop Pool empty session timeout policy.
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
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 for the machines in the desktop pool after logoff. This setting is only relevant for managed machines.
- ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.
- 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.
- 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.
- TAKE_NO_POWER_ACTION: No action will be taken when user logs off.
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.
Desktop Pool pre-launch session timeout policy.
- AFTER: Pre-launched session is disconnected after specified number of minutes.
- NEVER: Pre-launched session is never disconnected.
Indicates whether and when to refresh the OS disks for dedicated instant-clone desktop pools.
- ALWAYS: The OS disk is refreshed every time the user logs off.
- 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.
- 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.
- NEVER: The OS disk is never refreshed.
Regular interval at which to refresh the OS disk. This is required if when refresh_os_disk_after_logoff set to EVERY.
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.
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.
- DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
- NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
Machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare.
{
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30
}
Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false. This property can be used for sorting.
Indicates whether the user can be allowed to reset or restart their machines. Default value is false. This property can be used for sorting.
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. This property can be used for sorting.
- DELETE: Delete the machine after user logoff.
- NEVER: Never delete or refresh the machine in the desktop pool.
- REFRESH: Refresh the machine after user logoff.
Disconnected sessions timeout (in minutes). Will be set when disconnected_session_timeout_policy is set to AFTER. This property can be used for sorting.
Log-off policy after disconnected session. Default value is NEVER. This property can be used for sorting.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
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. This property can be used for sorting.
Application empty session timeout policy. Default value is AFTER. This property can be used for sorting.
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.Default value is false. This property can be used for sorting.
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. This property can be used for sorting.
- ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.
- 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.
- 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.
- TAKE_NO_POWER_ACTION: No action will be taken when user logs off.
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. This property can be used for sorting.
Application pre-launch session timeout policy. Default value is AFTER. This property can be used for sorting.
- AFTER: Pre-launched session is disconnected after specified number of minutes.
- NEVER: Pre-launched session is never disconnected.
Whether and when to refresh the OS disks for dedicated-assignment, linked-clone and instant-clone machines.Default value is NEVER. This property can be used for sorting.
- ALWAYS: The OS disk is refreshed every time the user logs off.
- 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.
- 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.
- NEVER: The OS disk is never refreshed.
Regular interval at which to refresh the OS disk. Will be set when refresh_os_disk_after_logoff set to EVERY. This property can be used for sorting.
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. This property can be used for sorting.
Machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare.
{
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30,
"session_timeout_policy": "DEFAULT"
}
Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false. This property can be used for sorting.
Indicates whether the user can be allowed to reset or restart their machines. Default value is false. This property can be used for sorting.
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. This property can be used for sorting.
- DELETE: Delete the machine after user logoff.
- NEVER: Never delete or refresh the machine in the desktop pool.
- REFRESH: Refresh the machine after user logoff.
Disconnected sessions timeout (in minutes). Will be set when disconnected_session_timeout_policy is set to AFTER. This property can be used for sorting.
Log-off policy after disconnected session. Default value is NEVER. This property can be used for sorting.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
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. This property can be used for sorting.
Application empty session timeout policy. Default value is AFTER. This property can be used for sorting.
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.Default value is false. This property can be used for sorting.
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. This property can be used for sorting.
- ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.
- 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.
- 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.
- TAKE_NO_POWER_ACTION: No action will be taken when user logs off.
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. This property can be used for sorting.
Application pre-launch session timeout policy. Default value is AFTER. This property can be used for sorting.
- AFTER: Pre-launched session is disconnected after specified number of minutes.
- NEVER: Pre-launched session is never disconnected.
Whether and when to refresh the OS disks for dedicated-assignment, linked-clone and instant-clone machines.Default value is NEVER. This property can be used for sorting.
- ALWAYS: The OS disk is refreshed every time the user logs off.
- 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.
- 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.
- NEVER: The OS disk is never refreshed.
Regular interval at which to refresh the OS disk. Will be set when refresh_os_disk_after_logoff set to EVERY. This property can be used for sorting.
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. This property can be used for sorting.
Session timeout policy. This property can be used for sorting.
- DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
- NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
Information related to Desktop Pool Settings.
{
"allow_mutilple_sessions_per_user": "boolean",
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"delete_in_progress": "boolean",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"grid_vgpus_enabled": "boolean",
"html_access_enabled": true,
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "true",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30
},
"session_type": "DESKTOP",
"shortcut_locations": [
"Desktop"
]
}
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.
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.
Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services. Default value is false.
Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false. Default value is false.
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.
Indicates whether the desktop pool is in the process of being deleted.Default value is false.
Client restrictions to be applied to the desktop pool.Currently it is valid for RDS desktop pools only. Default value is false.
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.
- APPLICATION: Only application sessions are supported.
- DESKTOP: Only desktop sessions are supported.
- DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
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.
Virtual Center storage settings for the automated desktop pool.
{
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"non_persistent_disk_drive_letter": "Auto",
"non_persistent_disk_size_mb": 4096,
"non_persistent_redirect_disposable_files": true,
"persistent_disk_datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean",
"storage_overcommit": "CONSERVATIVE"
}
],
"persistent_disk_drive_letter": "D",
"persistent_disk_size_mb": 2048,
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"redirect_windows_profile": "boolean",
"replica_disk_datastore_id": "datastore-1",
"use_native_snapshots": "boolean",
"use_separate_datastores_persistent_and_os_disks": "boolean",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
}
Datastores to store the machine (or the OS disk using other options for linked clone or instant clone machine storage)
Non persistent disk drive letter. This property can be used for sorting.
Size of the non persistent disk in MB. This property can be used for sorting.
Redirect disposable files to a non-persistent disk that will be deleted automatically when a user's session ends. This property can be used for sorting.
Datastores to store persistent disks for linked clone machines.
Persistent disk drive letter. This property can be used for sorting.
Size of the persistent disk in MB. This property can be used for sorting.
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. This property can be used for sorting.
Initiate reclamation when unused space on virtual machine exceeds the threshold in MB. This property can be used for sorting.
Windows profiles will be redirected to persistent disks, which are not affected by View Composer operations such as refresh, recompose and rebalance. This property can be used for sorting.
Datastore to store replica disks for linked clone and instant clone machines.
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. This property can be used for sorting.
Whether to use separate datastores for persistent and OS disks. This property can be used for sorting.
Whether to use separate datastores for replica and OS disks. This property can be used for sorting.
Whether to use vSphere vSAN. This property can be used for sorting.
Applicable To: Automated desktop pool.
Virtual center storage settings for Automated desktop pool.
{
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean"
}
],
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
}
Datastores to store the machine.
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.
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.
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.
Indicates whether to use separate datastores for replica and OS disks.
Default value is false.
Indicates whether to use vSphere vSAN.
Default value is false.
Virtual center storage settings for automated desktop pool.
{
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean"
}
],
"persistent_disk_drive_letter": "D",
"persistent_disk_size_mb": 2048,
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"redirect_windows_profile": "boolean",
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
}
Datastores to store the machine.
Indicates the persistent disk drive letter.This property is required if redirect_Windows_Profile is set to True
Indicates the size of the persistent disk in MB.This property is required if redirect_Windows_Profile is set to True
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.
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.
Indicates that windows profiles will be redirected to persistent disks.
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.
Indicates whether to use separate datastores for replica and OS disks.
Default value is false.
Indicates whether to use vSphere vSAN.
Default value is false.
Applicable To: Automated desktop pool.
Virtual Center storage settings for Automated desktop pool.
{
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean"
}
],
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
}
Datastores to store the machine (or the OS disk using other options for instant clone machine storage)
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.
Initiate reclamation when unused space on virtual machine exceeds the threshold in MB. Default value is 1.
Datastore to store replica disks for instant clone machines.
Indicates whether to use separate datastores for replica and OS disks.
Indicates whether to use vSphere vSAN.
Virtual center storage settings for automated desktop pool.
{
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean"
}
],
"persistent_disk_drive_letter": "D",
"persistent_disk_size_mb": 2048,
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
}
Datastores to store the machine (or the OS disk using other options for instant clone machine storage)
Indicates the persistent disk drive letter.This property is required if redirectWindowsProfile is set to True
Indicates the size of the persistent disk in MB.This property is required if redirectWindowsProfile is set to True
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.
Initiate reclamation when unused space on virtual machine exceeds the threshold in MB. Default value is 1.
Datastore to store replica disks for instant clone machines.
Indicates whether to use separate datastores for replica and OS disks.
Indicates whether to use vSphere vSAN.
Information related to Desktop Pool Task.
{
"cancelled_vmtask_count": 3,
"description": "Changing 10 user(s) to image /Datacenter/vm/VMs/Win10 - Snapshot1. This task will start at Jan 12, 2021 12:00 AM and will wait for users to log off before the push operation is started.",
"error_vmtask_count": 2,
"halted_vmtask_count": 1,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"operation": "PUSH_IMAGE",
"remaining_vmtask_count": 10,
"schedule_time": 1587081283000
}
Number of VMs whose task is in cancelled state.
Description of the desktop pool task.
Number of VMs whose task is in fault state.
Number of VMs whose task is in holding state.
Unique ID representing Desktop Pool Task.
The current desktop pool operation.
- ARCHIVE: An archive operation.
- ATTACH: A persistent disk attach operation.
- DETACH: A persistent disk detach operation.
- PUSH_IMAGE: A push image operation.
- TAGGING: A tagging operation.
Number of VMs whose task is scheduled or running.
Time at which desktop pool task is scheduled to start.
Desktop Pool object to be updated.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_multiple_user_assignments": true,
"allow_rds_pool_multi_session_per_user": "boolean",
"automatic_user_assignment": "boolean",
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_brokered": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "priming"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"description": "Desktop Pool Description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "pool",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "DISABLED",
"session_collaboration_enabled": "boolean",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"enable_provisioning": true,
"enabled": true,
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "ON_DEMAND"
},
"provisioning_settings": {
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"resource_pool_id": "resgroup-1",
"vm_template_id": "vm-1"
},
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30,
"session_timeout_policy": "DEFAULT"
},
"session_type": "DESKTOP",
"shortcut_locations_v2": [
"DESKTOP"
],
"specific_naming_settings": {
"num_unassigned_machines_kept_powered_on": 1,
"specified_names": [
{
"name": "machine1",
"user_id": "S-1-1-1-3965912346-1012345398-3123456564-123"
}
],
"start_machines_in_maintenance_mode": "boolean"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean"
}
],
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"view_storage_accelerator_settings": {
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean"
}
}
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.
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
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.
Applicable To: Dedicated desktop pools.
Automatic assignment of a user the first time they access the machine.
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.
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.
Applicable To: RDS Desktop Pools.
This is required for RDS Desktop Pools.
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.
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.
Description of the desktop pool.
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.
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 of the desktop pool.
display_protocol_settings
Indicates whether client restrictions are to be applied to desktop pool.
Applicable To: Automated desktop pools.
Indicates whether provisioning is enabled. This is required for Automated desktop pools.
Indicates whether the desktop pool is enabled for brokering.
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.
pattern_naming_settings
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.
- APPLICATION: Only application sessions are supported.
- DESKTOP: Only desktop sessions are supported.
- DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
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.
specific_naming_settings
Applicable To: Automated desktop pools.
Indicates whether provisioning on all machines stops on error. This is required for Automated desktop pools.
Applicable To: Managed Manual and Automated desktop pools.
The transparent page sharing scope. This is required for Manual and Automated desktop pools.
- DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
view_storage_accelerator_settings
Desktop Pool object to be updated.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_multiple_user_assignments": true,
"allow_rds_pool_multi_session_per_user": "boolean",
"automatic_user_assignment": "boolean",
"category_folder_name": "dir1",
"cloud_assigned": "boolean",
"cloud_brokered": "boolean",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"CS1_TAG1"
],
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "priming"
},
"customization_type": "CLONE_PREP",
"do_not_power_on_vms_after_creation": "boolean",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"description": "Desktop Pool Description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "pool",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "DISABLED",
"session_collaboration_enabled": "boolean",
"vram_size_mb": 64
},
"enable_client_restrictions": "boolean",
"enable_provisioning": true,
"enabled": true,
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "ON_DEMAND"
},
"provisioning_settings": {
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"resource_pool_id": "resgroup-1",
"vm_template_id": "vm-1"
},
"session_settings": {
"allow_multiple_sessions_per_user": "boolean",
"allow_users_to_reset_machines": "boolean",
"delete_or_refresh_machine_after_logoff": "NEVER",
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"power_policy": "ALWAYS_POWERED_ON",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30,
"session_timeout_policy": "DEFAULT"
},
"session_type": "DESKTOP",
"shortcut_locations_v2": [
"DESKTOP"
],
"specific_naming_settings": {
"num_unassigned_machines_kept_powered_on": 1,
"specified_names": [
{
"name": "machine1",
"user_id": "S-1-1-1-3965912346-1012345398-3123456564-123"
}
],
"start_machines_in_maintenance_mode": "boolean"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"sdrs_cluster": "boolean"
}
],
"persistent_disk_drive_letter": "D",
"persistent_disk_size_mb": 2048,
"reclaim_vm_disk_space": "boolean",
"reclamation_threshold_mb": 1024,
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"view_storage_accelerator_settings": {
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean"
}
}
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.
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
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.
Applicable To: Dedicated desktop pools.
Automatic assignment of a user the first time they access the machine.
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.
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.
Applicable To: RDS Desktop Pools.
This is required for RDS Desktop Pools.
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.
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.
Description of the desktop pool.
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.
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 of the desktop pool.
display_protocol_settings
Indicates whether client restrictions are to be applied to desktop pool.
Applicable To: Automated desktop pools.
Indicates whether provisioning is enabled. This is required for Automated desktop pools.
Indicates whether the desktop pool is enabled for brokering.
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.
pattern_naming_settings
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.
- APPLICATION: Only application sessions are supported.
- DESKTOP: Only desktop sessions are supported.
- DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
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.
specific_naming_settings
Applicable To: Automated desktop pools.
Indicates whether provisioning on all machines stops on error. This is required for Automated desktop pools.
Applicable To: Managed Manual and Automated desktop pools.
The transparent page sharing scope. This is required for Manual and Automated desktop pools.
- DESKTOP_POOL: Inter-VM page sharing among VMs belonging to the same Desktop pool is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
view_storage_accelerator_settings
Settings related to the View Storage Accelerator feature.
{
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean",
"view_storage_accelerator_disk_types": "OS_DISKS"
}
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.
How often to regenerate the View Storage Accelerator cache. Measured in Days. This property can be used for sorting.
Whether to use View Storage Accelerator. This property can be used for sorting.
Disk types to enable for the View Storage Accelerator feature. This is only applicable to linked clone desktop pools. This property can be used for sorting.
- OS_DISKS: OS disks.
- OS_AND_PERSISTENT_DISKS: OS and persistent disks.
Applicable To: Managed Desktop Pool.
View Storage Accelerator settings for Managed desktop pool.
{
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean"
}
A list of blackout times.
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.
Indicates whether to use View Storage Accelerator.
Default value is false.
Applicable To: Managed desktop pool.
Settings related to the View Storage Accelerator for Managed desktop pool.
{
"blackout_times": [
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
],
"regenerate_view_storage_accelerator_days": 7,
"use_view_storage_accelerator": "boolean"
}
A list of blackout times.
How often to regenerate the View Storage Accelerator cache. Measured in Days. This property has a default value of 7.
Indicates whether to use View Storage Accelerator.
Settings related to specification of VMs with a naming pattern.
{
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "ON_DEMAND"
}
Maximum number of machines in the desktop pool. This property can be used for sorting.
The minimum number of machines to have provisioned if on demand provisioning is selected. This property can be used for sorting.
Virtual machines will be named according to the specified naming pattern.
Supported Filters: 'Equals'. This property can be used for sorting.
Number of spare powered on machines. This property can be used for sorting.
Determines when the machines are provisioned. This property can be used for sorting.
- ON_DEMAND: Provision machines on demand.
- UP_FRONT: Provision all machines up-front.
Applicable To: Automated desktop pool.
Naming pattern settings for Automated desktop pool.
{
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "UP_FRONT"
}
Maximum number of machines in the desktop pool.
Default value is 1.
This is applicable if provisioning_time is set to ON_DEMAND with default value of 0.
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 powered on machines.
Default value is 1.
Determines when the machines are provisioned.
Default value is UP_FRONT
- ON_DEMAND: Provision machines on demand.
- UP_FRONT: Provision all machines up-front.
Applicable To: Automated desktop pool.
Naming pattern settings for Automated desktop pool.
{
"max_number_of_machines": 100,
"min_number_of_machines": 10,
"naming_pattern": "vm-{n}-sales",
"number_of_spare_machines": 10,
"provisioning_time": "ON_DEMAND"
}
Maximum number of machines in the desktop pool.
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" .
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). 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 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 powered on machines.
Determines when the machines are provisioned.
- ON_DEMAND: Provision machines on demand.
- UP_FRONT: Provision all machines up-front.
Settings related to specified naming of machines.
{
"num_machines": 10,
"num_unassigned_machines_kept_powered_on": 1,
"start_machines_in_maintenance_mode": "boolean"
}
Number of machines in the pool.
Number of unassigned machines kept powered on. This value must be less than or equal to the number of specified names. This property can be used for sorting.
Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited manually. This property can be used for sorting.
Applicable To: Automated Desktop Pool.
Settings related to specified naming of machines for Automated desktop pool.
{
"num_unassigned_machines_kept_powered_on": 1,
"specified_names": [
{
"name": "machine1",
"user_id": "S-1-1-1-3965912346-1012345398-3123456564-123"
}
],
"start_machines_in_maintenance_mode": "boolean"
}
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.
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.
Applicable To: Automated desktop pool.
Specified naming setting for Automated desktop pool.
{
"num_unassigned_machines_kept_powered_on": 1,
"specified_names": [
{
"name": "machine1",
"user_id": "S-1-1-1-3965912346-1012345398-3123456564-123"
}
],
"start_machines_in_maintenance_mode": "boolean"
}
Number of unassigned machines kept powered on. This value must be lesser than or equal to the number of specified names.
Initial specified names of machines in the desktop pool.
Allows virtual machines to be customized manually before users can log in and access them. This mode must be exited manually.
Information about display protocol performance.
{
"blast_performance_data": {
"audio_bytes_received": 1652079610000,
"audio_bytes_transmitted": 1652079610000,
"cdr_bytes_received": 1652079610000,
"cdr_bytes_transmitted": 1652079610000,
"imaging_bytes_received": 1652079610000,
"imaging_bytes_transmitted": 1652079610000,
"imaging_encoder_type": "test",
"imaging_frames_per_second": 1652079610000,
"session_bandwidth_uplink": 3872079619320,
"session_bytes_transmitted": 1652079610000,
"session_packet_loss_uplink": 1652079610000,
"session_round_trip_time": 1652079610000
},
"pcoip_performance_data": {
"audio_bytes_received": 1652079610000,
"audio_bytes_sent": 1652079610000,
"audio_rx_bandwidth": 1652079610000,
"audio_tx_bandwidth": 1652079610000,
"audio_tx_bandwidth_limit": 1652079610000,
"general_bytes_received": 3872079619320,
"general_bytes_sent": 1652079610000,
"general_duration_seconds": 1652079610000,
"general_packets_received": 1652079610000,
"general_packets_sent": 1652079610000,
"general_rx_packets_lost": 1652079610000,
"general_tx_packets_lost": 1652079610000,
"imaging_active_minimum_quality": 1652079610000,
"imaging_apex2800_offload": 1652079610000,
"imaging_bytes_received": 1652079610000,
"imaging_bytes_sent": 3872079619320,
"imaging_decoder_capability": 1652079610000,
"imaging_encoded_frames": 1652079610000,
"imaging_megapixel": 1652079610000,
"imaging_negative_acknowledgements": 1652079610000,
"imaging_rx_bandwidth": 1652079610000,
"imaging_svga_dev_tap_frames": 1652079610000,
"imaging_tx_bandwidth": 1652079610000,
"network_round_trip_latency": 1652079610000,
"network_rx_bandwidth": 1652079610000,
"network_rx_bandwidth_peak": 1652079610000,
"network_rx_packet_loss": 1652079610000,
"network_tx_bandwidth": 1652079610000,
"network_tx_bandwidth_active_limit": 1652079610000,
"network_tx_bandwidth_limit": 3872079619320,
"network_tx_packet_loss": 1652079610000,
"usb_bytes_received": 1652079610000,
"usb_bytes_sent": 1652079610000,
"usb_rx_bandwidth": 1652079610000,
"usb_tx_bandwidth": 1652079610000
}
}
The secondary enrollment server details.
{
"dns_name": "enrollment-server.example.com",
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"status": "OK"
}
Enrollment server dns name.
Unique ID of the Enrollment Server.
Enrollment server status.
- OK: The state of enrollment server is OK.
- ERROR: The enrollment server has an error.
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.
{
"ad_user_or_group_ids": [
"S-1-1-1-3965912346-1012345398-3123456564-123",
"S-1-2-3-3123456786-1012345398-3123456784-124"
],
"id": "855ea6c5-720a-41e1-96f4-958c90e6e424"
}
List of ad-user-or-group SIDs which are entitled to the given resource.
Unique ID representing the resource.
Supported Filters : 'Equals'.
Entitlement response info object corresponding to the given ad-user-or-group SID for the entitlement operation.
{
"ad_user_or_group_id": "S-1-5-21-2898529287-1016622242-505487308-500",
"error_messages": [
"Entity does not exists.",
"Property is mandatory."
],
"errors": [
{
"error_key": "inventory.machine.not.found",
"error_message": "username cannot be empty"
}
],
"status_code": 200,
"timestamp": 1561939200000
}
Unique SID representing the ad-user-or-group
Reasons for the failure of the operation. This field is deprecated since 2203 release.
Response HTTP status code of the operation.
Timestamp in milliseconds when the operation failed. Measured as epoch time.
Specification for entitlement operations on a given resource id.
{
"ad_user_or_group_ids": [
"S-1-1-1-3965912346-1012345398-3123456564-123",
"S-1-2-3-3123456786-1012345398-3123456784-124"
],
"id": "855ea6c5-720a-41e1-96f4-958c90e6e424"
}
List of ad-user-or-group SIDs for the entitlement operations on the given resource.
Unique ID representing the resource.
Information related to Environment Settings.
{
"cluster_guid": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"cluster_name": "master-cluster",
"fips_mode_enabled": "boolean",
"ip_mode": "IPv4",
"local_pod_name": "master-pod",
"timezone_offset": 19800
}
The GUID of a group of Connection Servers sharing the same configuration.
The name of a group of Connection Servers sharing the same configuration.
Indicates if FIPS mode is enabled.
Indicates the IP mode of the environment.
- IPv4: The ip mode is IPv4.
- IPv6: The ip mode is IPv6.
The name of the current pod in the Multi-DataCenter Horizon Pod, the value will be null when PodFederation is not initialized.
Represents the clusters time zone offset from UTC in seconds.
Information related to Environment Settings.
{
"cluster_guid": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"cluster_name": "master-cluster",
"deployment_type": "string",
"fips_mode_enabled": "boolean",
"ip_mode": "IPv4",
"local_connection_server_build": "12345678",
"local_connection_server_version": "8.1.0",
"local_pod_name": "master-pod",
"timezone_offset": 19800
}
The GUID of a group of Connection Servers sharing the same configuration.
The name of a group of Connection Servers sharing the same configuration.
Indicates different environments that Horizon can be deployed into.
- GENERAL: Horizon is deployed on On-premises.
- AZURE: Horizon is deployed on Azure.
- AWS: Horizon is deployed on AWS.
- DELL_EMC: Horizon is deployed on Dell EMC.
- GOOGLE: Horizon is deployed on Google Cloud.
- ORACLE: Horizon is deployed on Oracle Cloud.
Indicates if FIPS mode is enabled.
Indicates the IP mode of the environment.
- IPv4: The ip mode is IPv4.
- IPv6: The ip mode is IPv6.
Local connection Server build number.
Local connection Server version number.
The name of the current pod in the Multi-DataCenter Horizon Pod, the value will be null when PodFederation is not initialized.
Represents the clusters time zone offset from UTC in seconds.
Information about event database.
{
"admin_events_count": 2000,
"classify_events_as_new_for_days": 3,
"database_name": "eventdb",
"event_database_configured": true,
"port": 1443,
"query_timeout_seconds": 120,
"server_name": "eventdb.horizon.com",
"show_events_for_time": "THREE_MONTHS",
"table_prefix": "tab_",
"timing_profiler_data_longevity_days": 7,
"type": "SQL_SERVER",
"username": "administrator"
}
The number of events administrator can see in the admin console.
Events will be marked as new for a time based on the value.
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.
Indicates if the event database has been configured or not.
Port number on the database server to which Horizon will send events.
Query execution timeout in seconds.
The server that hosts the database which will be used to store events.
Events will be shown in the Horizon Admin console for a time based on this value.
- ONE_WEEK: One week.
- TWO_WEEKS: Two weeks.
- THREE_WEEKS: Three weeks.
- ONE_MONTH: One month.
- TWO_MONTHS: Two months.
- THREE_MONTHS: Three months.
- SIX_MONTHS: Six months.
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 will be kept in database for a time based on the value. Timing Profiler Data will not be stored in Event DB.
The type of database to use for the event database.
- ORACLE: An Oracle database.
- SQL_SERVER: A SQL server database.
- POSTGRESQL: A PostgreSQL database.
Username to use for the connection to the event database.
The basic details of the event database
{
"database_name": "HorizonEventDB",
"port": 1433,
"prefix": "view_",
"server_name": "event-db.example.com",
"type": "SQL_SERVER",
"user_name": "sa"
}
The name of the database.
The port of the database server.
The prefix for event tables in the database.
The name or ip address of the database server.
The type of the database.
- ORACLE: An Oracle database.
- SQL_SERVER: A SQL server database.
- POSTGRESQL: A PostgreSQL database.
The username used to connect to the database.
Event Database Monitor Information
{
"details": {
"database_name": "HorizonEventDB",
"port": 1433,
"prefix": "view_",
"server_name": "event-db.example.com",
"type": "SQL_SERVER",
"user_name": "sa"
},
"event_count": 10000,
"status": "CONNECTED"
}
Number of events recorded in the database
State of the database.
- CONNECTED: Connection Server is connected to the database.
- CONNECTING: Connection Server is connecting to the database.
- DISCONNECTED: Connection Server is disconnected from the database.
- RECONNECTING: Connection Server is reconnecting to the database.
- ERROR: Error in connecting to the database from Connection Server.
- NOT_CONFIGURED: Database is not configured.
- UNKNOWN: Unknown state.
Event database configuration to be updated.
{
"admin_events_count": 2000,
"classify_events_as_new_for_days": 3,
"database_name": "eventdb",
"password": [
"<password>"
],
"port": 1443,
"query_timeout_seconds": 120,
"server_name": "eventdb.horizon.com",
"show_events_for_time": "THREE_MONTHS",
"table_prefix": "tab_",
"timing_profiler_data_longevity_days": 7,
"type": "SQL_SERVER",
"username": "administrator"
}
The number of events administrator can see in the admin console. It has a default value of 2000.
Events will be marked as new for a time based on the value. Must be between 1 and 3 days.
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 to use for the event database connection.
Port number on the database server to which Horizon will send events.
Query execution timeout in seconds. It has a default value of 120 seconds.
The server that hosts the database which will be used to store events.
Events will be shown in the Horizon Admin console for a time based on this value. It has a default value of 3 months.
- ONE_WEEK: One week.
- TWO_WEEKS: Two weeks.
- THREE_WEEKS: Three weeks.
- ONE_MONTH: One month.
- TWO_MONTHS: Two months.
- THREE_MONTHS: Three months.
- SIX_MONTHS: Six months.
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 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.
The type of database to use for the event database.
- ORACLE: An Oracle database.
- SQL_SERVER: A SQL server database.
- POSTGRESQL: A PostgreSQL database.
Username to use for the connection to the event database.
Export certificate spec.
{
"certificate_password": [
"password"
],
"certificate_usage": "MACHINE"
}
Password for exporting the certificate.
Indicates how the certificate would be used.
- MACHINE: vdm certificates
- CLUSTER: vdm.ec certificates
Exported certificate of connection server.
{
"certificate_chain": "<certificate in base64 format>",
"certificate_usage": "MACHINE",
"format": "pfx"
}
Certificate chain.
Indicates how the certificate would be used.
- MACHINE: vdm certificates
- CLUSTER: vdm.ec certificates
Certificate Type.
Settings for Automated farm. This is required if type is set to AUTOMATED.
{
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
}
Indicates whether to enable provisioning immediately. Default value is true.
RDS Server type for max sessions.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.
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.
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.
pattern_naming_settings
Indicates whether provisioning on all VMs stops on error. Default value is true.
Transparent page sharing scope for the farm. Default value is VM.
- FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
ID of the virtual center server.
Settings for Automated farm.
{
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
}
Indicates whether to enable provisioning immediately. Default value is true.
RDS Server type for max sessions.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.
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.
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.
pattern_naming_settings
Indicates whether provisioning on all VMs stops on error. Default value is true.
Transparent page sharing scope for the farm. Default value is VM.
- FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
ID of the virtual center server.
Settings for Automated farm.
{
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
}
Indicates whether to enable provisioning immediately. Default value is true.
RDS Server type for max sessions.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.
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.
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.
pattern_naming_settings
Indicates whether provisioning on all VMs stops on error. Default value is true.
Transparent page sharing scope for the farm. Default value is VM.
- FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
ID of the virtual center server.
Applicable To: Automated farms.
Settings for Automated farm.
{
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
}
Indicates whether to enable provisioning immediately. Default value is true.
RDS Server type for max sessions.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.
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.
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.
pattern_naming_settings
Indicates whether provisioning on all VMs stops on error. Default value is true.
Transparent page sharing scope for the farm. Default value is VM.
- FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
ID of the virtual center server.
Settings for Automated farm.
{
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean"
},
"enable_provisioning": true,
"image_source": "VIRTUAL_CENTER",
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "READY",
"instant_clone_operation": "INITIAL_PUBLISH",
"instant_clone_operation_time": 1587081283000,
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_scheduled_maintenance_data": {
"immediate_maintenance_scheduled": true,
"logoff_policy": "WAIT_FOR_LOGOFF",
"next_scheduled_time": 1237081283000,
"recurring_maintenance_settings": {
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
},
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"storage_overcommit": "CONSERVATIVE"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
}
Indicates whether to enable provisioning immediately.
Supported Filters: 'Equals'. This property can be used for sorting.
Source of image used in the farm.
Supported Filters: 'Equals'. This property can be used for sorting.
- IMAGE_CATALOG: Image was created in image catalog.
- VIRTUAL_CENTER: Image was created in virtual center.
RDS Server type for max sessions.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.
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. This property can be used for sorting.
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.
The guest operating system.
- LINUX_SERVER_OTHER: Linux Server (other)
- UNKNOWN: Unknown
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
The guest operating system architecture.
- UNKNOWN: Operating System cannot be determined.
- BIT_32: 32 bit Operating System Architecture.
- BIT_64: 64 bit Operating System Architecture.
Indicates whether provisioning on all VMs stops on error. This property can be used for sorting.
Transparent page sharing scope for the farm. This property can be used for sorting.
- FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
ID of the virtual center server.
Supported Filters: 'Equals'.
Settings for Automated farm.
{
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"image_source": "VIRTUAL_CENTER",
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "READY",
"instant_clone_operation": "INITIAL_PUBLISH",
"instant_clone_operation_time": 1587081283000,
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_scheduled_maintenance_data": {
"immediate_maintenance_scheduled": true,
"logoff_policy": "WAIT_FOR_LOGOFF",
"next_scheduled_time": 1237081283000,
"recurring_maintenance_settings": {
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
},
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"storage_overcommit": "CONSERVATIVE"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
}
Indicates whether to enable provisioning immediately.
Supported Filters: 'Equals'. This property can be used for sorting.
Source of image used in the farm.
Supported Filters: 'Equals'. This property can be used for sorting.
- IMAGE_CATALOG: Image was created in image catalog.
- VIRTUAL_CENTER: Image was created in virtual center.
RDS Server type for max sessions.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.
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. This property can be used for sorting.
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.
The guest operating system.
- LINUX_SERVER_OTHER: Linux Server (other)
- UNKNOWN: Unknown
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
The guest operating system architecture.
- UNKNOWN: Operating System cannot be determined.
- BIT_32: 32 bit Operating System Architecture.
- BIT_64: 64 bit Operating System Architecture.
Indicates whether provisioning on all VMs stops on error. This property can be used for sorting.
Transparent page sharing scope for the farm. This property can be used for sorting.
- FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
ID of the virtual center server.
Supported Filters: 'Equals'.
Settings for Automated farm.
{
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"image_source": "VIRTUAL_CENTER",
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "READY",
"instant_clone_operation": "INITIAL_PUBLISH",
"instant_clone_operation_time": 1587081283000,
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_scheduled_maintenance_data": {
"immediate_maintenance_scheduled": true,
"logoff_policy": "WAIT_FOR_LOGOFF",
"next_scheduled_time": 1237081283000,
"recurring_maintenance_settings": {
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
},
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000,
"pending_compute_profile_num_cores_per_socket": 1,
"pending_compute_profile_num_cpus": 4,
"pending_compute_profile_ram_mb": 4096
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"storage_overcommit": "CONSERVATIVE"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
}
Indicates whether to enable provisioning immediately.
Supported Filters: 'Equals'. This property can be used for sorting.
Source of image used in the farm.
Supported Filters: 'Equals'. This property can be used for sorting.
- IMAGE_CATALOG: Image was created in image catalog.
- VIRTUAL_CENTER: Image was created in virtual center.
RDS Server type for max sessions.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.
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. This property can be used for sorting.
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.
The guest operating system.
- LINUX_SERVER_OTHER: Linux Server (other)
- UNKNOWN: Unknown
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
The guest operating system architecture.
- UNKNOWN: Operating System cannot be determined.
- BIT_32: 32 bit Operating System Architecture.
- BIT_64: 64 bit Operating System Architecture.
Indicates whether provisioning on all VMs stops on error. This property can be used for sorting.
Transparent page sharing scope for the farm. This property can be used for sorting.
- FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
ID of the virtual center server.
Supported Filters: 'Equals'.
Applicable To: Automated farms.
Settings for Automated farm.
{
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"image_source": "VIRTUAL_CENTER",
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "READY",
"instant_clone_operation": "INITIAL_PUBLISH",
"instant_clone_operation_time": 1587081283000,
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_scheduled_maintenance_data": {
"immediate_maintenance_scheduled": true,
"logoff_policy": "WAIT_FOR_LOGOFF",
"next_scheduled_time": 1237081283000,
"recurring_maintenance_settings": {
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
},
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000,
"pending_compute_profile_num_cores_per_socket": 1,
"pending_compute_profile_num_cpus": 4,
"pending_compute_profile_ram_mb": 4096
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"storage_overcommit": "CONSERVATIVE"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
}
Indicates whether to enable provisioning immediately.
Supported Filters: 'Equals'. This property can be used for sorting.
Source of image used in the farm.
Supported Filters: 'Equals'. This property can be used for sorting.
- IMAGE_CATALOG: Image was created in image catalog.
- VIRTUAL_CENTER: Image was created in virtual center.
RDS Server type for max sessions.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
Maximum number of sessions allowed for RDS Server. This is set when max_session_type is LIMITED.
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. This property can be used for sorting.
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.
The guest operating system.
- LINUX_SERVER_OTHER: Linux Server (other)
- UNKNOWN: Unknown
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
The guest operating system architecture.
- UNKNOWN: Operating System cannot be determined.
- BIT_32: 32 bit Operating System Architecture.
- BIT_64: 64 bit Operating System Architecture.
Indicates whether provisioning on all VMs stops on error. This property can be used for sorting.
Transparent page sharing scope for the farm. This property can be used for sorting.
- FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
ID of the virtual center server.
Supported Filters: 'Equals'.
Settings for Automated farm. This is required if type is set to AUTOMATED.
{
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"reuse_pre_existing_accounts": "boolean"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"host_or_cluster_id": "domain-s425",
"resource_pool_id": "resgroup-1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1"
},
"transparent_page_sharing_scope": "VM"
}
Indicates whether to enable provisioning immediately.
RDS Server type for max sessions.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.
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.
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.
pattern_naming_settings
Indicates whether provisioning on all VMs stops on error.
Transparent page sharing scope for the farm.
- FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
Settings for Automated farm.
{
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"host_or_cluster_id": "domain-s425",
"resource_pool_id": "resgroup-1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1"
},
"transparent_page_sharing_scope": "VM"
}
Indicates whether to enable provisioning immediately.
RDS Server type for max sessions.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.
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.
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.
pattern_naming_settings
Indicates whether provisioning on all VMs stops on error.
Transparent page sharing scope for the farm.
- FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
Applicable To: Automated farms.
Settings for Automated farm.
{
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"host_or_cluster_id": "domain-s425",
"resource_pool_id": "resgroup-1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1"
},
"transparent_page_sharing_scope": "VM"
}
Indicates whether to enable provisioning immediately.
RDS Server type for max sessions.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.
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.
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.
pattern_naming_settings
Indicates whether provisioning on all VMs stops on error.
Transparent page sharing scope for the farm.
- FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.
- GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
- POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
- VM: Inter-VM page sharing is not permitted.
The specification to cancel the scheduled maintenance operation.
{
"maintenance_mode": "IMMEDIATE"
}
Scheduled maintenance mode to be cancelled.
- IMMEDIATE: All server VMs will be refreshed once, immediately or at user scheduled time.
- RECURRING: All server VMs will be periodically refreshed based on FarmInstantCloneRecurringMaintenancePeriod and StartTime
Settings for ClonePrep customization for the farm.
{
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
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.
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.
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.
Settings for ClonePrep customization for the farm.
{
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
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.
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.
Instant Clone publishing needs an additional computer account in the same AD domain as the clones. This field accepts the pre-created computer accounts.
Settings for ClonePrep customization for the farm.
{
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
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.
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.
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.
Farm object to be created.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
},
"description": "Farm Description",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": true,
"session_collaboration_enabled": "boolean"
},
"enabled": true,
"load_balancer_settings": {
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"memory_threshold": 10
},
"name": "ManualFarm",
"rds_server_ids": [
"5134796a-322g-5fe5-343f-4daa5d25ebfe",
"2a43f96c-102b-4ed3-953f-35deg43d43b0ge"
],
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER"
},
"type": "MANUAL",
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Description of the farm.
Display name of the farm. If the display name is left blank, it defaults to name.
Indicates whether the farm is enabled for brokering. Default value is true.
Name of the farm. This property must contain only alphanumerics, underscores, and dashes.
List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.
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.
Type of the farm.
- AUTOMATED: Automated Farm.
- MANUAL: Manual Farm.
Indicates whether to use custom scripts for load balancing or not. Default value is false.
Farm object to be created.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
},
"description": "Farm Description",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": true,
"session_collaboration_enabled": "boolean"
},
"enabled": true,
"load_balancer_settings": {
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"memory_threshold": 10
},
"name": "ManualFarm",
"rds_server_ids": [
"5134796a-322g-5fe5-343f-4daa5d25ebfe",
"2a43f96c-102b-4ed3-953f-35deg43d43b0ge"
],
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER"
},
"type": "MANUAL",
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Description of the farm.
Display name of the farm. If the display name is left blank, it defaults to name.
Indicates whether the farm is enabled for brokering. Default value is true.
Name of the farm. This property must contain only alphanumerics, underscores, and dashes.
List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.
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.
Type of the farm.
- AUTOMATED: Automated Farm.
- MANUAL: Manual Farm.
Indicates whether to use custom scripts for load balancing or not. Default value is false.
Farm object to be created.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
},
"description": "Farm Description",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": true,
"session_collaboration_enabled": "boolean"
},
"enabled": true,
"load_balancer_settings": {
"connecting_session_threshold": 10,
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"load_index_threshold": 20,
"memory_threshold": 10
},
"name": "ManualFarm",
"rds_server_ids": [
"5134796a-322g-5fe5-343f-4daa5d25ebfe",
"2a43f96c-102b-4ed3-953f-35deg43d43b0ge"
],
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"session_timeout_policy": "DEFAULT"
},
"type": "MANUAL",
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Description of the farm.
Display name of the farm. If the display name is left blank, it defaults to name.
Indicates whether the farm is enabled for brokering. Default value is true.
Name of the farm. This property must contain only alphanumerics, underscores, and dashes.
List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.
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.
Type of the farm.
- AUTOMATED: Automated Farm.
- MANUAL: Manual Farm.
Indicates whether to use custom scripts for load balancing or not. Default value is false.
Farm object to be created.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
},
"description": "Farm Description",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": true,
"session_collaboration_enabled": "boolean"
},
"enabled": true,
"load_balancer_settings": {
"connecting_session_threshold": 10,
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"load_index_threshold": 20,
"memory_threshold": 10
},
"name": "ManualFarm",
"rds_server_ids": [
"5134796a-322g-5fe5-343f-4daa5d25ebfe",
"2a43f96c-102b-4ed3-953f-35deg43d43b0ge"
],
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"session_timeout_policy": "DEFAULT"
},
"type": "MANUAL",
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Description of the farm.
Display name of the farm. If the display name is left blank, it defaults to name.
Indicates whether the farm is enabled for brokering. Default value is true.
Name of the farm. This property must contain only alphanumerics, underscores, and dashes.
List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.
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.
Type of the farm.
- AUTOMATED: Automated Farm.
- MANUAL: Manual Farm.
Indicates whether to use custom scripts for load balancing or not. Default value is false.
Customization settings for the automated farm.
{
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean"
}
Instant Clone Engine Active Directory container for clone prep. Default value is CN=Computers
cloneprep_customization_settings
Instant clone domain account. This is the administrator which will add the machines to its domain upon creation.
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.
Customization settings for the automated farm.
{
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
Instant Clone Engine Active Directory container for clone prep. Default value is CN=Computers
cloneprep_customization_settings
Type of customization to use.
- 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. - 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.
Instant clone domain account. This is the administrator which will add the machines to its domain upon creation.
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.
Customization specification to use when Sysprep customization is requested. This is required if customization_type is set to SYS_PREP
Applicable To: Automated farms.
Customization settings for the automated farm.
{
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
Instant Clone Engine Active Directory container for clone prep. Default value is CN=Computers
Applicable To: Instant Clone farms.
The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone farm provisioning.
cloneprep_customization_settings
Type of customization to use.
- 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. - 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.
Instant clone domain account. This is the administrator which will add the machines to its domain upon creation.
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.
Customization specification to use when Sysprep customization is requested. This is required if customization_type is set to SYS_PREP
Customization settings for the automated farm.
{
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean"
}
Instant Clone Engine Active Directory container for clone prep. This property can be used for sorting.
cloneprep_customization_settings
Instant clone domain account. This is the administrator which will add the machines to its domain upon creation.
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. This property can be used for sorting.
Customization settings for the automated farm.
{
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
Instant Clone Engine Active Directory container for clone prep. This property can be used for sorting.
cloneprep_customization_settings
Type of customization to use.
- 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. - 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.
Instant clone domain account. This is the administrator which will add the machines to its domain upon creation.
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. This property can be used for sorting.
Customization specification used when Sysprep customization is requested. This will be set if customization_type is set to SYS_PREP
Applicable To: Automated farms.
Customization settings for the automated farm.
{
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
Instant Clone Engine Active Directory container for clone prep. This property can be used for sorting.
Applicable To: Instant Clone farms.
The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone farm provisioning.
cloneprep_customization_settings
Type of customization to use.
- 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. - 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.
Instant clone domain account. This is the administrator which will add the machines to its domain upon creation.
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. This property can be used for sorting.
Customization specification used when Sysprep customization is requested. This will be set if customization_type is set to SYS_PREP
Customization settings for the automated farm.
{
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"reuse_pre_existing_accounts": "boolean"
}
Instant Clone Engine Active Directory container for clone prep.
cloneprep_customization_settings
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.
Customization settings for the automated farm.
{
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
Instant Clone Engine Active Directory container for clone prep.
cloneprep_customization_settings
Type of customization to use.
- 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. - 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.
Instant clone domain account. This is the administrator which will add the machines to its domain.
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.
Customization specification to use when Sysprep customization is requested. This is required if customization_type is set to SYS_PREP
Applicable To: Automated farms.
Customization settings for the automated farm.
{
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
}
Instant Clone Engine Active Directory container for clone prep.
Applicable To: Instant Clone farms.
The AD Site, associated with the Instant Clone Domain Administrator, which will be used for instant clone farm provisioning.
cloneprep_customization_settings
Type of customization to use.
- 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. - 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.
Instant clone domain account. This is the administrator which will add the machines to its domain.
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.
Customization specification to use when Sysprep customization is requested. This is required if customization_type is set to SYS_PREP
Datastore settings for the automated farm.
{
"datastore_id": "datastore-1"
}
Id of the datastore.
Datastore settings for the automated farm.
{
"datastore_id": "datastore-1",
"storage_overcommit": "CONSERVATIVE"
}
Id of the datastore.
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.
- NONE: No overcommit.
- CONSERVATIVE: Conservative.
- MODERATE: Moderate.
- AGGRESSIVE: Aggressive.
- UNBOUNDED: Unbounded.
Datastore settings for the automated farm.
{
"datastore_id": "datastore-1"
}
Id of the datastore.
Display protocol settings for the Farm.
{
"allow_display_protocol_override": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"html_access_enabled": true,
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile"
}
Indicates whether the display protocol settings could be overridden.If set to false, then default_display_protocol is used.Default value is true.
The default server display protocol. Default value is PCOIP.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
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.
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.
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.
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.
Display protocol settings for the farm.
{
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": true,
"session_collaboration_enabled": "boolean"
}
Indicates whether the users can choose the protocol. Default value is true.
Indicates default server display protocol, when user is not allowed to choose protocol.Farms support PCOIP, RDP and BLAST. Default value is PCOIP.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
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.
Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users. Default value is false.
Display protocol settings for the farm.
{
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile"
}
Indicates whether the users can choose the protocol. This property can be used for sorting.
Indicates default server display protocol, when user is not allowed to choose protocol.Farms support PCOIP, RDP and BLAST. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
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 can be used for sorting.
Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users. This property can be used for sorting.
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. This property can be used for sorting.
Display protocol settings for the farm.
{
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"session_collaboration_enabled": "boolean"
}
Indicates whether the users can choose the protocol.
Indicates default server display protocol, when user is not allowed to choose protocol.Farms support PCOIP, RDP and BLAST.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users.
Information related to Farm.
{
"description": "Farm description",
"display_name": "Farm-display-1",
"enabled": true,
"id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"name": "ManualFarm1",
"settings": {
"delete_in_progess": "boolean",
"desktop_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_protocol_settings": {
"allow_display_protocol_override": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"html_access_enabled": true,
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile"
},
"load_balancer_settings": {
"custom_script_in_use": "boolean",
"lb_metric_settings": {
"cpu_threshold": 50,
"disk_queue_length_threshold": 50,
"disk_read_latency_threshold": 50,
"disk_write_latency_threshold": 50,
"include_session_count": true,
"memory_threshold": 50
}
},
"server_error_threshold": 5,
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER"
}
},
"source": "INSTANT_CLONE",
"type": "AUTOMATED"
}
Farm description. The maximum length is 1024 characters.
Display name of the Farm. The maximum length is 256 characters.
Indicates whether the Farm is enabled for brokering. Default value is true.
Unique ID representing Farm.
Name of the Farm. The maximum length is 64 characters.
Type of the Farm.
- INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.
- LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.
Type of the Farm.
- AUTOMATED: Automated Farm.
- MANUAL: Manual Farm.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean"
},
"enable_provisioning": true,
"image_source": "VIRTUAL_CENTER",
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "READY",
"instant_clone_operation": "INITIAL_PUBLISH",
"instant_clone_operation_time": 1587081283000,
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_scheduled_maintenance_data": {
"immediate_maintenance_scheduled": true,
"logoff_policy": "WAIT_FOR_LOGOFF",
"next_scheduled_time": 1237081283000,
"recurring_maintenance_settings": {
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
},
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"storage_overcommit": "CONSERVATIVE"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
},
"delete_in_progress": "boolean",
"description": "Farm Description",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile"
},
"enabled": true,
"id": "50d77b95-fcc0-448a-a478-ec4f3b657ca4",
"load_balancer_settings": {
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"memory_threshold": 10
},
"name": "ManualFarm",
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER"
},
"type": "MANUAL",
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'.
Indicates whether the farm is in the process of being deleted.
Supported Filters: 'Equals'. This property can be used for sorting.
Description of the farm. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of RDS desktop pool associated with the farm.
Supported Filters: 'Equals'.
Display name of the farm. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether the farm is enabled for brokering.
Supported Filters: 'Equals'. This property can be used for sorting.
Unique ID representing farm.
Supported Filters: 'Equals'.
Name of the farm. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. This property can be used for sorting.
Type of the farm.
Supported Filters: 'Equals'. This property can be used for sorting.
- AUTOMATED: Automated Farm.
- MANUAL: Manual Farm.
Indicates whether to use custom scripts for load balancing or not. This property can be used for sorting.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"image_source": "VIRTUAL_CENTER",
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "READY",
"instant_clone_operation": "INITIAL_PUBLISH",
"instant_clone_operation_time": 1587081283000,
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_scheduled_maintenance_data": {
"immediate_maintenance_scheduled": true,
"logoff_policy": "WAIT_FOR_LOGOFF",
"next_scheduled_time": 1237081283000,
"recurring_maintenance_settings": {
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
},
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"storage_overcommit": "CONSERVATIVE"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
},
"delete_in_progress": "boolean",
"description": "Farm Description",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile"
},
"enabled": true,
"id": "50d77b95-fcc0-448a-a478-ec4f3b657ca4",
"load_balancer_settings": {
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"memory_threshold": 10
},
"name": "ManualFarm",
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER"
},
"type": "MANUAL",
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'.
Indicates whether the farm is in the process of being deleted.
Supported Filters: 'Equals'. This property can be used for sorting.
Description of the farm. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of RDS desktop pool associated with the farm.
Supported Filters: 'Equals'.
Display name of the farm. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether the farm is enabled for brokering.
Supported Filters: 'Equals'. This property can be used for sorting.
Unique ID representing farm.
Supported Filters: 'Equals'.
Name of the farm. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. This property can be used for sorting.
Type of the farm.
Supported Filters: 'Equals'. This property can be used for sorting.
- AUTOMATED: Automated Farm.
- MANUAL: Manual Farm.
Indicates whether to use custom scripts for load balancing or not. This property can be used for sorting.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"image_source": "VIRTUAL_CENTER",
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "READY",
"instant_clone_operation": "INITIAL_PUBLISH",
"instant_clone_operation_time": 1587081283000,
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_scheduled_maintenance_data": {
"immediate_maintenance_scheduled": true,
"logoff_policy": "WAIT_FOR_LOGOFF",
"next_scheduled_time": 1237081283000,
"recurring_maintenance_settings": {
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
},
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000,
"pending_compute_profile_num_cores_per_socket": 1,
"pending_compute_profile_num_cpus": 4,
"pending_compute_profile_ram_mb": 4096
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"storage_overcommit": "CONSERVATIVE"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
},
"delete_in_progress": "boolean",
"description": "Farm Description",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile"
},
"enabled": true,
"id": "50d77b95-fcc0-448a-a478-ec4f3b657ca4",
"load_balancer_settings": {
"connecting_session_threshold": 10,
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"load_index_threshold": 20,
"memory_threshold": 10
},
"name": "ManualFarm",
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"session_timeout_policy": "DEFAULT"
},
"type": "MANUAL",
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'.
Indicates whether the farm is in the process of being deleted.
Supported Filters: 'Equals'. This property can be used for sorting.
Description of the farm. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of RDS desktop pool associated with the farm.
Supported Filters: 'Equals'.
Display name of the farm. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether the farm is enabled for brokering.
Supported Filters: 'Equals'. This property can be used for sorting.
Unique ID representing farm.
Supported Filters: 'Equals'.
Name of the farm. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. This property can be used for sorting.
Type of the farm.
Supported Filters: 'Equals'. This property can be used for sorting.
- AUTOMATED: Automated Farm.
- MANUAL: Manual Farm.
Indicates whether to use custom scripts for load balancing or not. This property can be used for sorting.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"app_volumes_manager_guid": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"image_source": "VIRTUAL_CENTER",
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "READY",
"instant_clone_operation": "INITIAL_PUBLISH",
"instant_clone_operation_time": 1587081283000,
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_scheduled_maintenance_data": {
"immediate_maintenance_scheduled": true,
"logoff_policy": "WAIT_FOR_LOGOFF",
"next_scheduled_time": 1237081283000,
"recurring_maintenance_settings": {
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
},
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000,
"pending_compute_profile_num_cores_per_socket": 1,
"pending_compute_profile_num_cpus": 4,
"pending_compute_profile_ram_mb": 4096
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"storage_overcommit": "CONSERVATIVE"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
},
"delete_in_progress": "boolean",
"description": "Farm Description",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile"
},
"enabled": true,
"id": "50d77b95-fcc0-448a-a478-ec4f3b657ca4",
"load_balancer_settings": {
"connecting_session_threshold": 10,
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"load_index_threshold": 20,
"memory_threshold": 10
},
"name": "ManualFarm",
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"session_timeout_policy": "DEFAULT"
},
"type": "MANUAL",
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'.
Associated app volumes manager id for the Farm.
Indicates whether the farm is in the process of being deleted.
Supported Filters: 'Equals'. This property can be used for sorting.
Description of the farm. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of RDS desktop pool associated with the farm.
Supported Filters: 'Equals'.
Display name of the farm. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether the farm is enabled for brokering.
Supported Filters: 'Equals'. This property can be used for sorting.
Unique ID representing farm.
Supported Filters: 'Equals'.
Name of the farm. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. This property can be used for sorting.
Type of the farm.
Supported Filters: 'Equals'. This property can be used for sorting.
- AUTOMATED: Automated Farm.
- MANUAL: Manual Farm.
Indicates whether to use custom scripts for load balancing or not. This property can be used for sorting.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"app_volumes_manager_guid": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"image_source": "VIRTUAL_CENTER",
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
},
"provisioning_status_data": {
"instant_clone_current_image_state": "READY",
"instant_clone_operation": "INITIAL_PUBLISH",
"instant_clone_operation_time": 1587081283000,
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_scheduled_maintenance_data": {
"immediate_maintenance_scheduled": true,
"logoff_policy": "WAIT_FOR_LOGOFF",
"next_scheduled_time": 1237081283000,
"recurring_maintenance_settings": {
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
},
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000,
"pending_compute_profile_num_cores_per_socket": 1,
"pending_compute_profile_num_cpus": 4,
"pending_compute_profile_ram_mb": 4096
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1",
"storage_overcommit": "CONSERVATIVE"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
},
"transparent_page_sharing_scope": "VM",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
},
"delete_in_progress": "boolean",
"description": "Farm Description",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile"
},
"enabled": true,
"id": "50d77b95-fcc0-448a-a478-ec4f3b657ca4",
"load_balancer_settings": {
"connecting_session_threshold": 10,
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"load_index_threshold": 20,
"memory_threshold": 10
},
"name": "ManualFarm",
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"session_timeout_policy": "DEFAULT"
},
"type": "MANUAL",
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Supported Filters: 'Equals'.
Associated app volumes manager id for the Farm.
Indicates whether the farm is in the process of being deleted.
Supported Filters: 'Equals'. This property can be used for sorting.
Description of the farm. The maximum length is 1024 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of RDS desktop pool associated with the farm.
Supported Filters: 'Equals'.
Display name of the farm. The maximum length is 256 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether the farm is enabled for brokering.
Supported Filters: 'Equals'. This property can be used for sorting.
Unique ID representing farm.
Supported Filters: 'Equals'.
Name of the farm. The maximum length is 64 characters.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state. This property can be used for sorting.
Type of the farm.
Supported Filters: 'Equals'. This property can be used for sorting.
- AUTOMATED: Automated Farm.
- MANUAL: Manual Farm.
Indicates whether to use custom scripts for load balancing or not. This property can be used for sorting.
Settings for load balancing the session requests across the RDS servers in the farm.
{
"custom_script_in_use": "boolean",
"lb_metric_settings": {
"cpu_threshold": 50,
"disk_queue_length_threshold": 50,
"disk_read_latency_threshold": 50,
"disk_write_latency_threshold": 50,
"include_session_count": true,
"memory_threshold": 50
}
}
Indicates whether to use custom scripts for Load Balancing.Default is false.
The specification to schedule maintenance.
{
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"logoff_policy": "FORCE_LOGOFF",
"maintenance_mode": "IMMEDIATE",
"next_scheduled_time": 1237081283000,
"parent_vm_id": "vm-2",
"recurring_maintenance_settings": {
"maintenance_period": "MONTHLY",
"maintenance_period_frequency": 10,
"start_index": 2,
"start_time": "10:00"
},
"snapshot_id": "snapshot-1",
"stop_on_first_error": "boolean"
}
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.
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.
Determines when to perform the operation on RDS servers which have an active session.
- 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.
- WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
The mode of schedule maintenance for Instant Clone Farm.
- IMMEDIATE: All server VMs will be refreshed once, immediately or at user scheduled time.
- RECURRING: All server VMs will be periodically refreshed based on FarmInstantCloneRecurringMaintenancePeriod and StartTime
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.
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
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.
Indicates whether the operation should stop on first error. Default value is true.
The specification to schedule maintenance.
{
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"logoff_policy": "FORCE_LOGOFF",
"maintenance_mode": "IMMEDIATE",
"next_scheduled_time": 1237081283000,
"parent_vm_id": "vm-2",
"rds_server_ids": [
"816d44cb-b486-3c97-adcb-cf3806d53657",
"414927f3-1a3b-3e4c-81b3-d39602f634dc"
],
"recurring_maintenance_settings": {
"maintenance_period": "MONTHLY",
"maintenance_period_frequency": 10,
"start_index": 2,
"start_time": "10:00"
},
"selective_schedule_maintenance": true,
"snapshot_id": "snapshot-1",
"stop_on_first_error": "boolean"
}
Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones. If set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set.
Indicates the number of CPUs in the compute profile to be configured on clones. If set, this must be a multiple of compute_profile_num_cores_per_socket.
Indicates the RAM in MB in the compute profile to be configured on clones.
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.
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.
Determines when to perform the operation on RDS servers which have an active session.
- 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.
- WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
The mode of schedule maintenance for Instant Clone Farm.
- IMMEDIATE: All server VMs will be refreshed once, immediately or at user scheduled time.
- RECURRING: All server VMs will be periodically refreshed based on FarmInstantCloneRecurringMaintenancePeriod and StartTime
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.
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.
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.
recurring_maintenance_settings
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.
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.
Indicates whether the operation should stop on first error. Default value is true.
Details of the Farm.
{
"source": "LINKED_CLONE",
"type": "AUTOMATED"
}
Source of farm machines. This property is required if type is set to "AUTOMATED".
- LINKED_CLONE: Linked clone share the same base image and use less storage space than full RDS Servers.
- INSTANT_CLONE: Instant clone engine uses vmfork technology to create the instant clones. These clones take much less time for provisioning.
Farm type.
- AUTOMATED: Automated Farm.
- MANUAL: Manual farm.
Monitoring information related to Farm.
{
"application_count": 12,
"details": {
"source": "LINKED_CLONE",
"type": "AUTOMATED"
},
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"name": "farm1",
"rds_server_count": 123,
"status": "OK"
}
Number of Applications published from the farm.
Unique ID of the Farm.
Farm name.
Number of RDS Servers in the farm.
Status of Farm.
- 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).
- WARNING: Farm is enabled. One or more of the following is true:
- One or more server(s) is either in WARNING or ERROR (not exceeding the predefined threshold) state.
- The RDS Servers in this Farm present a mix of both known and unknown load preferences.
- 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.
- DISABLED: Farm is disabled.
Network interface card settings for RDS Servers provisioned for the farm.
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
ID of the network interface card for these settings.
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.
Network interface card settings for RDS Servers provisioned for the farm.
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_interface_card_name": "Network adapter 1",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
ID of the network interface card for these settings.
Name of the network interface card for these settings.
Automatic network label assignment feature settings for this NIC.
Network interface card settings for RDS Servers provisioned for the farm.
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
ID of the network interface card for these settings.
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.
Network label assignment settings for the farm.
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
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.
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.
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.
- UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.
- LIMITED: The network label assignment specification has a limited number of labels to assign.
The network label id for this spec. This network label must not have any incompatibility reasons that would preclude it from automatic machine assignment.
Network label assignment settings for the farm.
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
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.
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.
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.
- UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.
- LIMITED: The network label assignment specification has a limited number of labels to assign.
The network label id for this spec. This network label must not have any incompatibility reasons that would preclude it from automatic machine assignment.
Virtual center provisioning settings for the farm.
{
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
}
Current image snapshot for instant clone farm.
Datacenter within which the farm is configured
Host or cluster where the machines are deployed in. For Instant clone farms it can be only be a cluster id.
Image management stream used in the farm. This is required if parent_vm_id and base_snapshot_id are not set.
Image management tag used in the farm. This is required if im_stream_id is set.
Current VM image for instant clone farm.
Resource pool to deploy the RDS Servers.
VM folder to deploy the RDS Servers to.
Virtual center provisioning settings for the farm.
{
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
}
Current image snapshot for instant clone farm.
Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones. If set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set.
Indicates the number of CPUs in the compute profile to be configured on clones. If set, this must be a multiple of compute_profile_num_cores_per_socket.
Indicates the RAM in MB in the compute profile to be configured on clones.
Datacenter within which the farm is configured
Host or cluster where the machines are deployed in. For Instant clone farms it can be only be a cluster id.
Image management stream used in the farm. This is required if parent_vm_id and base_snapshot_id are not set.
Image management tag used in the farm. This is required if im_stream_id is set.
Current VM image for instant clone farm.
Resource pool to deploy the RDS Servers.
VM folder to deploy the RDS Servers to.
Virtual center provisioning settings for the farm.
{
"base_snapshot_id": "snapshot-1",
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
}
Current image snapshot for instant clone farm.
Datacenter within which the farm is configured
Host or cluster where the machines are deployed in.
Image management stream used in the farm.
Supported Filters: 'Equals'.
Image management tag used in the farm.
Supported Filters: 'Equals'.
Current VM image for instant clone farm.
Resource pool to deploy the RDS Servers.
VM folder to deploy the RDS Servers to.
Virtual center provisioning settings for the farm.
{
"base_snapshot_id": "snapshot-1",
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"datacenter_id": "datacenter-1",
"host_or_cluster_id": "domain-s425",
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"parent_vm_id": "vm-2",
"resource_pool_id": "resgroup-1",
"vm_folder_id": "group-v1"
}
Current image snapshot for instant clone farm.
Indicates the number of cores per socket for the CPU in the compute profile configured on clones.
Indicates the number of CPUs in the compute profile configured on clones.
Indicates the RAM in MB in the compute profile configured on clones.
Datacenter within which the farm is configured
Host or cluster where the machines are deployed in.
Image management stream used in the farm.
Supported Filters: 'Equals'.
Image management tag used in the farm.
Supported Filters: 'Equals'.
Current VM image for instant clone farm.
Resource pool to deploy the RDS Servers.
VM folder to deploy the RDS Servers to.
Virtual center provisioning settings for the farm.
{
"host_or_cluster_id": "domain-s425",
"resource_pool_id": "resgroup-1"
}
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 to deploy the RDS Servers.
Provisioning status data about this automated farm.
{
"instant_clone_current_image_state": "READY",
"instant_clone_operation": "INITIAL_PUBLISH",
"instant_clone_operation_time": 1587081283000,
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_scheduled_maintenance_data": {
"immediate_maintenance_scheduled": true,
"logoff_policy": "WAIT_FOR_LOGOFF",
"next_scheduled_time": 1237081283000,
"recurring_maintenance_settings": {
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
},
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000
}
This represents the state of the current image of this instant clone farms. This property can be used for sorting.
- FAILED: This is the state of the current image if instant clone delete operation has failed or timed out.
- PENDING_UNPUBLISH: This is the state of the current image before instant clone delete or cluster edit or datastore(s) edit operation(s) begins.
- 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.
- 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.
The operation that this instant clone farm is undergoing.
- NONE: There is no current operation on the farm.
- INITIAL_PUBLISH: The farm has just been created and is undergoing initial publishing.
- RECURRING_SCHEDULED_MAINTENANCE: Recurring maintenance operation is scheduled on the farm.
- CANCEL_SCHEDULED_MAINTENANCE: The recurring maintenance operation on the farm is being cancelled.
- INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the farm.
- FINAL_UNPUBLISH: A farm has been deleted and is undergoing final unpublishing.
Time of the operation that instant clone farm is undergoing.
Pending image management stream for instant clone farms.
Supported Filters: 'Equals'.
Pending image management tag for instant clone farms.
Supported Filters: 'Equals'.
This represents the error message if publishing of push image operation is failed.
Pending base image VM for instant clone farms. This is used to return the information about the parent VM of the pending Image.
This represents the pending image publish progress in percentage for an instant clone farm. This property can be used for sorting.
Pending base image snapshot for instant clone farms. This is used to return the information about the snapshot of the pending image.
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. This property can be used for sorting.
- FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.
- PENDING_PUBLISH: This is the initial transient state of the pending image before instant clone creation operation has started.
- PUBLISHING: This is the transient state of the pending image when creation of instant clone operation is going on.
- 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.
- 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.
- 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.
instant_clone_scheduled_maintenance_data
String message detailing the last provisioning error on this farm while stop_provisioning_on_error is enabled.
Time the last provisioning error occurred on this farm while stop_provisioning_on_error is enabled. Measured as epoch time.
Provisioning status data about this automated farm.
{
"instant_clone_current_image_state": "READY",
"instant_clone_operation": "INITIAL_PUBLISH",
"instant_clone_operation_time": 1587081283000,
"instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
"instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
"instant_clone_pending_image_parent_vm_id": "vm-1",
"instant_clone_pending_image_progress": 10,
"instant_clone_pending_image_snapshot_id": "snapshot-1",
"instant_clone_pending_image_state": "FAILED",
"instant_clone_scheduled_maintenance_data": {
"immediate_maintenance_scheduled": true,
"logoff_policy": "WAIT_FOR_LOGOFF",
"next_scheduled_time": 1237081283000,
"recurring_maintenance_settings": {
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
},
"stop_on_first_error": true
},
"last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
"last_provisioning_error_time": 1587081283000,
"pending_compute_profile_num_cores_per_socket": 1,
"pending_compute_profile_num_cpus": 4,
"pending_compute_profile_ram_mb": 4096
}
This represents the state of the current image of this instant clone farms. This property can be used for sorting.
- FAILED: This is the state of the current image if instant clone delete operation has failed or timed out.
- PENDING_UNPUBLISH: This is the state of the current image before instant clone delete or cluster edit or datastore(s) edit operation(s) begins.
- 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.
- 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.
The operation that this instant clone farm is undergoing.
- NONE: There is no current operation on the farm.
- INITIAL_PUBLISH: The farm has just been created and is undergoing initial publishing.
- RECURRING_SCHEDULED_MAINTENANCE: Recurring maintenance operation is scheduled on the farm.
- CANCEL_SCHEDULED_MAINTENANCE: The recurring maintenance operation on the farm is being cancelled.
- INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the farm.
- FINAL_UNPUBLISH: A farm has been deleted and is undergoing final unpublishing.
Time of the operation that instant clone farm is undergoing.
Pending image management stream for instant clone farms.
Supported Filters: 'Equals'.
Pending image management tag for instant clone farms.
Supported Filters: 'Equals'.
This represents the error message if publishing of push image operation is failed.
Pending base image VM for instant clone farms. This is used to return the information about the parent VM of the pending Image.
This represents the pending image publish progress in percentage for an instant clone farm. This property can be used for sorting.
Pending base image snapshot for instant clone farms. This is used to return the information about the snapshot of the pending image.
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. This property can be used for sorting.
- FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.
- PENDING_PUBLISH: This is the initial transient state of the pending image before instant clone creation operation has started.
- PUBLISHING: This is the transient state of the pending image when creation of instant clone operation is going on.
- 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.
- 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.
- 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.
instant_clone_scheduled_maintenance_data
String message detailing the last provisioning error on this farm while stop_provisioning_on_error is enabled.
Time the last provisioning error occurred on this farm while stop_provisioning_on_error is enabled. Measured as epoch time.
Indicates the pending number of cores per socket for the CPU in the compute profile configured on clones.
Indicates the pending number of CPUs in the compute profile configured on clones.
Indicates the pending RAM in MB in the compute profile configured on clones.
RDS server naming Pattern settings for the farm.
{
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
}
Maximum number of RDS Servers in the farm. Default value is 1.
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.
RDS server naming Pattern settings for the farm.
{
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
}
Maximum number of RDS Servers in the farm. This property can be used for sorting.
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. If the numeric placement token not present, then maximum length is 14 characters.
Supported Filters: 'Equals'. This property can be used for sorting.
RDS server naming Pattern settings for the farm.
{
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
}
Maximum number of RDS Servers in the farm.
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.
Settings for recurring maintenance operation for the farm.
{
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
}
Settings for recurring maintenance operations.
- DAILY: Daily recurring maintenance
- WEEKLY: Weekly recurring maintenance
- MONTHLY: Monthly recurring maintenance
Indicates frequency of repeating maintenance and is expressed as a multiple of the maintenance_period.
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 configured for the recurring maintenance. This is in the form hh:mm in 24 hours format
Settings for recurring maintenance operation for the farm. This is Required only if maintenance_mode is set to RECURRING
{
"maintenance_period": "MONTHLY",
"maintenance_period_frequency": 10,
"start_index": 2,
"start_time": "10:00"
}
This represents the frequency at which to perform recurring maintenance.
- DAILY: Daily recurring maintenance
- WEEKLY: Weekly recurring maintenance
- MONTHLY: Monthly recurring maintenance
Indicates how frequently to repeat maintenance, expressed as multiple of the maintenance period. e.g. Every 2 weeks. Default value is 1.
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
Start time configured for the recurring maintenance. This should be in the form hh:mm in 24 hours format.
Scheduled maintenance settings for the automated farm.
{
"immediate_maintenance_scheduled": true,
"logoff_policy": "WAIT_FOR_LOGOFF",
"next_scheduled_time": 1237081283000,
"recurring_maintenance_settings": {
"maintenance_period": "WEEKLY",
"maintenance_period_frequency": 10,
"start_index": 1,
"start_time": "10:00"
},
"stop_on_first_error": true
}
Indicates whether immediate maintenance is scheduled.
Determines when to perform the operation on RDS servers which have an active session.
- 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.
- WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
Time when next scheduled maintenance would happen.
recurring_maintenance_settings
Indicates whether the operation should stop on first error.
Session related settings for the Farm.
{
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER"
}
Disconnected sessions timeout (in minutes).Will be set when disconnected_session_timeout_policy is set to AFTER.
Log-off policy after disconnected session. Default value is NEVER.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
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.
Application empty session timeout policy. Default value is AFTER.
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
After timeout, empty application sessions are logged off when set to true. Otherwise sessions are disconnected.Default value is false.
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.
Pre-launch session timeout policy for the application sessions on this Farm.
- AFTER: Pre-launched session is disconnected after specified number of minutes.
- NEVER: Pre-launched session is never disconnected.
Session settings related to the Farm.
{
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER"
}
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.
Log-off policy after disconnected session. Default value is NEVER.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
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.
Application empty session timeout policy. Default value is AFTER
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
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.
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.
Application pre-launch session timeout policy. Default value is AFTER
- AFTER: Pre-launched session is disconnected after specified number of minutes.
- NEVER: Pre-launched session is never disconnected.
Session settings related to the Farm.
{
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"session_timeout_policy": "DEFAULT"
}
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.
Log-off policy after disconnected session. Default value is NEVER.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
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.
Application empty session timeout policy. Default value is AFTER
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
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.
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.
Application pre-launch session timeout policy. Default value is AFTER
- AFTER: Pre-launched session is disconnected after specified number of minutes.
- NEVER: Pre-launched session is never disconnected.
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.
- DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
- NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
Session settings related to the Farm.
{
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER"
}
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. This property can be used for sorting.
Log-off policy after disconnected session. This property can be used for sorting.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
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. This property can be used for sorting.
Application empty session timeout policy. This property can be used for sorting.
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. This property can be used for sorting.
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. This property can be used for sorting.
Application pre-launch session timeout policy. This property can be used for sorting.
- AFTER: Pre-launched session is disconnected after specified number of minutes.
- NEVER: Pre-launched session is never disconnected.
Session settings related to the Farm.
{
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"session_timeout_policy": "DEFAULT"
}
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. This property can be used for sorting.
Log-off policy after disconnected session. This property can be used for sorting.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
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. This property can be used for sorting.
Application empty session timeout policy. This property can be used for sorting.
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. This property can be used for sorting.
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. This property can be used for sorting.
Application pre-launch session timeout policy. This property can be used for sorting.
- AFTER: Pre-launched session is disconnected after specified number of minutes.
- NEVER: Pre-launched session is never disconnected.
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. This property can be used for sorting.
- DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
- NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
Session settings related to the Farm.
{
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER"
}
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.
Log-off policy after disconnected session.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
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.
Application empty session timeout policy.
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
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
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.
Application pre-launch session timeout policy.
- AFTER: Pre-launched session is disconnected after specified number of minutes.
- NEVER: Pre-launched session is never disconnected.
Session settings related to the Farm.
{
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"session_timeout_policy": "DEFAULT"
}
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.
Log-off policy after disconnected session.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
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.
Application empty session timeout policy.
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
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
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.
Application pre-launch session timeout policy.
- AFTER: Pre-launched session is disconnected after specified number of minutes.
- NEVER: Pre-launched session is never disconnected.
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: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
- NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
Settings related to the Farm.
{
"delete_in_progess": "boolean",
"desktop_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"display_protocol_settings": {
"allow_display_protocol_override": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": "boolean",
"html_access_enabled": true,
"session_collaboration_enabled": "boolean",
"vgpu_grid_profile": "instant-profile"
},
"load_balancer_settings": {
"custom_script_in_use": "boolean",
"lb_metric_settings": {
"cpu_threshold": 50,
"disk_queue_length_threshold": 50,
"disk_read_latency_threshold": 50,
"disk_write_latency_threshold": 50,
"include_session_count": true,
"memory_threshold": 50
}
},
"server_error_threshold": 5,
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER"
}
}
Indicates whether the Farm is in the process of being deleted. Default value is false.
Desktop pool Id representing the RDS Desktop pool to which this Farm belongs.
The minimum number of machines that must be fully operational in order toavoid showing the farm in an error state. Default value is 0.
Virtual center storage settings for the farm.
{
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
}
List of IDs of the datastore used to store the RDS Server.
Datastore to store replica disks for instant clone machines. This is required if use_separate_datastores_replica_and_os_disks is set to true.
Indicates whether to use separate datastores for replica and OS disks. Default value is false.
Indicates whether to use view storage accelerator. Default value is false.
Indicates whether to use vSphere VSAN. Default value is false.
Virtual center storage settings for the farm.
{
"datastores": [
{
"datastore_id": "datastore-1",
"storage_overcommit": "CONSERVATIVE"
}
],
"replica_disk_datastore_id": "datastore-1",
"use_separate_datastores_replica_and_os_disks": "boolean",
"use_view_storage_accelerator": "boolean",
"use_vsan": "boolean"
}
List of IDs of the datastore used to store the RDS Server.
Datastore to store replica disks for instant clone machines. This is set when use_separate_datastores_replica_and_os_disks is true.
Indicates whether to use separate datastores for replica and OS disks.
Indicates whether to use view storage accelerator. This property can be used for sorting.
Indicates whether to use vSphere VSAN. This property can be used for sorting.
Virtual center storage settings for the farm.
{
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1"
}
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).
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).
Farm object to be updated.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"reuse_pre_existing_accounts": "boolean"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"host_or_cluster_id": "domain-s425",
"resource_pool_id": "resgroup-1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1"
},
"transparent_page_sharing_scope": "VM"
},
"description": "Farm Description",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"session_collaboration_enabled": "boolean"
},
"enabled": true,
"load_balancer_settings": {
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"memory_threshold": 10
},
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER"
},
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Description of the farm.
Display name of the farm.
Indicates whether the farm is enabled for brokering.
The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state.
Indicates whether to use custom scripts for load balancing or not.
Farm object to be updated.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"host_or_cluster_id": "domain-s425",
"resource_pool_id": "resgroup-1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1"
},
"transparent_page_sharing_scope": "VM"
},
"description": "Farm Description",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"session_collaboration_enabled": "boolean"
},
"enabled": true,
"load_balancer_settings": {
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"memory_threshold": 10
},
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER"
},
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Description of the farm.
Display name of the farm.
Indicates whether the farm is enabled for brokering.
The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state.
Indicates whether to use custom scripts for load balancing or not.
Farm object to be updated.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"host_or_cluster_id": "domain-s425",
"resource_pool_id": "resgroup-1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1"
},
"transparent_page_sharing_scope": "VM"
},
"description": "Farm Description",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"session_collaboration_enabled": "boolean"
},
"enabled": true,
"load_balancer_settings": {
"connecting_session_threshold": 10,
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"load_index_threshold": 20,
"memory_threshold": 10
},
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"session_timeout_policy": "DEFAULT"
},
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Description of the farm.
Display name of the farm.
Indicates whether the farm is enabled for brokering.
The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state.
Indicates whether to use custom scripts for load balancing or not.
Farm object to be updated.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"automated_farm_settings": {
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"cloneprep_customization_settings": {
"post_synchronization_script_name": "cloneprep_postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "cloneprep_poweroff_script",
"power_off_script_parameters": "p1 p2 p3",
"priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": "boolean",
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"max_session_type": "LIMITED",
"max_sessions": 50,
"min_ready_vms": "integer",
"nics": [
{
"network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
"network_label_assignment_specs": [
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
]
}
],
"pattern_naming_settings": {
"max_number_of_rds_servers": 5,
"naming_pattern": "vm-{n}-sales"
},
"provisioning_settings": {
"host_or_cluster_id": "domain-s425",
"resource_pool_id": "resgroup-1"
},
"stop_provisioning_on_error": true,
"storage_settings": {
"datastores": [
{
"datastore_id": "datastore-1"
}
],
"replica_disk_datastore_id": "datastore-1"
},
"transparent_page_sharing_scope": "VM"
},
"description": "Farm Description",
"display_name": "ManualFarm",
"display_protocol_settings": {
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"session_collaboration_enabled": "boolean"
},
"enabled": true,
"load_balancer_settings": {
"connecting_session_threshold": 10,
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"load_index_threshold": 20,
"memory_threshold": 10
},
"server_error_threshold": "integer",
"session_settings": {
"disconnected_session_timeout_minutes": 5,
"disconnected_session_timeout_policy": "NEVER",
"empty_session_timeout_minutes": 5,
"empty_session_timeout_policy": "AFTER",
"logoff_after_timeout": "boolean",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"session_timeout_policy": "DEFAULT"
},
"use_custom_script_for_load_balancing": "boolean"
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Description of the farm.
Display name of the farm.
Indicates whether the farm is enabled for brokering.
The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state.
Indicates whether to use custom scripts for load balancing or not.
Information related to Feature Settings.
{
"cloud_managed": true,
"enable_helpdesk": true,
"enable_image_management": true
}
Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines.
Determines whether Helpdesk feature is enabled or not. By default Helpdesk is enabled.
Determines whether Image Management feature is enabled or not. By default Image Management is disabled.
Feature settings object to be updated.
{
"cloud_managed": true
}
Indicates whether this cluster/pod is managed by Horizon Cloud Services. This will be false only when there are no cloud managed machines.
Federation access group object to be created.
{
"description": "This access group can be used to delegate administration of sales team inventories to specific administrators.",
"name": "Sales"
}
Federation Access Group Description.
Federation Access Group Name. This property must contain only alphanumerics, underscores, and dashes.
Information about Federation Access Group
{
"deletable": true,
"description": "This Federation access group can be used to delegate administration of global sales team inventories to specific administrators.",
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"name": "Sales"
}
Indicates whether this federation access group can be deleted.
Federation Access group description.
Unique ID representing this Federation Access Group.
Federation Access group name.
Information about Federation Access Group
{
"deletable": true,
"description": "This Federation access group can be used to delegate administration of global sales team inventories to specific administrators.",
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"name": "Sales",
"permission_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"6fd4638a-381f-4518-aed6-042aa3d9f14c"
]
}
Indicates whether this federation access group can be deleted.
Federation Access group description.
Unique ID representing this Federation Access Group.
Federation Access group name.
List of permission ids associated with federation access group.
GSSAPI Authenticator specification
{
"allow_legacy_clients": true,
"allow_ntlm_fallback": true,
"connection_server_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"enable_login_as_current_user": true,
"enforce_channel_bindings": true,
"trigger_mode": "ENABLED"
}
Indicates whether the legacy Horizon clients will be allowed to use login as current user.
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.
The list of Connection Servers for which this GSSAPI authenticator is enabled.
Indicates whether the login as current user is enabled or not.
Indicates whether channel bindings is supported or not.
Indicates True SSO trigger mode on sessions using this authenticator.
- DISABLED: Do not use True SSO.
- OPTIONAL: If no SSO credentials are provided then use True SSO otherwise use the supplied SSO credentials.
- ENABLED: Always use True SSO even if client supplied SSO credentials.
Information about to GSSAPI Authenticator.
{
"allow_legacy_clients": true,
"allow_ntlm_fallback": true,
"connection_servers": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"enable_login_as_current_user": true,
"enforce_channel_bindings": true,
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"trigger_mode": "ENABLED"
}
Indicates whether the legacy Horizon clients will be allowed to use login as current user.
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.
The list of Connection Servers for which this GSSAPI authenticator is enabled.
Indicates whether the login as current user is enabled or not.
Indicates whether channel bindings is supported or not.
Unique ID representing this GSSAPI Authenticator.
Indicates True SSO trigger mode on sessions using this authenticator.
- DISABLED: Do not use True SSO.
- OPTIONAL: If no SSO credentials are provided then use True SSO otherwise use the supplied SSO credentials.
- ENABLED: Always use True SSO even if client supplied SSO credentials.
GSSAPIAuthenticator whose settings need to be updated.
{
"allow_legacy_clients": true,
"allow_ntlm_fallback": true,
"enable_login_as_current_user": true,
"enforce_channel_bindings": true,
"trigger_mode": "ENABLED"
}
Indicates whether the legacy Horizon clients will be allowed to use login as current user.
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.
Indicates whether the login as current user is enabled or not.
Indicates whether channel bindings is supported or not.
Indicates True SSO trigger mode on sessions using this authenticator.
- DISABLED: Do not use True SSO.
- OPTIONAL: If no SSO credentials are provided then use True SSO otherwise use the supplied SSO credentials.
- ENABLED: Always use True SSO even if client supplied SSO credentials.
Information for user or group with gateway access
{
"ad_user_or_group_id": "S-1-5-21-1111111111-2222222222-3333333333-513"
}
The unique SID for the user or group.
Gateway Server to be registered
{
"name": "gateway1.example.com"
}
FQDN of gateway server which is to be registered.
Information about Gateway.
{
"address": "uag1.example.com",
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"internal": "boolean",
"name": "uag1.example.com",
"type": "UAG",
"version": "3.5.0"
}
Gateway host name or IP address.
Unique ID of the Gateway.
Indicates whether the gateway is internal.
Gateway name.
Type of the Gateway.
- UAG: Unified Access Gateway type.
- F5: F5 Gateway type.
- SG: SG type is for Security Server.
- SG_COHOSTED: SG-cohosted type is for Cohosted CS as gateway.
- UNKNOWN: Unknown type.
Version of the Gateway.
Details of the Gateway.
{
"address": "uag1.example.com",
"internal": "boolean",
"type": "UAG",
"version": "3.5.0"
}
Gateway host name or IP address.
Indicates if the Gateway is internal.
Type of the Gateway.
- UAG: Unified Access Gateway type.
- F5: F5 Gateway type.
- SG: SG type is for Security Server.
- SG_COHOSTED: SG-cohosted type is for Cohosted CS as gateway.
- UNKNOWN: Unknown type.
Version of the Gateway.
Monitoring information related to Gateways registered in the environment.
{
"active_connection_count": 1234,
"blast_connection_count": 10,
"details": {
"address": "uag1.example.com",
"internal": "boolean",
"type": "UAG",
"version": "3.5.0"
},
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"name": "uag1",
"pcoip_connection_count": 90,
"status": "OK"
}
Number of active connections for the gateway. Includes PCoIP and BLAST connection counts.
Number of BLAST connections for the gateway.
Unique ID of the Gateway.
Gateway name.
Number of PCoIP connections for the gateway.
Status of the Gateway.
- NOT_CONTACTED: There has been no contact from the gateway.
- PROBLEM: The gateway has reported a problem.
- 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.
- OK: The Gateway is working as expected.
Monitoring information related to Gateways registered in the environment.
{
"active_connection_count": 1234,
"blast_connection_count": 10,
"details": {
"address": "uag1.example.com",
"internal": "boolean",
"type": "UAG",
"version": "3.5.0"
},
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"last_updated_timestamp": 1582029025748,
"name": "uag1",
"pcoip_connection_count": 90,
"status": "OK"
}
Number of active connections for the gateway. Includes PCoIP and BLAST connection counts.
Number of BLAST connections for the gateway.
Unique ID of the Gateway.
The timestamp in milliseconds when the last update was obtained. Measured as epoch time.
Gateway name.
Number of PCoIP connections for the gateway.
Status of the Gateway.
- NOT_CONTACTED: There has been no contact from the gateway.
- PROBLEM: The gateway has reported a problem.
- 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.
- OK: The Gateway is working as expected.
Monitoring information related to Gateways registered in the environment.
{
"active_connection_count": 1234,
"blast_connection_count": 10,
"details": {
"address": "uag1.example.com",
"internal": "boolean",
"type": "UAG",
"version": "3.5.0"
},
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"last_updated_timestamp": 1582029025748,
"name": "uag1",
"pcoip_connection_count": 90,
"status": "OK",
"unrecognized_pcoip_requests_count": 2,
"unrecognized_tunnel_requests_count": 5,
"unrecognized_xmlapi_requests_count": 6
}
Number of active connections for the gateway. Includes PCoIP and BLAST connection counts.
Number of BLAST connections for the gateway.
Unique ID of the Gateway.
The timestamp in milliseconds when the last update was obtained. Measured as epoch time.
Gateway name.
Number of PCoIP connections for the gateway.
Status of the Gateway.
- NOT_CONTACTED: There has been no contact from the gateway.
- PROBLEM: The gateway has reported a problem.
- 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.
- OK: The Gateway is working as expected.
Number of unrecognized PCoIP Secure Gateway requests.
Number of unrecognized Tunnel requests.
Number of unrecognized XML API requests.
Information related to General Settings.
{
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data": [
{
"type": "WINDOWS",
"version": "7.5"
},
{
"type": "LINUX",
"version": "6.5"
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
}
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.
Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.
Determines how long a user can be idle before the Connection Server takes measure to protect the session.
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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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 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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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.
Determines how long an idle admin console session continues before the session times out.
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.
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 updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.
Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.
Enables 2 factor re-authentication after idle session timeout.
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.
Permits RDSServer operating systems to be used for non-RDS Machines.
The warning to be displayed before logging off the user.
The time to wait after the warning is displayed and before logging off the user.
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.
Indicates whether to hide the server URL in the Horizon client user interface.
Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.
Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.
The message to be displayed to Horizon clients which are blocked by the Connection Server.
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.
Determines whether or not to store the RDS Per Device Client Access License on Connection Server.
General settings object to be updated.
{
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data": [
{
"type": "WINDOWS",
"version": "7.5"
},
{
"type": "LINUX",
"version": "6.5"
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
}
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.
Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.
Determines how long a user can be idle before the broker takes measure to protect the session.
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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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 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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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.
Determines how long an idle admin console session continues before the session times out.
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.
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 updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.
Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.
Enables 2 factor re-authentication after idle session timeout.
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.
Permits RDSServer operating systems to be used for non-RDS Machines.
The warning to be displayed before logging off the user.
The time to wait after the warning is displayed and before logging off the user.
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.
Indicates whether to hide the server URL in the Horizon client user interface.
Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.
Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.
The message to be displayed to Horizon clients which are blocked by the Connection Server.
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.
Determines whether or not to store the RDS Per Device Client Access License on Broker.
General settings object to be updated.
{
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
}
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.
Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.
Determines how long a user can be idle before the broker takes measure to protect the session.
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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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 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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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.
Determines how long an idle admin console session continues before the session times out.
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.
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 updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.
Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.
Enables 2 factor re-authentication after idle session timeout.
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.
Permits RDSServer operating systems to be used for non-RDS Machines.
The warning to be displayed before logging off the user.
The time to wait after the warning is displayed and before logging off the user.
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.
Indicates whether to hide the server URL in the Horizon client user interface.
Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.
Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.
List of restricted Horizon Clients.
The message to be displayed to Horizon clients which are blocked by the Connection Server.
The message to be displayed to Horizon clients which are not recommended by the Connection Server.
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.
Determines whether or not to store the RDS Per Device Client Access License on Broker.
General settings object to be updated.
{
"api_session_timeout_minutes": 30,
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_admin_banner": "boolean",
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"enable_user_name_caching": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_admin_banner_header": "Attention",
"pre_login_admin_banner_message": "On proceeding, you agree that you fully comply with the laws of this organisation.",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
}
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.
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.
Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.
Determines how long a user can be idle before the broker takes measure to protect the session.
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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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 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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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.
Determines how long an idle admin console session continues before the session times out.
Enable/disable pre login message pop up before logging into Horizon admin console
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.
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 updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.
Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.
Enables 2 factor re-authentication after idle session timeout.
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.
Permits RDSServer operating systems to be used for non-RDS Machines.
UI Client provide 'remember me' option when this is set to true.
Default value is true.
The warning to be displayed before logging off the user.
The time to wait after the warning is displayed and before logging off the user.
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.
Indicates whether to hide the server URL in the Horizon client user interface.
Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.
Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
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.
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.
Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.
List of restricted Horizon Clients.
The message to be displayed to Horizon clients which are blocked by the Connection Server.
The message to be displayed to Horizon clients which are not recommended by the Connection Server.
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.
Determines whether or not to store the RDS Per Device Client Access License on Broker.
General settings object to be updated.
{
"api_session_timeout_minutes": 30,
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_admin_banner": "boolean",
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"enable_user_name_caching": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_admin_banner_header": "Attention",
"pre_login_admin_banner_message": "On proceeding, you agree that you fully comply with the laws of this organisation.",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"sso_discard_connection_type": "BOTH",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
}
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.
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.
Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.
Determines how long a user can be idle before the broker takes measure to protect the session.
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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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 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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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.
Determines how long an idle admin console session continues before the session times out.
Enable/disable pre login message pop up before logging into Horizon admin console
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.
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 updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.
Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.
Enables 2 factor re-authentication after idle session timeout.
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.
Permits RDSServer operating systems to be used for non-RDS Machines.
UI Client provide 'remember me' option when this is set to true.
Default value is true.
The warning to be displayed before logging off the user.
The time to wait after the warning is displayed and before logging off the user.
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.
Indicates whether to hide the server URL in the Horizon client user interface.
Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.
Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
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.
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.
Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.
List of restricted Horizon Clients.
The message to be displayed to Horizon clients which are blocked by the Connection Server.
The message to be displayed to Horizon clients which are not recommended by the Connection Server.
The type of connection for which the single sign on discard timeout minutes should be applied.
- NONE: Indicates the connections from client devices on neither private networks nor non-private networks.
- INTERNAL: Indicates the connections from client devices on private networks.
- EXTERNAL: Indicates the connections from client devices on non-private networks.
- BOTH: Indicates the connections from client devices both on private and non-private networks.
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.
Determines whether or not to store the RDS Per Device Client Access License on Broker.
Information related to General Settings.
{
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
}
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.
Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.
Determines how long a user can be idle before the Connection Server takes measure to protect the session.
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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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 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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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.
Determines how long an idle admin console session continues before the session times out.
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.
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 updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.
Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.
Enables 2 factor re-authentication after idle session timeout.
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.
Permits RDSServer operating systems to be used for non-RDS Machines.
The warning to be displayed before logging off the user.
The time to wait after the warning is displayed and before logging off the user.
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.
Indicates whether to hide the server URL in the Horizon client user interface.
Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.
Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.
List of restricted Horizon Clients.
The message to be displayed to Horizon clients which are blocked by the Connection Server.
The message to be displayed to Horizon clients which are not recommended by the Connection Server.
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.
Determines whether or not to store the RDS Per Device Client Access License on Connection Server.
Information related to General Settings.
{
"api_session_timeout_minutes": 30,
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_admin_banner": "boolean",
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_admin_banner_header": "Attention",
"pre_login_admin_banner_message": "On proceeding, you agree that you fully comply with the laws of this organisation.",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
}
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.
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.
Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.
Determines how long a user can be idle before the Connection Server takes measure to protect the session.
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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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 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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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.
Determines how long an idle admin console session continues before the session times out.
Enable/disable pre login message pop up before logging into Horizon admin console
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.
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 updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.
Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.
Enables 2 factor re-authentication after idle session timeout.
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.
Permits RDSServer operating systems to be used for non-RDS Machines.
The warning to be displayed before logging off the user.
The time to wait after the warning is displayed and before logging off the user.
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.
Indicates whether to hide the server URL in the Horizon client user interface.
Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.
Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
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.
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.
Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.
List of restricted Horizon Clients.
The message to be displayed to Horizon clients which are blocked by the Connection Server.
The message to be displayed to Horizon clients which are not recommended by the Connection Server.
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.
Determines whether or not to store the RDS Per Device Client Access License on Connection Server.
Information related to General Settings.
{
"api_session_timeout_minutes": 30,
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_admin_banner": "boolean",
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_admin_banner_header": "Attention",
"pre_login_admin_banner_message": "On proceeding, you agree that you fully comply with the laws of this organisation.",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"sso_discard_connection_type": "BOTH",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
}
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.
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.
Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.
Determines how long a user can be idle before the Connection Server takes measure to protect the session.
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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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 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.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
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.
Determines how long an idle admin console session continues before the session times out.
Enable/disable pre login message pop up before logging into Horizon admin console
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.
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 updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.
Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.
Enables 2 factor re-authentication after idle session timeout.
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.
Permits RDSServer operating systems to be used for non-RDS Machines.
The warning to be displayed before logging off the user.
The time to wait after the warning is displayed and before logging off the user.
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.
Indicates whether to hide the server URL in the Horizon client user interface.
Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.
Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
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.
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.
Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.
List of restricted Horizon Clients.
The message to be displayed to Horizon clients which are blocked by the Connection Server.
The message to be displayed to Horizon clients which are not recommended by the Connection Server.
The type of connection for which the single sign on discard timeout minutes should be applied.
- NONE: Indicates the connections from client devices on neither private networks nor non-private networks.
- INTERNAL: Indicates the connections from client devices on private networks.
- EXTERNAL: Indicates the connections from client devices on non-private networks.
- BOTH: Indicates the connections from client devices both on private and non-private networks.
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.
Determines whether or not to store the RDS Per Device Client Access License on Connection Server.
Global Application Entitlement object to be created.
{
"allow_users_to_choose_protocol": true,
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"default_display_protocol": "PCOIP",
"description": "global application entitlement description",
"display_name": "global-application-entitlement",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"federated_access_group_id": "310927ee-1195-44c3-b877-5b194b4b4ea8",
"multi_session_mode": "ENABLED_ENFORCED",
"multiple_session_auto_clean": true,
"name": "global-application-entitlement",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"shortcut_locations_v2": [
"DESKTOP"
],
"use_home_site": "boolean"
}
Indicates whether the users can choose the protocol used. Default value is true.
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.
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.
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".
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
Description of global application entitlement.
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.
Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools. Default value is false.
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.
Indicates whether the global application entitlement is enabled. Default value is true.
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 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"
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Indicates whether automatic session clean up is enabled. Default value is false.
Unique name used to identify the global application entitlement.
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 for this global application entitlement. Visibility and Placement policies are defined by this value. Default value of "ALL_SITES".
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
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.
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.
Global Application Entitlement object to be created.
{
"allow_users_to_choose_protocol": true,
"app_launch_limit_enabled": "boolean",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"default_display_protocol": "PCOIP",
"description": "global application entitlement description",
"display_name": "global-application-entitlement",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"federated_access_group_id": "310927ee-1195-44c3-b877-5b194b4b4ea8",
"multi_session_mode": "ENABLED_ENFORCED",
"multiple_session_auto_clean": true,
"name": "global-application-entitlement",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_distribution_policy": "NONE",
"shortcut_locations_v2": [
"DESKTOP"
],
"use_home_site": "boolean"
}
Indicates whether the users can choose the protocol used. Default value is true.
Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.
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.
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.
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".
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
Description of global application entitlement.
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.
Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools. Default value is false.
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.
Indicates whether the global application entitlement is enabled. Default value is true.
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 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"
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Indicates whether automatic session clean up is enabled. Default value is false.
Unique name used to identify the global application entitlement.
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 for this global application entitlement. Visibility and Placement policies are defined by this value. Default value of "ALL_SITES".
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session distribution policy to be used for this global application entitlement
- LOAD: Load index based load distribution.
- NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.
- SESSION: Session count based load distribution.
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.
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.
Information about Global Application Entitlement
{
"allow_users_to_choose_protocol": true,
"application_data": {
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"publisher": "Mozilla Corporation",
"version": "72.0.2"
},
"application_icon_ids": [
"98923489-102b-4ed3-953f-3dfe3d23e0fe",
"asa39i-102b-4ed3-953f-3d23esan0fe"
],
"backup_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"default_display_protocol": "string",
"description": "global application entitlement description",
"display_name": "global-application-entitlement",
"enable_client_restrictions": "boolean",
"enable_pre_launch": true,
"enabled": true,
"group_count": 5,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"local_application_pools_count": 2,
"member_pods": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"9238c-102b-4ed3-953f-3d23esan0fe"
],
"multi_session_mode": "ENABLED_ENFORCED",
"multiple_session_auto_clean": "boolean",
"name": "global-application-entitlement",
"primary_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"remote_application_pools_count": 10,
"require_home_site": "boolean",
"scope": "ALL_SITES",
"shortcut_locations": [
"desktop"
],
"supported_display_protocols": [
"PCOIP",
"BLAST"
],
"use_home_site": "boolean",
"user_count": 5,
"user_or_group_site_override_count": 2
}
Indicates whether the users can choose the protocol used. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.
Icons associated with the Global Application Entitlement
Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement. Supported Filters: 'Equals'.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
The default display protocol for the Global Application Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Application Entitlement that do not specify a protocol will use this value, not the value specified directly on the application pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
Description of Global Application Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether Global Application Entitlement can be pre-launched Supported Filters: 'Equals'. This property can be used for sorting.
Indicates if this Global Application Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.
Count of groups that are associated with this Global Application Entitlement.
Unique ID representing this Global Application Entitlement. Supported Filters: 'Equals'.
Count of application pools local to this pod that are associated with this Global Application Entitlement.
Pods that have application pools associated with this Global Application Entitlement.
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'. This property can be used for sorting.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.
Unique name used to identify the Global Application Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.
Count of application pools on remote pods that are associated with this Global Application Entitlement.
Indicates whether we fail if a home site isn't defined for this Global Application Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if categoryFolderName is provided.
The set of supported display protocols for the Global Application Entitlement. All the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.
Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.
Count of users that are associated with this Global Application Entitlement.
Count of all User Home Site overrides associated with this Global Application Entitlement (for either users or groups).
Information about Global Application Entitlement.
{
"allow_users_to_choose_protocol": true,
"application_data": {
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"publisher": "Mozilla Corporation",
"version": "72.0.2"
},
"application_icon_ids": [
"98923489-102b-4ed3-953f-3dfe3d23e0fe",
"asa39i-102b-4ed3-953f-3d23esan0fe"
],
"backup_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"default_display_protocol": "string",
"description": "global application entitlement description",
"display_name": "global-application-entitlement",
"enable_client_restrictions": "boolean",
"enable_pre_launch": true,
"enabled": true,
"federated_access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"group_count": 5,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"local_application_pools_count": 2,
"member_pods": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"9238c-102b-4ed3-953f-3d23esan0fe"
],
"multi_session_mode": "ENABLED_ENFORCED",
"multiple_session_auto_clean": "boolean",
"name": "global-application-entitlement",
"primary_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"remote_application_pools_count": 10,
"require_home_site": "boolean",
"scope": "ALL_SITES",
"shortcut_locations_v2": [
"DESKTOP"
],
"supported_display_protocols": [
"PCOIP",
"BLAST"
],
"use_home_site": "boolean",
"user_count": 5,
"user_or_group_site_override_count": 2
}
Indicates whether the users can choose the protocol used. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.
Icons associated with the Global Application Entitlement
Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement. Supported Filters: 'Equals'.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
The default display protocol for the Global Application Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Application Entitlement that do not specify a protocol will use this value, not the value specified directly on the application pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
Description of Global Application Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether Global Application Entitlement can be pre-launched Supported Filters: 'Equals'. This property can be used for sorting.
Indicates if this Global Application Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.
This represents id of the federated access group associated with the global application entitlement.
Count of groups that are associated with this Global Application Entitlement.
Unique ID representing this Global Application Entitlement. Supported Filters: 'Equals'.
Count of application pools local to this pod that are associated with this Global Application Entitlement.
Pods that have application pools associated with this Global Application Entitlement.
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'. This property can be used for sorting.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.
Unique name used to identify the Global Application Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.
Count of application pools on remote pods that are associated with this Global Application Entitlement.
Indicates whether we fail if a home site isn't defined for this Global Application Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Locations of the category folder in the user's OS containing a shortcut to the application.
The set of supported display protocols for the Global Application Entitlement. All the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.
Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.
Count of users that are associated with this Global Application Entitlement.
Count of all User Home Site overrides associated with this Global Application Entitlement (for either users or groups).
Information about Global Application Entitlement.
{
"allow_users_to_choose_protocol": true,
"app_launch_limit_enabled": "boolean",
"application_data": {
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"publisher": "Mozilla Corporation",
"version": "72.0.2"
},
"application_icon_ids": [
"98923489-102b-4ed3-953f-3dfe3d23e0fe",
"asa39i-102b-4ed3-953f-3d23esan0fe"
],
"backup_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"default_display_protocol": "string",
"description": "global application entitlement description",
"display_name": "global-application-entitlement",
"enable_client_restrictions": "boolean",
"enable_pre_launch": true,
"enabled": true,
"federated_access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"group_count": 5,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"local_application_pools_count": 2,
"member_pods": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"9238c-102b-4ed3-953f-3d23esan0fe"
],
"multi_session_mode": "ENABLED_ENFORCED",
"multiple_session_auto_clean": "boolean",
"name": "global-application-entitlement",
"primary_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"remote_application_pools_count": 10,
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_distribution_policy": "NONE",
"shortcut_locations_v2": [
"DESKTOP"
],
"supported_display_protocols": [
"PCOIP",
"BLAST"
],
"use_home_site": "boolean",
"user_count": 5,
"user_or_group_site_override_count": 2
}
Indicates whether the users can choose the protocol used. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.
Icons associated with the Global Application Entitlement
Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement. Supported Filters: 'Equals'.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
The default display protocol for the Global Application Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Application Entitlement that do not specify a protocol will use this value, not the value specified directly on the application pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
Description of Global Application Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether Global Application Entitlement can be pre-launched Supported Filters: 'Equals'. This property can be used for sorting.
Indicates if this Global Application Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.
This represents id of the federated access group associated with the global application entitlement.
Count of groups that are associated with this Global Application Entitlement.
Unique ID representing this Global Application Entitlement. Supported Filters: 'Equals'.
Count of application pools local to this pod that are associated with this Global Application Entitlement.
Pods that have application pools associated with this Global Application Entitlement.
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'. This property can be used for sorting.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.
Unique name used to identify the Global Application Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.
Count of application pools on remote pods that are associated with this Global Application Entitlement.
Indicates whether we fail if a home site isn't defined for this Global Application Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session distribution policy to be used for this global application entitlement
- LOAD: Load index based load distribution.
- NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.
- SESSION: Session count based load distribution.
Locations of the category folder in the user's OS containing a shortcut to the application.
The set of supported display protocols for the Global Application Entitlement. All the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.
Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.
Count of users that are associated with this Global Application Entitlement.
Count of all User Home Site overrides associated with this Global Application Entitlement (for either users or groups).
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.
{
"allow_users_to_choose_protocol": true,
"backup_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"default_display_protocol": "string",
"description": "global application entitlement description",
"display_name": "global-application-entitlement",
"enable_client_restrictions": "boolean",
"enable_pre_launch": true,
"enabled": true,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"multi_session_mode": "ENABLED_ENFORCED",
"multiple_session_auto_clean": "boolean",
"name": "global-application-entitlement",
"primary_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"shortcut_locations": [
"desktop"
],
"supported_display_protocols": [
"PCOIP",
"BLAST"
],
"use_home_site": "boolean"
}
Indicates whether the users can choose the protocol used. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement. Supported Filters: 'Equals'.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
The default display protocol for the Global Application Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Application Entitlement that do not specify a protocol will use this value, not the value specified directly on the application pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
Description of Global Application Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether Global Application Entitlement can be pre-launched Supported Filters: 'Equals'. This property can be used for sorting.
Indicates if this Global Application Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.
Unique ID representing this Global Application Entitlement. Supported Filters: 'Equals'.
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'. This property can be used for sorting.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.
Unique name used to identify the Global Application Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.
Indicates whether we fail if a home site isn't defined for this Global Application Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if categoryFolderName is provided.
The set of supported display protocols for the Global Application Entitlement. All the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.
Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.
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.
{
"allow_users_to_choose_protocol": true,
"backup_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"default_display_protocol": "string",
"description": "global application entitlement description",
"display_name": "global-application-entitlement",
"enable_client_restrictions": "boolean",
"enable_pre_launch": true,
"enabled": true,
"federated_access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"multi_session_mode": "ENABLED_ENFORCED",
"multiple_session_auto_clean": "boolean",
"name": "global-application-entitlement",
"primary_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"shortcut_locations_v2": [
"DESKTOP"
],
"supported_display_protocols": [
"PCOIP",
"BLAST"
],
"use_home_site": "boolean"
}
Indicates whether the users can choose the protocol used. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement. Supported Filters: 'Equals'.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
The default display protocol for the Global Application Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Application Entitlement that do not specify a protocol will use this value, not the value specified directly on the application pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
Description of Global Application Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether Global Application Entitlement can be pre-launched Supported Filters: 'Equals'. This property can be used for sorting.
Indicates if this Global Application Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.
This represents id of the federated access group associated with the global application entitlement.
Supported Filters: 'Equals'.
Unique ID representing this Global Application Entitlement. Supported Filters: 'Equals'.
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'. This property can be used for sorting.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.
Unique name used to identify the Global Application Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.
Indicates whether we fail if a home site isn't defined for this Global Application Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Locations of the category folder in the user's OS containing a shortcut to the application.
The set of supported display protocols for the Global Application Entitlement. All the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.
Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.
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.
{
"allow_users_to_choose_protocol": true,
"app_launch_limit_enabled": "boolean",
"backup_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"default_display_protocol": "string",
"description": "global application entitlement description",
"display_name": "global-application-entitlement",
"enable_client_restrictions": "boolean",
"enable_pre_launch": true,
"enabled": true,
"federated_access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"multi_session_mode": "ENABLED_ENFORCED",
"multiple_session_auto_clean": "boolean",
"name": "global-application-entitlement",
"primary_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_distribution_policy": "NONE",
"shortcut_locations_v2": [
"DESKTOP"
],
"supported_display_protocols": [
"PCOIP",
"BLAST"
],
"use_home_site": "boolean"
}
Indicates whether the users can choose the protocol used. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.
Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement. Supported Filters: 'Equals'.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
The default display protocol for the Global Application Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Application Entitlement that do not specify a protocol will use this value, not the value specified directly on the application pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
Description of Global Application Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether Global Application Entitlement can be pre-launched Supported Filters: 'Equals'. This property can be used for sorting.
Indicates if this Global Application Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.
This represents id of the federated access group associated with the global application entitlement.
Supported Filters: 'Equals'.
Unique ID representing this Global Application Entitlement. Supported Filters: 'Equals'.
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'. This property can be used for sorting.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.
Unique name used to identify the Global Application Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.
Indicates whether we fail if a home site isn't defined for this Global Application Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session distribution policy to be used for this global application entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
- LOAD: Load index based load distribution.
- NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.
- SESSION: Session count based load distribution.
Locations of the category folder in the user's OS containing a shortcut to the application.
The set of supported display protocols for the Global Application Entitlement. All the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.
Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.
Global Application Entitlement object to be updated.
{
"backup_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"default_display_protocol": "PCOIP",
"description": "global application entitlement description",
"display_name": "global-application-entitlement",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"federated_access_group_id": "310927ee-1195-44c3-b877-5b194b4b4ea8",
"multi_session_mode": "ENABLED_ENFORCED",
"multiple_session_auto_clean": true,
"name": "global-application-entitlement",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"shortcut_locations_v2": [
"DESKTOP"
],
"use_home_site": "boolean"
}
Global Application Entitlement that can be used as backup for this Global Application Entitlement.
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.
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.
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.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
Description of global application entitlement.
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.
Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools.
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".
Indicates whether the global application entitlement is enabled.
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 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.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Indicates whether automatic session clean up is enabled.
Unique name used to identify the global application entitlement.
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 for this global application entitlement. Visibility and Placement policies are defined by this value.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
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.
Indicates whether a pod in the user's home site is used to start the search or the current site is used.
Global Application Entitlement object to be updated.
{
"app_launch_limit_enabled": "boolean",
"backup_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cs_restriction_tags": [
"Internal",
"External"
],
"default_display_protocol": "PCOIP",
"description": "global application entitlement description",
"display_name": "global-application-entitlement",
"enable_client_restrictions": "boolean",
"enable_pre_launch": "boolean",
"enabled": true,
"federated_access_group_id": "310927ee-1195-44c3-b877-5b194b4b4ea8",
"multi_session_mode": "ENABLED_ENFORCED",
"multiple_session_auto_clean": true,
"name": "global-application-entitlement",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_distribution_policy": "NONE",
"shortcut_locations_v2": [
"DESKTOP"
],
"use_home_site": "boolean"
}
Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.
Global Application Entitlement that can be used as backup for this Global Application Entitlement.
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.
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.
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.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
Description of global application entitlement.
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.
Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools.
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".
Indicates whether the global application entitlement is enabled.
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 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.
- DISABLED: Multi-session is not supported for this application.
- 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.
- 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.
- 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.
Indicates whether automatic session clean up is enabled.
Unique name used to identify the global application entitlement.
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 for this global application entitlement. Visibility and Placement policies are defined by this value.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session distribution policy to be used for this global application entitlement
- LOAD: Load index based load distribution.
- NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.
- SESSION: Session count based load distribution.
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.
Indicates whether a pod in the user's home site is used to start the search or the current site is used.
Global Desktop Entitlement object to be created.
{
"allow_multiple_sessions_per_user": true,
"allow_users_to_choose_protocol": true,
"allow_users_to_reset_machines": true,
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"dedicated": true,
"default_display_protocol": "PCOIP",
"description": "global desktop entitlement description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": "boolean",
"display_name": "global-desktop-entitlement",
"enable_client_restrictions": "boolean",
"enabled": true,
"multiple_session_auto_clean": "boolean",
"name": "global-desktop-entitlement",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_collaboration_enabled": "boolean",
"shortcut_locations": [
"desktop"
],
"use_home_site": "boolean"
}
Indicates whether users can have multiple sessions when accessed from different client devices, this is also called Class room mode and applicable only to floating user assignment. If value is set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to have multiple sessions with allowMultipleSessionsPerUser. Default value is false.
Indicates whether the users can choose the protocol used. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Default value is true.
Indicates whether users are allowed to reset/restart their machines. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to reset/restart machines with allowUsersToResetMachines. Default value is false.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category.
Indicates whether this global desktop entitlement is managed from cloud. Default value is false.
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
Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement. Otherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Default value is false.
The default display protocol for the Global Desktop Entitlement. Clients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value, not the value specified directly on the desktop pool to which they connect (if different).This property has a default value of "PCOIP".
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
Description of Global Desktop Entitlement.
Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. If no machine is assigned to the user then "display_name (No machine assigned)" will be displayed in the client. Default value is false.
Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. Default value is false.
Name that users will see when they connect using Horizon Client. If display_name is left blank, it defaults to name.
Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Default value is false.
Indicates if this Global Desktop Entitlement is enabled.Default value is true.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Default value is false.
Unique name used to identify the Global Desktop Entitlement.
Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Default value is false.
Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value. This property has a default value of "ALL_SITES".
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Default value is false.
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.
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.
Global Desktop Entitlement object to be created.
{
"allow_multiple_sessions_per_user": true,
"allow_users_to_choose_protocol": true,
"allow_users_to_reset_machines": true,
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"dedicated": true,
"default_display_protocol": "PCOIP",
"description": "global desktop entitlement description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": "boolean",
"display_name": "global-desktop-entitlement",
"enable_client_restrictions": "boolean",
"enabled": true,
"federated_access_group_id": "310927ee-1195-44c3-b877-5b194b4b4ea8",
"multiple_session_auto_clean": "boolean",
"name": "global-desktop-entitlement",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_collaboration_enabled": "boolean",
"shortcut_locations_v2": [
"DESKTOP"
],
"use_home_site": "boolean"
}
Indicates whether users can have multiple sessions when accessed from different client devices, this is also called Class room mode and applicable only to floating user assignment. If value is set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to have multiple sessions with allowMultipleSessionsPerUser. Default value is false.
Indicates whether the users can choose the protocol used. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Default value is true.
Indicates whether users are allowed to reset/restart their machines. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to reset/restart machines with allowUsersToResetMachines. Default value is false.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category.
Indicates whether this global desktop entitlement is managed from cloud. Default value is false.
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
Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement. Otherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Default value is false.
The default display protocol for the Global Desktop Entitlement. Clients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value, not the value specified directly on the desktop pool to which they connect (if different).This property has a default value of "PCOIP".
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
Description of Global Desktop Entitlement.
Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. If no machine is assigned to the user then "display_name (No machine assigned)" will be displayed in the client. Default value is false.
Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. Default value is false.
Name that users will see when they connect using Horizon Client. If display_name is left blank, it defaults to name.
Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Default value is false.
Indicates if this Global Desktop Entitlement is enabled.Default value is true.
ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Default value is false.
Unique name used to identify the Global Desktop Entitlement.
Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Default value is false.
Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value. This property has a default value of "ALL_SITES".
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Default value is false.
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.
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.
Global Desktop Entitlement object to be created.
{
"allow_multiple_sessions_per_user": true,
"allow_users_to_choose_protocol": true,
"allow_users_to_reset_machines": true,
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"dedicated": true,
"default_display_protocol": "PCOIP",
"description": "global desktop entitlement description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": "boolean",
"display_name": "global-desktop-entitlement",
"enable_client_restrictions": "boolean",
"enabled": true,
"federated_access_group_id": "310927ee-1195-44c3-b877-5b194b4b4ea8",
"multiple_session_auto_clean": "boolean",
"name": "global-desktop-entitlement",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_collaboration_enabled": "boolean",
"session_distribution_policy": "NONE",
"shortcut_locations_v2": [
"DESKTOP"
],
"use_home_site": "boolean"
}
Indicates whether users can have multiple sessions when accessed from different client devices, this is also called Class room mode and applicable only to floating user assignment. If value is set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to have multiple sessions with allowMultipleSessionsPerUser. Default value is false.
Indicates whether the users can choose the protocol used. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Default value is true.
Indicates whether users are allowed to reset/restart their machines. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to reset/restart machines with allowUsersToResetMachines. Default value is false.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category.
Indicates whether this global desktop entitlement is managed from cloud. Default value is false.
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
Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement. Otherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Default value is false.
The default display protocol for the Global Desktop Entitlement. Clients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value, not the value specified directly on the desktop pool to which they connect (if different).This property has a default value of "PCOIP".
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
Description of Global Desktop Entitlement.
Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. If no machine is assigned to the user then "display_name (No machine assigned)" will be displayed in the client. Default value is false.
Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. Default value is false.
Name that users will see when they connect using Horizon Client. If display_name is left blank, it defaults to name.
Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Default value is false.
Indicates if this Global Desktop Entitlement is enabled.Default value is true.
ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Default value is false.
Unique name used to identify the Global Desktop Entitlement.
Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Default value is false.
Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value. This property has a default value of "ALL_SITES".
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Default value is false.
Session distribution policy to be used for this global desktop entitlement
- LOAD: Load index based load distribution.
- NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.
- SESSION: Session count based load distribution.
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.
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.
Information about Global Desktop Entitlement
{
"allow_multiple_sessions_per_user": true,
"allow_users_to_choose_protocol": true,
"allow_users_to_reset_machines": true,
"backup_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"dedicated": true,
"default_display_protocol": "string",
"description": "global desktop entitlement description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "global-desktop-entitlement",
"enable_client_restrictions": "boolean",
"enabled": true,
"group_count": 5,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"local_desktop_pools_count": 2,
"member_pods": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"9238c-102b-4ed3-953f-3d23esan0fe"
],
"multiple_session_auto_clean": "boolean",
"name": "global-desktop-entitlement",
"primary_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"remote_desktop_pools_count": 10,
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_collaboration_enabled": "boolean",
"shortcut_locations": [
"desktop"
],
"supported_display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"use_home_site": "boolean",
"user_count": 5,
"user_or_group_site_override_count": 2
}
Indicates whether users can have multiple sessions when accessed from different client devices, this is also called Class room mode and applicable only to floating user assignment. If value is set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to have multiple sessions with allowMultipleSessionsPerUser Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the users can choose the protocol used. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether users are allowed to reset/restart their machines. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to reset/restart machines with allowUsersToResetMachines. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement. Supported Filters: 'Equals'.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.
Indicates whether this global desktop entitlement is managed from cloud. Supported Filters: 'Equals'. This property can be used for sorting.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement. Otherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Supported Filters: 'Equals'. This property can be used for sorting.
The default display protocol for the Global Desktop Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value, not the value specified directly on the desktop pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
Description of Global Desktop Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. If no machine is assigned to the user then "display_name (No machine assigned)" will be displayed in the client. Supported Filters: 'Equals'. This property can be used for sorting.
Decides the visibility of the machine alias to the user. This property can be used for sorting.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates if this Global Desktop Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.
Count of groups that are associated with this Global Desktop Entitlement.
Unique ID representing this Global Desktop Entitlement. Supported Filters: 'Equals'.
Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement.
Pods that have desktop pools associated with this Global Desktop Entitlement.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.
Unique name used to identify the Global Desktop Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.
Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement.
Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol in supportedDisplayProtocols. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Supported Filters: 'Equals'. This property can be used for sorting.
Locations of the category folder in the user's OS containing a shortcut to the desktop. The value must be set if categoryFolderName is provided.
The set of supported display protocols for the Global Desktop Entitlement. All the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.
Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.
Count of users that are associated with this Global Desktop Entitlement.
Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups).
Information about Global Desktop Entitlement.
{
"allow_multiple_sessions_per_user": true,
"allow_users_to_choose_protocol": true,
"allow_users_to_reset_machines": true,
"backup_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"dedicated": true,
"default_display_protocol": "string",
"description": "global desktop entitlement description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "global-desktop-entitlement",
"enable_client_restrictions": "boolean",
"enabled": true,
"federated_access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"group_count": 5,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"local_desktop_pools_count": 2,
"member_pods": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"9238c-102b-4ed3-953f-3d23esan0fe"
],
"multiple_session_auto_clean": "boolean",
"name": "global-desktop-entitlement",
"primary_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"remote_desktop_pools_count": 10,
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_collaboration_enabled": "boolean",
"shortcut_locations_v2": [
"DESKTOP"
],
"supported_display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"use_home_site": "boolean",
"user_count": 5,
"user_or_group_site_override_count": 2
}
Indicates whether users can have multiple sessions when accessed from different client devices, this is also called Class room mode and applicable only to floating user assignment. If value is set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to have multiple sessions with allowMultipleSessionsPerUser Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the users can choose the protocol used. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether users are allowed to reset/restart their machines. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to reset/restart machines with allowUsersToResetMachines. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement. Supported Filters: 'Equals'.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.
Indicates whether this global desktop entitlement is managed from cloud. Supported Filters: 'Equals'. This property can be used for sorting.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement. Otherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Supported Filters: 'Equals'. This property can be used for sorting.
The default display protocol for the Global Desktop Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value, not the value specified directly on the desktop pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
Description of Global Desktop Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. If no machine is assigned to the user then "display_name (No machine assigned)" will be displayed in the client. Supported Filters: 'Equals'. This property can be used for sorting.
Decides the visibility of the machine alias to the user. This property can be used for sorting.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates if this Global Desktop Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.
This represents id of the federated access group associated with the global desktop entitlement.
Count of groups that are associated with this Global Desktop Entitlement.
Unique ID representing this Global Desktop Entitlement. Supported Filters: 'Equals'.
Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement.
Pods that have desktop pools associated with this Global Desktop Entitlement.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.
Unique name used to identify the Global Desktop Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.
Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement.
Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol in supportedDisplayProtocols. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Supported Filters: 'Equals'. This property can be used for sorting.
Locations of the category folder in the user's OS containing a shortcut to the desktop.
The set of supported display protocols for the Global Desktop Entitlement. All the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.
Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.
Count of users that are associated with this Global Desktop Entitlement.
Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups).
Information about Global Desktop Entitlement.
{
"allow_multiple_sessions_per_user": true,
"allow_users_to_choose_protocol": true,
"allow_users_to_reset_machines": true,
"backup_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"dedicated": true,
"default_display_protocol": "string",
"description": "global desktop entitlement description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "global-desktop-entitlement",
"enable_client_restrictions": "boolean",
"enabled": true,
"federated_access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"group_count": 5,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"local_desktop_pools_count": 2,
"member_pods": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"9238c-102b-4ed3-953f-3d23esan0fe"
],
"multiple_session_auto_clean": "boolean",
"name": "global-desktop-entitlement",
"primary_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"remote_desktop_pools_count": 10,
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_collaboration_enabled": "boolean",
"session_distribution_policy": "NONE",
"shortcut_locations_v2": [
"DESKTOP"
],
"supported_display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"use_home_site": "boolean",
"user_count": 5,
"user_or_group_site_override_count": 2
}
Indicates whether users can have multiple sessions when accessed from different client devices, this is also called Class room mode and applicable only to floating user assignment. If value is set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to have multiple sessions with allowMultipleSessionsPerUser Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the users can choose the protocol used. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether users are allowed to reset/restart their machines. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to reset/restart machines with allowUsersToResetMachines. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement. Supported Filters: 'Equals'.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.
Indicates whether this global desktop entitlement is managed from cloud. Supported Filters: 'Equals'. This property can be used for sorting.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement. Otherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Supported Filters: 'Equals'. This property can be used for sorting.
The default display protocol for the Global Desktop Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value, not the value specified directly on the desktop pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
Description of Global Desktop Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. If no machine is assigned to the user then "display_name (No machine assigned)" will be displayed in the client. Supported Filters: 'Equals'. This property can be used for sorting.
Decides the visibility of the machine alias to the user. This property can be used for sorting.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates if this Global Desktop Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.
This represents id of the federated access group associated with the global desktop entitlement.
Count of groups that are associated with this Global Desktop Entitlement.
Unique ID representing this Global Desktop Entitlement. Supported Filters: 'Equals'.
Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement.
Pods that have desktop pools associated with this Global Desktop Entitlement.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.
Unique name used to identify the Global Desktop Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.
Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement.
Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol in supportedDisplayProtocols. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Supported Filters: 'Equals'. This property can be used for sorting.
Session distribution policy to be used for this global desktop entitlement
- LOAD: Load index based load distribution.
- NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.
- SESSION: Session count based load distribution.
Locations of the category folder in the user's OS containing a shortcut to the desktop.
The set of supported display protocols for the Global Desktop Entitlement. All the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.
Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.
Count of users that are associated with this Global Desktop Entitlement.
Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups).
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.
{
"allow_multiple_sessions_per_user": true,
"allow_users_to_choose_protocol": true,
"allow_users_to_reset_machines": true,
"backup_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"dedicated": true,
"default_display_protocol": "string",
"description": "global desktop entitlement description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "global-desktop-entitlement",
"enable_client_restrictions": "boolean",
"enabled": true,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"multiple_session_auto_clean": "boolean",
"name": "global-desktop-entitlement",
"primary_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_collaboration_enabled": "boolean",
"shortcut_locations": [
"desktop"
],
"supported_display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"use_home_site": "boolean"
}
Indicates whether users can have multiple sessions when accessed from different client devices, this is also called Class room mode and applicable only to floating user assignment. If value is set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to have multiple sessions with allowMultipleSessionsPerUser Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the users can choose the protocol used. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether users are allowed to reset/restart their machines. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to reset/restart machines with allowUsersToResetMachines. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement. Supported Filters: 'Equals'.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.
Indicates whether this global desktop entitlement is managed from cloud. Supported Filters: 'Equals'. This property can be used for sorting.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement. Otherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Supported Filters: 'Equals'. This property can be used for sorting.
The default display protocol for the Global Desktop Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value, not the value specified directly on the desktop pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
Description of Global Desktop Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. If no machine is assigned to the user then "display_name (No machine assigned)" will be displayed in the client. Supported Filters: 'Equals'. This property can be used for sorting.
Decides the visibility of the machine alias to the user. This property can be used for sorting.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates if this Global Desktop Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.
Unique ID representing this Global Desktop Entitlement. Supported Filters: 'Equals'.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.
Unique name used to identify the Global Desktop Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.
Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol in supportedDisplayProtocols. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Supported Filters: 'Equals'. This property can be used for sorting.
Locations of the category folder in the user's OS containing a shortcut to the desktop. The value must be set if categoryFolderName is provided.
The set of supported display protocols for the Global Desktop Entitlement. All the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.
Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.
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.
{
"allow_multiple_sessions_per_user": true,
"allow_users_to_choose_protocol": true,
"allow_users_to_reset_machines": true,
"backup_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"dedicated": true,
"default_display_protocol": "string",
"description": "global desktop entitlement description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "global-desktop-entitlement",
"enable_client_restrictions": "boolean",
"enabled": true,
"federated_access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"multiple_session_auto_clean": "boolean",
"name": "global-desktop-entitlement",
"primary_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_collaboration_enabled": "boolean",
"shortcut_locations_v2": [
"DESKTOP"
],
"supported_display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"use_home_site": "boolean"
}
Indicates whether users can have multiple sessions when accessed from different client devices, this is also called Class room mode and applicable only to floating user assignment. If value is set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to have multiple sessions with allowMultipleSessionsPerUser Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the users can choose the protocol used. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether users are allowed to reset/restart their machines. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to reset/restart machines with allowUsersToResetMachines. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement. Supported Filters: 'Equals'.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.
Indicates whether this global desktop entitlement is managed from cloud. Supported Filters: 'Equals'. This property can be used for sorting.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement. Otherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Supported Filters: 'Equals'. This property can be used for sorting.
The default display protocol for the Global Desktop Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value, not the value specified directly on the desktop pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
Description of Global Desktop Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. If no machine is assigned to the user then "display_name (No machine assigned)" will be displayed in the client. Supported Filters: 'Equals'. This property can be used for sorting.
Decides the visibility of the machine alias to the user. This property can be used for sorting.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates if this Global Desktop Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.
This represents id of the federated access group associated with the global desktop entitlement.
Supported Filters: 'Equals'.
Unique ID representing this Global Desktop Entitlement. Supported Filters: 'Equals'.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.
Unique name used to identify the Global Desktop Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.
Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol in supportedDisplayProtocols. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Supported Filters: 'Equals'. This property can be used for sorting.
Locations of the category folder in the user's OS containing a shortcut to the desktop.
The set of supported display protocols for the Global Desktop Entitlement. All the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.
Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.
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.
{
"allow_multiple_sessions_per_user": true,
"allow_users_to_choose_protocol": true,
"allow_users_to_reset_machines": true,
"backup_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"dedicated": true,
"default_display_protocol": "string",
"description": "global desktop entitlement description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": true,
"display_name": "global-desktop-entitlement",
"enable_client_restrictions": "boolean",
"enabled": true,
"federated_access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"multiple_session_auto_clean": "boolean",
"name": "global-desktop-entitlement",
"primary_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_collaboration_enabled": "boolean",
"session_distribution_policy": "NONE",
"shortcut_locations_v2": [
"DESKTOP"
],
"supported_display_protocols": [
"PCOIP",
"BLAST",
"RDP"
],
"use_home_site": "boolean"
}
Indicates whether users can have multiple sessions when accessed from different client devices, this is also called Class room mode and applicable only to floating user assignment. If value is set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to have multiple sessions with allowMultipleSessionsPerUser Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the users can choose the protocol used. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether users are allowed to reset/restart their machines. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to reset/restart machines with allowUsersToResetMachines. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement. Supported Filters: 'Equals'.
Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.
Indicates whether this global desktop entitlement is managed from cloud. Supported Filters: 'Equals'. This property can be used for sorting.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement. Otherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Supported Filters: 'Equals'. This property can be used for sorting.
The default display protocol for the Global Desktop Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value, not the value specified directly on the desktop pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
Description of Global Desktop Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether users should see the hostname of the machine assigned to them instead of displayName when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. If no machine is assigned to the user then "display_name (No machine assigned)" will be displayed in the client. Supported Filters: 'Equals'. This property can be used for sorting.
Decides the visibility of the machine alias to the user. This property can be used for sorting.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates if this Global Desktop Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.
This represents id of the federated access group associated with the global desktop entitlement.
Supported Filters: 'Equals'.
Unique ID representing this Global Desktop Entitlement. Supported Filters: 'Equals'.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.
Unique name used to identify the Global Desktop Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.
Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol in supportedDisplayProtocols. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Supported Filters: 'Equals'. This property can be used for sorting.
Session distribution policy to be used for this global desktop entitlement. Supported Filters: 'Equals'. This property can be used for sorting.
- LOAD: Load index based load distribution.
- NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.
- SESSION: Session count based load distribution.
Locations of the category folder in the user's OS containing a shortcut to the desktop.
The set of supported display protocols for the Global Desktop Entitlement. All the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.
Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.
Global Desktop Entitlement object to be updated.
{
"allow_multiple_sessions_per_user": true,
"backup_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"default_display_protocol": "PCOIP",
"description": "global desktop entitlement description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": "boolean",
"display_name": "global-desktop-entitlement",
"enable_client_restrictions": "boolean",
"enabled": true,
"federated_access_group_id": "310927ee-1195-44c3-b877-5b194b4b4ea8",
"multiple_session_auto_clean": "boolean",
"name": "global-desktop-entitlement",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_collaboration_enabled": "boolean",
"shortcut_locations_v2": [
"DESKTOP"
],
"use_home_site": "boolean"
}
Indicates whether users can have multiple sessions when accessed from different client devices, this is also called Class room mode and applicable only to floating user assignment. If value is set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to have multiple sessions.
Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.
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.
Indicates whether this global desktop entitlement is managed from cloud.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
The default display protocol for the Global Desktop Entitlement. Clients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value, not the value specified directly on the desktop pool to which they connect (if different).
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
Description of Global Desktop Entitlement.
Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. If no machine is assigned to the user then "display_name (No machine assigned)" will be displayed in the client.
Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.
Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.
Indicates if this Global Desktop Entitlement is enabled.
ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.
Unique name used to identify the Global Desktop Entitlement.
Indicates whether it should fail if a home site isn't defined for this Global Desktop Entitlement.
Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.
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.
Indicates whether a pod in the user's home site is used to start the search or the current site is used.
Global Desktop Entitlement object to be updated.
{
"allow_multiple_sessions_per_user": true,
"backup_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_managed": "boolean",
"cs_restriction_tags": [
"Internal",
"External"
],
"default_display_protocol": "PCOIP",
"description": "global desktop entitlement description",
"display_assigned_machine_name": "boolean",
"display_machine_alias": "boolean",
"display_name": "global-desktop-entitlement",
"enable_client_restrictions": "boolean",
"enabled": true,
"federated_access_group_id": "310927ee-1195-44c3-b877-5b194b4b4ea8",
"multiple_session_auto_clean": "boolean",
"name": "global-desktop-entitlement",
"require_home_site": "boolean",
"scope": "ALL_SITES",
"session_collaboration_enabled": "boolean",
"session_distribution_policy": "NONE",
"shortcut_locations_v2": [
"DESKTOP"
],
"use_home_site": "boolean"
}
Indicates whether users can have multiple sessions when accessed from different client devices, this is also called Class room mode and applicable only to floating user assignment. If value is set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to have multiple sessions.
Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.
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.
Indicates whether this global desktop entitlement is managed from cloud.
Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.
The default display protocol for the Global Desktop Entitlement. Clients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value, not the value specified directly on the desktop pool to which they connect (if different).
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
Description of Global Desktop Entitlement.
Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. If no machine is assigned to the user then "display_name (No machine assigned)" will be displayed in the client.
Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only.
Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.
Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.
Indicates if this Global Desktop Entitlement is enabled.
ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.
Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.
Unique name used to identify the Global Desktop Entitlement.
Indicates whether it should fail if a home site isn't defined for this Global Desktop Entitlement.
Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.
- ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
- WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
- WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.
Session distribution policy to be used for this global desktop entitlement
- LOAD: Load index based load distribution.
- NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.
- SESSION: Session count based load distribution.
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.
Indicates whether a pod in the user's home site is used to start the search or the current site is used.
Metrics related to global desktop entitlements
{
"id": "6f93b3a5-e7d0-4ad6-a1e3-48268dd1ed80",
"local_capacity": 10,
"local_connected_sessions": 30,
"local_occupancy_count": 80
}
Unique ID of the global desktop entitlement.
Number of machines in each local desktop pools belongs to the Global Desktop Entitlement.
Number of connected sessions in local desktop pools belongs to the Global Desktop Entitlement.
Occupancy count for the desktop pools belongs to the Global Desktop Entitlement.
- For dedicated assignment desktop pool, it is the number of assigned machine count.
- For floating assignment desktop pool, it is the summation of the connected and disconnected sessions.
Information required to perform an action on global sessions.
{
"ids": [
"816d44cb-b486-3c97-adcb-cf3806d53657",
"414927f3-1a3b-3e4c-81b3-d39602f634dc"
],
"pod_id": "54c122e0-d6b5-476c-af91-fd00392e5983"
}
IDs of the sessions on which action is to be performed.
ID of the hosting pod for the sessions.
Client data for the session.
{
"address": "127.0.0.1",
"location_id": "ac9be3c194f62043b274058102d3ce39048ec9c26d0e2c8b8ea475909d497f79",
"name": "Client1",
"type": "WINDOWS",
"version": "5.4.0"
}
IP Address of the client machine for the session. Supported Filters: 'Equals'. This property can be used for sorting.
Client location for the session. Supported Filters: 'Equals'.
Client machine name for the session. Supported Filters: 'Equals'. This property can be used for sorting.
Client type for the session. Supported Filters: 'Equals'. This property can be used for sorting.
- WINDOWS: Client type is Windows client.
- MAC: Client type is Mac client.
- HTMLACCESS: Client type is Web client.
- LINUX: Client type is Linux client.
- IOS: Client type is iOS client.
- ANDROID: Client type is Android client.
- OTHER: Client type is other.
Client version for the session. Supported Filters: 'Equals'. This property can be used for sorting.
Information related to Global Session.
{
"agent_version": "8.3.0",
"application_names": [
"Calculator",
"Paint"
],
"broker_user_id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"brokered_remotely": true,
"brokering_pod_id": "399eecf2-66ab-4a8f-94d9-b290fda35e4f",
"client_data": {
"address": "127.0.0.1",
"location_id": "ac9be3c194f62043b274058102d3ce39048ec9c26d0e2c8b8ea475909d497f79",
"name": "Client1",
"type": "WINDOWS",
"version": "5.4.0"
},
"desktop_pool_id": "53c4de7c-ae7c-471d-a8d0-3489cb9741d7",
"desktop_pool_or_farm_name": "Farm-Name",
"desktop_pool_or_farm_source": "VIRTUAL_CENTER",
"desktop_pool_or_farm_type": "AUTOMATED",
"disconnected_time": 1621512686000,
"farm_id": "250f68e8-9e7e-4578-b8fa-25864c63f168",
"federated_access_group_ids": [
"310927ee-1195-44c3-b877-5b194b4b4ea8",
"78669598-45b6-44a3-aa0d-11b16d45ab73"
],
"forever_session": "boolean",
"global_application_entitlement_ids": [
"0d23a254-b873-4534-ad9a-ce8d25c5b40e",
"89036a3a-5f6f-4dcd-bc78-e2febdc9dc8a"
],
"global_desktop_entitlement_id": "adcfdefc-c853-4413-8ac7-b299535a509d",
"id": "ac6fc134-d197-3bbc-a6bf-24dc63123ae6",
"idle_duration": 30,
"last_session_duration_ms": 120290,
"local_access_group_id": "95061b82-92fa-4285-b90d-a5e1d8e38c3d",
"machine_id": "3205f64e-1d3d-43c0-942b-0bb6707c481d",
"machine_or_rds_server_dns_name": "machine1.example.com",
"pod_id": "b7ade226-ca2a-4805-b7be-c4bc8cec5188",
"rds_server_id": "a6cddaeb-4477-468d-90ea-593c716790b8",
"resourced_remotely": "boolean",
"security_gateway_data": {
"address": "127.0.0.1",
"domain_name": "SECURE-GW.example.com",
"location": "EXTERNAL"
},
"session_protocol": "BLAST",
"session_state": "CONNECTED",
"session_type": "DESKTOP",
"site_id": "037e6be2-9aa3-4676-93d3-25a519efedf4",
"start_time": 1621512606000,
"unauthenticated": "boolean",
"user_id": "S-1-5-21-1111111111-2222222222-3333333333-500"
}
Version of the agent for the session. Supported Filters: 'Equals'. This property can be used for sorting.
Names of the applications launched in the session.
It will only be set when session_type is APPLICATION. Supported Filters: 'Contains'.
SID for the broker user associated with the session. It will be unset for non-broker sessions. Supported Filters: 'Equals'.
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. Supported Filters: 'Equals'. This property can be used for sorting.
ID of the pod that brokered the session.
ID of the desktop pool for the desktop session. This will be unset if the session is not brokered through a desktop pool, such as for direct console access. This will be unset if the session is hosted by remote pod. Supported Filters: 'Equals'.
Display name of the desktop pool or name of the farm for the session. This will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. Supported Filters: 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Source of the desktop pool or farm for the session. This will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. This property can be used for sorting.
- INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines. Applicable for AUTOMATED type desktop pools.
- RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
- 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.
- VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines. Applicable for AUTOMATED and MANUAL type desktop pools.
Type of the desktop pool or farm for the session. This will be unset if session is not brokered through a desktop pool or a farm, such as for direct console access. This property can be used for sorting.
- AUTOMATED: Automated Desktop Pool.
- MANUAL: Manual Desktop Pool.
- RDS: RDS Desktop Pool.
Epoch time in milliseconds, when the session was last disconnected. This will be unset if the machine on which the session resides has an error state, or if the session has never been disconnected. Supported Filters: 'Equals'. This property can be used for sorting.
ID of the farm for the RDS desktop or application session. This will be unset if the session is not brokered through a farm, such as for direct console access. This will be unset if the session is hosted by remote pod. Supported Filters: 'Equals'.
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. Supported Filters : 'Contains'.
Indicates whether the application session will continue to run indefinitely on reaching global idle timeout or max session timeout. This property can be used for sorting.
IDs of the global application entitlements used to launch applications in the session. Either this or global_desktop_entitlement_id may be set, but not both. Supported Filters : 'Contains'.
ID of the global desktop entitlement used to launch the session. Either this or global_application_entitlement_ids may be set, but not both. Supported Filters : 'Equals'.
Unique ID representing a session. Supported Filters: 'Equals'.
Idle time duration in minutes, indicating how long the end user of the session has been idle for. Supported Filters: 'Equals'. This property can be used for sorting.
Duration of the last connection period of the session in milliseconds. 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'. This property can be used for sorting.
ID of the local access group associated with the session. For a non-RDS desktop session, this is the access group ID of the desktop pool. For an RDS desktop session, this is access group ID of the farm of the RDS desktop pool. For an application session, this is the access group ID of the farm of the application pool. This will be unset if the session is hosted by remote pod. Supported Filters: 'Equals'.
ID of the machine for the session. This will be unset for RDS desktop or application sessions. If desktop_pool_id is unset, it is the id of registered unmanaged physical machine. This will be unset if the session is hosted by remote pod. Supported Filters: 'Equals'.
DNS name of the machine or RDS server for the session. This property can be used for sorting.
ID of the pod that provided the resource for the session.
ID of the RDS server for the RDS desktop or application session.
This will be unset if the session is hosted by remote pod. Supported Filters: 'Equals'.
Indicates whether the session is running on a remote pod resource. Supported Filters: 'Equals'. This property can be used for sorting.
Protocol for session. This will be unset for disconnected sessions. Supported Filters: 'Equals'. This property can be used for sorting.
- PCOIP: Display protocol is PCoIP.
- RDP: Display protocol is RDP.
- BLAST: Display protocol is BLAST.
- CONSOLE: Display protocol is console.
- UNKNOWN: Display protocol is unknown.
State of session. Supported Filters: 'Equals', 'NotEquals'. This property can be used for sorting.
- CONNECTED: Session is connected
- DISCONNECTED: Session is disconnected
- PENDING: Session is pending
Type of session. Supported Filters: 'Equals'. This property can be used for sorting.
- DESKTOP: Desktop or RDS desktop session.
- APPLICATION: Application session.
ID of the site where the pod that resourced the session belongs.
Epoch time in milliseconds when this session was originally logged in. The lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences between. The first connection time will be shortly after this time. Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the session belongs to unauthenticated access user. Supported Filters: 'Equals'. This property can be used for sorting.
SID of the user logged into the session. It may not match the broker user id for non-SSO scenarios.
Security gateway data for the session.
{
"address": "127.0.0.1",
"domain_name": "SECURE-GW.example.com",
"location": "EXTERNAL"
}
IP Address of the security gateway for the session. Supported Filters: 'Equals'. This property can be used for sorting.
Computer machine name or DNS name of the security gateway for the session. Supported Filters : 'Equals'. This property can be used for sorting.
IP Address of the security gateway for the session. Supported Filters: 'Equals'. This property can be used for sorting.
- EXTERNAL: Gateway location is external.
- INTERNAL: Gateway location is internal.
- UNKNOWN: Gateway location is unknown.
Global sessions to which message is to be sent.
{
"global_session_action_specs": [
{
"ids": [
"816d44cb-b486-3c97-adcb-cf3806d53657",
"414927f3-1a3b-3e4c-81b3-d39602f634dc"
],
"pod_id": "54c122e0-d6b5-476c-af91-fd00392e5983"
}
],
"message": "Sample Info Message",
"message_type": "INFO"
}
Sessions to which message is to be sent.
Message to be sent to sessions.
Type of message to be sent to sessions.
- ERROR: Message is of error type.
- WARNING: Message is of warning type.
- INFO: Message is of information type.
Monitoring health information of components.
{
"component": "ALL",
"error_count": 3,
"healthy_count": 5,
"total_count": 13,
"unknown_count": 2,
"warning_count": 3
}
Additional details.
Indicates components
- CONNECTION_SERVER: Connection Server.
- EVENT_DATABASE: Event Database.
- TRUE_SSO: TRUE SSO Connector.
- VIRTUAL_CENTER: Virtual Center.
- ESX_HOST: ESX Host managed by one of the Virtual Center Configured.
- DATASTORE: Datastore of the ESX Host.
- GATEWAY: Gateway configured.
- RDS_SERVER: RDS Server.
- FARM: Farm.
- AD_DOMAIN: AD Domain controller.
- SAML_AUTHENTICATOR: SAML 2.0 Authenticator.
- REMOTE_CONNECTION_SERVER: Connection Server from the Remote Pod.
- LICENSE: License added to the connection server.
- MESSAGE_CLIENT: Message client.
- ALL: Represents all the components.
Number of items in the system those are in error state.
Number of healthy items of the component.
Total number of items of the component.
Number of items in the system those are in unknown state.
Number of items in the system those are in warning state.
Information related to Held User or Group.
{
"ad_user_or_group_id": "S-1-5-21-1111111111-2222222222-3333333333-513"
}
Unique SID representing held user or group.
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.
{
"ad_user_or_group_id": "S-1-5-21-1111111111-2222222222-3333333333-513",
"errors": [
{
"error_key": "inventory.machine.not.found",
"error_message": "username cannot be empty"
}
],
"machines_data": [
{
"machine_id": "vm-416",
"machine_state": "Connected",
"name": "Win10"
}
],
"status_code": 200,
"timestamp": 1561939200000
}
Unique SID representing held user or group.
List of objects containing information related to held Virtual Machines.
Response HTTP status code of the operation.
Timestamp in milliseconds when the operation failed. Measured as epoch time.
Information related to a held Virtual Machine.
{
"machine_id": "vm-416",
"machine_state": "Connected",
"name": "Win10"
}
Unique virtual center moid representing the virtual machine.
Machine state
- AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.
- AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.
- AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.
- AGENT_ERROR_DISABLED: Horizon Agent is disabled.
- AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.
- AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.
- AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.
- AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.
- AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.
- AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.
- ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.
- AVAILABLE: The machine is powered on and ready for active connections.
- BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.
- CONNECTED: The machine is in an active session and has an active connection to a Horizon client.
- CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.
- DELETING: The machine is marked for deletion.
- DISABLED: The machine is disabled.
- DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.
- DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.
- ERROR: An unknown error occurred in the machine.
- IN_PROGRESS: There is a machine operation in progress.
- MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.
- PROVISIONED: The machine is powered off or suspended.
- PROVISIONING: The machine is being provisioned.
- PROVISIONING_ERROR: An error occurred during provisioning.
- UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.
- UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.
- UNKNOWN: Could not determine the state of the machine.
- VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.
- 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.
VM name.
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.
{
"ad_user_or_group_id": "S-1-5-32-551",
"global_application_entitlement_id": "e285ebe1-194b-4563-80e0-0ad21134c503",
"global_desktop_entitlement_id": "7493bfc7-834a-4d9b-ac7d-b5f60893a3a6",
"site_id": "32a5ea06-cd09-4609-b3e5-df8379e99c13"
}
SID of the user or group for whom the home site is to be configured.
ID of the Global Application Entitlement for which this site is the overriding home site.
ID of the Global Desktop Entitlement for which this site is the overriding home site.
ID of the site for this home site configuration.
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.
{
"ad_user_or_group_id": "S-1-5-32-551",
"global_application_entitlement_id": "e285ebe1-194b-4563-80e0-0ad21134c503",
"global_desktop_entitlement_id": "7493bfc7-834a-4d9b-ac7d-b5f60893a3a6",
"id": "28deeb70-97d5-409e-abb4-497196f1ee18",
"site_id": "32a5ea06-cd09-4609-b3e5-df8379e99c13"
}
SID of the user or group for whom this is the home site.
Supported Filters: 'Equals'.
ID of the Global Application Entitlement for which this site is the overriding home site.
Supported Filters: 'Equals'.
ID of the Global Desktop Entitlement for which this site is the overriding home site.
Supported Filters: 'Equals'.
Unique ID representing this home site assignment.
Supported Filters: 'Equals'.
ID representing this home site.
Supported Filters: 'Equals'.
Information representing data for a home site resolution.
{
"group_id": "S-1-5-32-568",
"id": "28deeb70-97d5-409e-abb4-497196f1ee18",
"resolved": true,
"site_id": "52457bcd-9641-48b1-a1ac-a8c58069ef48",
"type": "USER_DEFAULT"
}
SID of the group through which the user gets this home site.
ID of the Home Site Configuration.
Indicates whether this is the resolved home site.
ID of the Site configured as Home Site.
Indicates whether the home site is directly assigned to the user or group and whether it is associated with a global entitlement.
- USER_OVERRIDE: Indicates that a home site override is associated with a global entitlement for the user.
- GROUP_OVERRIDE: Indicates that a home site override is associated with a global entitlement for a group that the user belongs to.
- USER_DEFAULT: Indicates that a home site is directly assigned to the user.
- GROUP_DEFAULT: Indicates that a home site is directly assigned to a group that the user belongs to.
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.
{
"global_application_entitlement_id": "f309c150-ff8b-4391-ad5d-96e1a3c3cb70",
"global_desktop_entitlement_id": "dc2c29ce-baae-47b5-90e6-d7ab1d3b82288",
"resolution_data": [
{
"group_id": "S-1-5-32-568",
"id": "28deeb70-97d5-409e-abb4-497196f1ee18",
"resolved": true,
"site_id": "52457bcd-9641-48b1-a1ac-a8c58069ef48",
"type": "USER_DEFAULT"
}
]
}
ID of the Global Application Entitlement this home site resolution is for.
ID of the Global Desktop Entitlement this home site resolution is for.
Home Site Resolution Data for this Global Entitlement.
Home site specification to be resolved.
{
"global_application_entitlement_id": "751c7619-bc3b-48cd-80d1-29960375b6d8",
"global_desktop_entitlement_id": "9e94a90d-e7c2-40b6-a702-bd781512408d",
"user_id": "S-1-5-21-3623811015-3361044348"
}
ID of the Global Application Entitlement this home site resolution is for.
ID of the Global Desktop Entitlement this home site resolution is for.
SID of the user for whom home site is to be resolved.
Details of the host or cluster container node.
{
"children": [
"HostOrClusterInfo Object"
],
"name": "ServicesFolder",
"path": "/Datacenter/host/ServicesFolder",
"type": "FOLDER"
}
Contents of the container. These may be hosts or clusters or further nested containers.
Host or cluster container node display name.
Host or cluster container node path.
Type of container.
- FOLDER: A folder container.
- OTHER: Other container type.
Details of the host or cluster.
{
"cluster": true,
"datacenter_id": "datacenter-1",
"incompatible_reasons": [
"string"
],
"name": "Cluster",
"path": "/Datacenter/host/ServicesFolder/Cluster",
"vcenter_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"vgpu_types": [
"string"
]
}
Whether or not this is a cluster or a host.
Datacenter id for this host or cluster.
Reasons that may preclude this Host Or Cluster from being used in desktop pool creation.
Host or cluster display name.
Host or cluster path.
Virtual Center id for this host or cluster.
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.
Information related to host or cluster.
{
"container": "HostOrClusterContainer Object",
"details": {
"cluster": true,
"datacenter_id": "datacenter-1",
"incompatible_reasons": [
"string"
],
"name": "Cluster",
"path": "/Datacenter/host/ServicesFolder/Cluster",
"vcenter_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"vgpu_types": [
"string"
]
},
"id": "domain-s425"
}
Unique ID representing a host or cluster.
Details of the Hypervisor hosts involved in Content Based Read Caching (CBRC)
{
"cache_size_mb": 2048,
"path": "/path/host"
}
Size of the cache in megabytes. This property has a minimum value of 100. This property has a maximum value of 2048.
The path of the host that supports View Storage Accelerator.
Details of the Hypervisor hosts involved in Content Based Read Caching (CBRC)
{
"cache_size_mb": 2048,
"path": "/path/host"
}
Size of the cache in megabytes. This property has a minimum value of 100. This property has a maximum value of 32768.
The path of the host that supports View Storage Accelerator.
Details of the Hypervisor hosts involved in Content Based Read Caching (CBRC)
{
"cache_size_mb": 2048,
"path": "/path/host"
}
Size of the cache in megabytes. This property has a minimum value of 100. This property has a maximum value of 32768.
The path of the host that supports View Storage Accelerator.
Image management asset object to be created.
{
"base_snapshot_id": "snapshot-1",
"base_vm_id": "vm-2",
"clone_type": "INSTANT_CLONE",
"im_stream_id": "abc16e8f-9ba0-4789-a5dd-6880f32c52df",
"im_version_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"image_type": "RDSH_APPS",
"status": "AVAILABLE",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
"vm_template_id": "vm-1"
}
Additional details about image management asset.
Virtual machine snapshot. Must be set if vm_template_id is unset.
Virtual machine ID. Must be set if vm_template_id is unset.
Image management asset clone type.
- FULL_CLONE: Image management asset to be used in full clone automated desktop pool.
- INSTANT_CLONE: Image management asset to be used in instant clone desktop pool/farm.
Image management stream to which this asset belongs to.
Image management version to which this asset belongs to.
Image management asset image type.
- RDSH_APPS: Image management asset to be used for farm creation which is be used in application.
- RDSH_DESKTOP: Image management asset is for farm creation to be created.
- VDI_DESKTOP: Image management asset is available for desktops/farms to be created.
Image management asset status.
- AVAILABLE: Image management asset is available for desktop pools/farms to be created.
- DELETED: Image management asset has been deleted.
- DEPLOYING_VM: Image management asset is deploying VM on the virtual center.
- DEPLOYMENT_DONE: Image management asset VM deployed on the virtual center.
- DISABLED: Image management asset has been disabled and no further pool/farm operation can be done using the same.
- FAILED: Image management asset creation has failed.
- REPLICATING: Copying the specialized images across all virtual centers.
- RETRY_PENDING: When image management asset creation has failed, retry action is pending for asset to be created.
- SPECIALIZING_VM: Image management asset is being published and specialized internally like installing agents etc.
Virtual Center where this asset is created.
Virtual machine template ID.
Information related to image management asset. Supported Filters : 'And', 'Or', 'Equals'.
{
"base_snapshot_id": "snapshot-1",
"base_vm_id": "vm-2",
"clone_type": "INSTANT_CLONE",
"datacenter_id": "datacenter-1",
"id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"im_stream_id": "abc16e8f-9ba0-4789-a5dd-6880f32c52df",
"im_version_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"image_type": "RDSH_APPs",
"status": "AVAILABLE",
"vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
"vm_template_id": "vm-1"
}
Additional details about image management asset.
Virtual machine snapshot. Must be set if vm_template_id is unset. Supported Filters : 'Equals'.
Virtual machine ID. Must be set if vm_template_id is unset. Supported Filters : 'Equals'.
Image management asset clone type. Supported Filters : 'Equals'. This property can be used for sorting.
- FULL_CLONE: Image management asset to be used in full clone automated desktop pool.
- INSTANT_CLONE: Image management asset to be used in instant clone desktop pool/farm.
Datacenter where this asset is created. Supported Filters : 'Equals'.
Unique ID representing image management asset. Supported Filters : 'Equals'.
Image management stream to which this asset belongs to. Supported Filters : 'Equals'.
Image management version to which this asset belongs to. Supported Filters : 'Equals'.
Image management asset image type. Supported Filters : 'Equals'. This property can be used for sorting.
- RDSH_APPS: Image management asset to be used for farm creation which is be used in application.
- RDSH_DESKTOP: Image management asset is for farm creation to be created.
- VDI_DESKTOP: Image management asset is available for desktops/farms to be created.
Image management asset status. Supported Filters : 'Equals'. This property can be used for sorting.
- AVAILABLE: Image management asset is available for desktop pools/farms to be created.
- DELETED: Image management asset has been deleted.
- DEPLOYING_VM: Image management asset is deploying VM on the virtual center.
- DEPLOYMENT_DONE: Image management asset VM deployed on the virtual center.
- DISABLED: Image management asset has been disabled and no further pool/farm operation can be done using the same.
- FAILED: Image management asset creation has failed.
- REPLICATING: Copying the specialized images across all virtual centers.
- RETRY_PENDING: When image management asset creation has failed, retry action is pending for asset to be created.
- SPECIALIZING_VM: Image management asset is being published and specialized internally like installing agents etc.
Virtual Center where this asset is created. Supported Filters : 'Equals'.
Virtual machine template ID. Supported Filters : 'Equals'.
Image management asset object to be updated.
{
"clone_type": "INSTANT_CLONE",
"image_type": "RDSH_APPS",
"status": "AVAILABLE"
}
Additional details about image management asset.
Image management asset clone type.
- FULL_CLONE: Image management asset to be used in full clone automated desktop pool.
- INSTANT_CLONE: Image management asset to be used in instant clone desktop pool/farm.
Image management asset image type.
- RDSH_APPS: Image management asset to be used for farm creation which is be used in application.
- RDSH_DESKTOP: Image management asset is for farm creation to be created.
- VDI_DESKTOP: Image management asset is available for desktops/farms to be created.
Image management asset status.
- AVAILABLE: Image management asset is available for desktop pools/farms to be created.
- DELETED: Image management asset has been deleted.
- DEPLOYING_VM: Image management asset is deploying VM on the virtual center.
- DEPLOYMENT_DONE: Image management asset VM deployed on the virtual center.
- DISABLED: Image management asset has been disabled and no further pool/farm operation can be done using the same.
- FAILED: Image management asset creation has failed.
- REPLICATING: Copying the specialized images across all virtual centers.
- RETRY_PENDING: When image management asset creation has failed, retry action is pending for asset to be created.
- SPECIALIZING_VM: Image management asset is being published and specialized internally like installing agents etc.
Image management stream object to be created.
{
"description": "Windows 10 Stream",
"name": "Win10",
"operating_system": "WINDOWS_10",
"publisher": "VMware",
"source": "MARKET_PLACE",
"status": "AVAILABLE"
}
Additional details about image management stream.
Image management stream description.
Image management stream name.
Operating system.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
Image management stream publisher
Image management stream source.
- COPIED_FROM_STREAM: Image management stream is copied from another stream.
- COPIED_FROM_VERSION: Image management stream is copied from a version.
- MARKET_PLACE: Image management stream is from market place.
- UPLOADED: Image management stream is uploaded.
Image management stream status.
- AVAILABLE: Image management stream is available for desktop pools/farms to be created.
- DELETED: Image management stream is deleted.
- DISABLED: Image management stream is disabled and no further desktop pools/farms can be created using the same.
- FAILED: Image management stream creation has failed.
- IN_PROGRESS: Image management stream creation is in progress.
- PARTIALLY_AVAILABLE: Image management version for this stream could not be created in one or more environments.
- PENDING: Image management stream is in pending state.
Information related to image management stream.List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And, Or, Equals, StartsWith and Contains'.
See the field description to know the filter types it supports.
{
"description": "Windows 10 Stream",
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"name": "Win10",
"operating_system": "WINDOWS_10",
"publisher": "VMware",
"source": "MARKET_PLACE",
"status": "AVAILABLE",
"usable": true
}
Additional details about image management stream.
Image management stream description. This property can be used for sorting.
Unique ID representing image management stream. Supported Filters: 'Equals'.
Image management stream name. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Operating system. Supported Filters: 'Equals'. This property can be used for sorting.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
Image management stream publisher. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Image management stream source. Supported Filters: 'Equals'. This property can be used for sorting.
- COPIED_FROM_STREAM: Image management stream is copied from another stream.
- COPIED_FROM_VERSION: Image management stream is copied from a version.
- MARKET_PLACE: Image management stream is from market place.
- UPLOADED: Image management stream is uploaded.
Image management stream status. Supported Filters: 'Equals'. This property can be used for sorting.
- AVAILABLE: Image management stream is available for desktop pools/farms to be created.
- DELETED: Image management stream is deleted.
- DISABLED: Image management stream is disabled and no further desktop pools/farms can be created using the same.
- FAILED: Image management stream creation has failed.
- IN_PROGRESS: Image management stream creation is in progress.
- PARTIALLY_AVAILABLE: Image management version for this stream could not be created in one or more environments.
- PENDING: Image management stream is in pending state.
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.
Image management stream object to be updated.
{
"description": "Windows 10 Stream",
"name": "Win10",
"operating_system": "WINDOWS_10",
"publisher": "VMware",
"source": "MARKET_PLACE",
"status": "AVAILABLE"
}
Additional details about image management stream.
Image management stream description.
Image management stream name.
Operating system.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
Image management stream publisher
Image management stream source.
- COPIED_FROM_STREAM: Image management stream is copied from another stream.
- COPIED_FROM_VERSION: Image management stream is copied from a version.
- MARKET_PLACE: Image management stream is from market place.
- UPLOADED: Image management stream is uploaded.
Image management stream status.
- AVAILABLE: Image management stream is available for desktop pools/farms to be created.
- DELETED: Image management stream is deleted.
- DISABLED: Image management stream is disabled and no further desktop pools/farms can be created using the same.
- FAILED: Image management stream creation has failed.
- IN_PROGRESS: Image management stream creation is in progress.
- PARTIALLY_AVAILABLE: Image management version for this stream could not be created in one or more environments.
- PENDING: Image management stream is in pending state.
Image management tag object to be created.
{
"im_stream_id": "abc16e8f-9ba0-4789-a5dd-6880f32c52df",
"im_version_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"name": "PROD"
}
Additional details about image management tag.
Image management stream ID to which this tag belongs.
Image management version ID to which this tag belongs.
Image management tag name. It is unique among all the tags of a stream.
Information related to image management tag. Supported Filters :'And', 'Or', 'Equals', 'StartsWith', 'Contains'.
{
"description": "string",
"id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"im_stream_id": "abc16e8f-9ba0-4789-a5dd-6880f32c52df",
"im_version_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"name": "STAGE"
}
Additional details about image management tag.
Image management tag description. Supported Filters : 'Equals','Contains','StartsWith'. This property can be used for sorting.
Unique ID representing image management tag. Supported Filters : 'Equals'.
Image management stream ID to which this tag belongs. Supported Filters : 'Equals'.
Image management version ID to which this tag belongs. Supported Filters : 'Equals'.
Image management tag name. Supported Filters : 'Equals','Contains','StartsWith'. This property can be used for sorting.
Image management tag object to be updated.
{
"im_version_id": "7e85b3a5-e7d0-4ad6-a1e3-37168dd1ed62",
"name": "PROD"
}
Additional details about image management tag.
Image management version ID to which this tag belongs.
Image management tag name.
Image management version object to be created.
{
"description": "string",
"im_stream_id": "abc16e8f-9ba0-4789-a5dd-6880f32c52df",
"name": "v1",
"status": "AVAILABLE"
}
Additional details about image management version.
Image management version description.
Image management stream ID
Image management version name.
Image management version status.
- AVAILABLE: Image management version is available for desktop pools/farms to be created.
- DELETED: Image management version has been deleted.
- DEPLOYING_VM: Image management version is deploying VM on the selected pod.
- DEPLOYMENT_DONE: Image management version status when VM deployment is done for the selected pod.
- DISABLED: Image management version has been disabled and no further pool operation can be done using the same.
- FAILED: Image management version creation has failed.
- PARTIALLY_AVAILABLE: Some of the image management asset creation in some of the virtual centers have failed.
- PUBLISHING: Image management version is being published and specialized internally like installing agents etc.
- REPLICATING: Copying the specialized images across all virtual centers.
Information related to image management version. Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'.
{
"description": "string",
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_stream_id": "abc16e8f-9ba0-4789-a5dd-6880f32c52df",
"name": "v1",
"status": "AVAILABLE"
}
Additional details about image management version.
Image management version description. Supported Filters : 'Equals','StartsWith','Contains'. This property can be used for sorting.
Unique ID representing image management version. Supported Filters : 'Equals'.
Image management stream ID Supported Filters : 'Equals'.
Image management version name. Supported Filters : 'Equals','StartsWith','Contains'. This property can be used for sorting.
Image management version status. Supported Filters : 'Equals'. This property can be used for sorting.
- AVAILABLE: Image management version is available for desktop pools/farms to be created.
- DELETED: Image management version has been deleted.
- DEPLOYING_VM: Image management version is deploying VM on the selected pod.
- DEPLOYMENT_DONE: Image management version status when VM deployment is done for the selected pod.
- DISABLED: Image management version has been disabled and no further pool operation can be done using the same.
- FAILED: Image management version creation has failed.
- PARTIALLY_AVAILABLE: Some of the image management asset creation in some of the virtual centers have failed.
- PUBLISHING: Image management version is being published and specialized internally like installing agents etc.
- REPLICATING: Copying the specialized images across all virtual centers.
Image management version object to be updated.
{
"description": "string",
"name": "v1",
"status": "AVAILABLE"
}
Additional details about image management version.
Image management version description.
Image management version name.
Image management version status.
- AVAILABLE: Image management version is available for desktop pools/farms to be created.
- DELETED: Image management version has been deleted.
- DEPLOYING_VM: Image management version is deploying VM on the selected pod.
- DEPLOYMENT_DONE: Image management version status when VM deployment is done for the selected pod.
- DISABLED: Image management version has been disabled and no further pool operation can be done using the same.
- FAILED: Image management version creation has failed.
- PARTIALLY_AVAILABLE: Some of the image management asset creation in some of the virtual centers have failed.
- PUBLISHING: Image management version is being published and specialized internally like installing agents etc.
- REPLICATING: Copying the specialized images across all virtual centers.
Information about the application installed on RDS server/machine of a farm/desktop pool.
{
"executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
"file_types": [
{
"description": "Firefox Document",
"type": ".html"
}
],
"name": "Firefox",
"other_file_types": [
{
"description": "Firefox URL",
"name": "https",
"type": "URL"
}
],
"publisher": "Mozilla Corporation",
"version": "72.0.2"
}
Path to application executable.
Set of file types reported by the application as supported. If unset, this application does not present any file type support.
Application name information, as sent by RDSServer/machine during application discovery.
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.
Application publisher
Application version.
Information about the application installed on RDS server/machine of a farm/desktop pool based on a given application execution path.
{
"application_exe_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Accessibility\\Speech Recognition.lnk",
"machine_or_rds_server_ids": [
"c617fd51-e118-4cae-970c-54a7144aaadc",
"bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"
],
"status": "SUCCESS"
}
Application executable path.
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.
Status of application installation on all RDS servers/machines.
- SUCCESS: The given application is installed on all RDS Servers/machines of a given farm/desktop pool.
- NOT_INSTALLED: The given application is not installed on one or more RDS Servers/machines of a given farm/desktop pool.
Instant clone domain account object to be created.
{
"ad_domain_id": "S-1-5-21-1085031214-1563985344-725345543",
"password": [
"<password>"
],
"username": "testuser"
}
SID of the AD Domain that this account user belongs to.
Password of the account.
User name of the account.
Information related to instant clone domain accounts of the environment.
{
"ad_domain_id": "S-1-5-21-1085031214-1563985344-725345543",
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"username": "testuser"
}
SID of the AD Domain that this account user belongs to.
Unique ID representing instant clone domain account.
User name of the account.
Instant clone domain account object to be updated.
{
"password": [
"<password>"
]
}
Password of the account.
JWT authenticator object to be created.
{
"description": "Jwt Authenticator Description",
"issuer": "portal",
"name": "Jwt Authenticator",
"public_keys": [
"{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"
],
"url": "https://example.com/portal/.well-known/openid-configuration"
}
The description of this JWT authenticator.
The issuer of this JWT authenticator. The configured value is matched against the "iss" claim of the JWT.
The name of the JWT authenticator. It must be unique among all other JWT authenticators.
The publicKeys as Json strings for this JWT authenticator. If "publicKeys" is blank, then "url" must not be blank.
The URL to fetch the public keys for this authenticator. If "url" is blank, then "publicKeys" must not be blank.
Information about JWT authenticator.
{
"description": "Jwt Authenticator Description",
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"issuer": "portal",
"name": "Jwt Authenticator",
"public_keys": [
"{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"
],
"url": "https://example.com/portal/.well-known/openid-configuration"
}
The description of this JWT authenticator.
Unique ID of this JWT authenticator.
The issuer of this JWT authenticator. The configured value is matched against the "iss" claim of the JWT.
The name of this JWT authenticator.
The stored public keys for this JWT authenticator.
The URL to fetch the public keys for this authenticator.
JWT authenticator object to be updated.
{
"description": "Jwt Authenticator Description",
"issuer": "portal",
"name": "Jwt Authenticator",
"public_keys": [
"{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"
],
"url": "https://example.com/portal/.well-known/openid-configuration"
}
The description of this JWT authenticator.
The issuer of this JWT authenticator. The configured value is matched against the "iss" claim of the JWT.
The name of the JWT authenticator. It must be unique among all other JWT authenticators.
The publicKeys as Json strings for this JWT authenticator. If "publicKeys" is blank, then "url" must not be blank.
The URL to fetch the public keys for this authenticator. If "url" is blank, then "publicKeys" must not be blank.
Information about a license.
{
"application_pool_launch_enabled": "boolean",
"desktop_pool_launch_enabled": "boolean",
"expiration_time": 1656527400000,
"grace_period_days": 100,
"help_desk_enabled": "boolean",
"instant_clone_enabled": true,
"license_edition": "HORIZON_STANDARD_CONCURRENT_USER",
"license_health": "GREEN",
"license_key": "KHJL-XXXXX-XXXXX-XXXXX-E3HNJ",
"license_mode": "SUBSCRIPTION",
"licensed": true,
"session_collaboration_enabled": true,
"subscription_slice_expiry": 1465711500000,
"usage_model": "NAMED_USER"
}
Whether application pool launch is enabled.
Whether desktop pool launch is enabled.
The expiration date of the license. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.
The grace period in days. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.
Whether help desk is enabled.
Whether instant clone is enabled.
The license edition. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.
- ENTERPRISE_CONCURRENT_USER: VMware Enterprise.
- HORIZON_ADVANCED_CONCURRENT_USER: VMware Horizon Advanced (Concurrent User).
- HORIZON_ADVANCED_NAMED_USER: VMware Horizon Advanced (Named User).
- HORIZON_APPS_ADVANCED_CONCURRENT_USER: Mware Horizon Apps 7 Advanced (Concurrent User).
- HORIZON_APPS_ADVANCED_NAMED_USER: VMware Horizon Apps 7 Advanced (Named User).
- HORIZON_APPS_STANDARD_CONCURRENT_USER: VMware Horizon Apps 7 Standard (Concurrent User).
- HORIZON_APPS_STANDARD_NAMED_USER: VMware Horizon Apps 7 Standard (Named User).
- HORIZON_ENTERPRISE_CONCURRENT_USER: Horizon Enterprise (Concurrent User).
- HORIZON_ENTERPRISE_NAMED_USER: Horizon Enterprise (Named User).
- HORIZON_STANDARD_CONCURRENT_USER: VMware Horizon Standard (Concurrent User).
- WS1_ENTERPRISE_NAMED_USER: Workspace ONE Enterprise.
- WS1_ENTERPRISE_WITH_VDI_NAMED_USER: Workspace ONE Enterprise with VDI.
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.
- GREEN: License is not expired and license update is missed but not more than 7 days.
- RED: License is expired.
- YELLOW: License is not expired and license update is missed for more than 7 days.
The license key in partially redacted form. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.
The license mode used. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.
- DEFAULT: Perpetual license is in use.
- PERPETUAL_ONLY: Perpetual license is in use.
- SUBSCRIPTION: Cloud subscription license is in use.
Whether the horizon is licensed.
Whether session collaboration is enabled.
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.
TThe usage model for this license.
- CONCURRENT_USER: The is the license usage model for a standalone install.
- NAMED_USER: This is the license usage model for an install as part of a suite.
Information about a license.
{
"agent_auto_upgrade_enabled": true,
"application_pool_launch_enabled": "boolean",
"desktop_pool_launch_enabled": "boolean",
"expiration_time": 1656527400000,
"grace_period_days": 100,
"help_desk_enabled": "boolean",
"instant_clone_enabled": true,
"license_edition": "HORIZON_STANDARD_CONCURRENT_USER",
"license_health": "GREEN",
"license_key": "KHJL-XXXXX-XXXXX-XXXXX-E3HNJ",
"license_mode": "SUBSCRIPTION",
"licensed": true,
"session_collaboration_enabled": true,
"subscription_slice_expiry": 1465711500000,
"usage_model": "NAMED_USER"
}
Indicates whether agent auto upgrade is enabled.
Whether application pool launch is enabled.
Whether desktop pool launch is enabled.
The expiration date of the license. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.
The grace period in days. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.
Whether help desk is enabled.
Whether instant clone is enabled.
The license edition. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.
- ENTERPRISE_CONCURRENT_USER: VMware Enterprise.
- HORIZON_ADVANCED_CONCURRENT_USER: VMware Horizon Advanced (Concurrent User).
- HORIZON_ADVANCED_NAMED_USER: VMware Horizon Advanced (Named User).
- HORIZON_APPS_ADVANCED_CONCURRENT_USER: Mware Horizon Apps 7 Advanced (Concurrent User).
- HORIZON_APPS_ADVANCED_NAMED_USER: VMware Horizon Apps 7 Advanced (Named User).
- HORIZON_APPS_STANDARD_CONCURRENT_USER: VMware Horizon Apps 7 Standard (Concurrent User).
- HORIZON_APPS_STANDARD_NAMED_USER: VMware Horizon Apps 7 Standard (Named User).
- HORIZON_ENTERPRISE_CONCURRENT_USER: Horizon Enterprise (Concurrent User).
- HORIZON_ENTERPRISE_NAMED_USER: Horizon Enterprise (Named User).
- HORIZON_STANDARD_CONCURRENT_USER: VMware Horizon Standard (Concurrent User).
- WS1_ENTERPRISE_NAMED_USER: Workspace ONE Enterprise.
- WS1_ENTERPRISE_WITH_VDI_NAMED_USER: Workspace ONE Enterprise with VDI.
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.
- GREEN: License is not expired and license update is missed but not more than 7 days.
- RED: License is expired.
- YELLOW: License is not expired and license update is missed for more than 7 days.
The license key in partially redacted form. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.
The license mode used. Caller should have permission to GLOBAL_CONFIG_VIEW privilege for this field to be populated.
- DEFAULT: Perpetual license is in use.
- PERPETUAL_ONLY: Perpetual license is in use.
- SUBSCRIPTION: Cloud subscription license is in use.
Whether the horizon is licensed.
Whether session collaboration is enabled.
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.
TThe usage model for this license.
- CONCURRENT_USER: The is the license usage model for a standalone install.
- NAMED_USER: This is the license usage model for an install as part of a suite.
The specification to set the license key.
{
"license_key": "Z16CH-J2QDL-P8TJT-0CX2M-949MH"
}
The license key to set.
The specification to set the license mode.
{
"license_mode": "SUBSCRIPTION"
}
The license mode used.
- DEFAULT: Perpetual license is in use.
- PERPETUAL_ONLY: Perpetual license is in use.
- SUBSCRIPTION: Cloud subscription license is in use.
Metrics related to current and highest historical usage numbers of the product license
{
"current_usage": {
"concurrent_application_sessions": 5,
"concurrent_collaborative_sessions": 9,
"concurrent_full_vm_sessions": 5,
"concurrent_unmanaged_vm_sessions": 7,
"total_collaborators": 3,
"total_concurrent_connections": 10,
"total_concurrent_sessions": 2,
"total_named_users": 8
},
"highest_usage": {
"concurrent_application_sessions": 5,
"concurrent_collaborative_sessions": 9,
"concurrent_full_vm_sessions": 5,
"concurrent_unmanaged_vm_sessions": 7,
"total_collaborators": 3,
"total_concurrent_connections": 10,
"total_concurrent_sessions": 2,
"total_named_users": 8
}
}
Load Balancer Metric settings for Farm.
{
"cpu_threshold": 50,
"disk_queue_length_threshold": 50,
"disk_read_latency_threshold": 50,
"disk_write_latency_threshold": 50,
"include_session_count": true,
"memory_threshold": 50
}
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.
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.
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.
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.
Whether to include session count for load balancing. Default value is true.
Represents threshold of memory usage, in percentage.If the value is 0, then this metric will not be considered for load balancing.
Local access group object to be created.
{
"description": "This access group can be used to delegate administration of sales team inventories to specific administrators.",
"name": "Sales"
}
Access group description.
Access group name. This property must contain only alphanumerics, underscores, and dashes.
Information about a local access group.
{
"deletable": true,
"description": "This access group can be used to delegate administration of sales team inventories to specific administrators.",
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"name": "Sales"
}
Indicates whether this access group can be deleted.
Access group description.
Unique ID representing this access group.
Access group name.
Information about a local access group.
{
"deletable": true,
"description": "This access group can be used to delegate administration of sales team inventories to specific administrators.",
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"name": "Sales",
"permission_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"6fd4638a-381f-4518-aed6-042aa3d9f14c"
]
}
Indicates whether this access group can be deleted.
Access group description.
Unique ID representing this access group.
Access group name.
List of permission ids associated with the access group
Information required to collect logs.
{
"component_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"component_type": "AGENT",
"feature_list": [
"all",
"blast"
],
"filter_type": [
"DEFAULT"
],
"sticky_log_collection": "boolean"
}
Represents the ID of the log collector component type for which logs are to be collected.
Represents CS id if CS logs are collected, Machine id if Agent logs are collected and
RDS server id if Agent RDS logs are collected.
Represents the type of the log collector component.
- CONNECTION_SERVER: Log component type is Connection Server.
- AGENT: Log component type is agent machine from desktop pool.
- AGENT_RDS: Log component type is agent RDSH server from farm.
List of features for which the logs need to be collected. Feature wise log collection is supported only for component_type AGENT and AGENT_RDS. If feature_list is null then by default logs are collected for all the features.
Filter type to be used while collecting the logs bundle. Filter is set to DEFAULT if none specified.
Indicates the connection server processing the LogCollectorCollectSpec becomes the download owner.
Information about Log collector Task.
{
"component_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"component_type": "AGENT",
"end_time": 1652079610000,
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"initiated_by": "S-1-5-21-1111111111-2222222222-3333333333-500",
"start_time": 1656527400000,
"task_state": "IDLE"
}
Represents the ID of the log collector component type for which logs are to be collected.
Represents CS id if CS logs are collected, Machine id if Agent logs are collected and
RDS server id if Agent RDS logs are collected.
Represents the type of the log collector component. Supported Filters : 'Equals'. This property can be used for sorting.
- CONNECTION_SERVER: Log component type is Connection Server.
- AGENT: Log component type is agent machine from desktop pool.
- AGENT_RDS: Log component type is agent RDSH server from farm.
End time of the log collection. Supported Filters : 'Between', 'Equals. This property can be used for sorting.
Unique identifier of a log collector task. Supported Filters : 'Equals'. This property can be used for sorting.
User identity information. Supported Filters : 'Equals. This property can be used for sorting.
Start time of the log collection. Supported Filters : 'Between', 'Equals. This property can be used for sorting.
Log collector task state. Supported Filters : 'Equals'. This property can be used for sorting.
- IDLE: Log Collection task is in IDLE state.
- COLLECT: Log Collection task has started collecting logs bundle.
- COLLECT_COMPLETE: Log collection task has completed collection of logs bundle.
- PURGE_COMPLETE: Log collection task has completed purge operation.
- PURGE: Log collection task is in purge operation.
- COLLECT_TIMED_OUT: Log collection task has timed out and the process has been interrupted.
- ERROR: Log collection task has ended in error.
- ABORT_COMPLETE: Log collection task has been aborted.
- NON_RESPONSIVE: In rare occasions, the log collection process becomes non-responsive. A connection server restart is required to remediate it.
Information about session timing data.
{
"logon_segment_data": "<logon Segment>"
}
Logon segment data of the session.
Machine agent upgrade spec.
{
"agent_installer_package_id": "2b6eaeb8-2e91-11ed-a261-0242ac120002",
"custom_install_parameters": "ADDLOCAL=Core,USB",
"end_time": 1652079610000,
"machine_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"skip_for_logged_in_users": true,
"start_time": 1652079610000
}
ID of the agent installer package.
Indicates any parameters to be used by the agent for silent install.
Agent upgrade end time.
Machine Ids representing the machines to be upgraded.
Indicates whether to skip agent upgrade for logged in users.
Agent upgrade start time.
Info for reading machine aliases of assigned users.
{
"ad_user_id": "S-1-5-21-2898529287-1016622242-505487308-1553",
"alias_name": "Alias1"
}
Sid of the user
Alias name of the user.
The specification for updating machine aliases of assigned users.
{
"ad_user_id": "S-1-5-21-2898529287-1016622242-505487308-1553",
"alias_name": "Alias1"
}
Sid of the user
Alias name of the user.
The specification applicable to deleting the machine.
{
"allow_delete_from_multi_desktop_pools": true,
"archive_datastore_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"archive_datastore_path_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"archive_persistent_disk": true,
"delete_from_disk": true,
"force_logoff_session": true
}
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.
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.
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.
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.
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.
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.
The machines and specification for deletion.
{
"machine_delete_data": {
"allow_delete_from_multi_desktop_pools": true,
"archive_datastore_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"archive_datastore_path_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"archive_persistent_disk": true,
"delete_from_disk": true,
"force_logoff_session": true
},
"machine_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
]
}
Machine Ids representing the machines to be deleted.
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.
{
"agent_build_number": "22673015",
"agent_version": "7.12",
"attempted_theft_by_connection_server": [
"connection-server2.example.com"
],
"configured_by_connection_server": [
"connection-server1.example.com"
],
"desktop_pool_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"dns_name": "machine1.example.com",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"managed_machine_data": {
"clone_error_message": "Timeout expired trying to clone a virtual machine.",
"clone_error_time": 1575285661395,
"create_time": 1575285661395,
"host_name": "WD332H5",
"in_hold_customization": "boolean",
"in_maintenance_mode": "boolean",
"memory_mb": 1024,
"missing_in_vcenter": "boolean",
"network_labels": [
{
"network_label_name": "example-network",
"nic_name": "network1"
}
],
"path": "/path/host",
"storage_accelerator_state": "CURRENT",
"virtual_center_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"virtual_disks": [
{
"capacity_mb": 102400,
"datastore_path": "datastore1",
"path": "/path/host"
}
],
"virtual_machine_power_state": "POWERED_ON"
},
"message_security_enhanced_mode_supported": true,
"message_security_mode": "MIXED",
"name": "machine1",
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pairing_state": "IN_PAIRING",
"remote_experience_agent_build_number": "32573985",
"remote_experience_agent_version": "7.12",
"state": "PROVISIONING",
"type": "MANAGED_MACHINE",
"user_ids": [
"S-1-1-1-3965912346-1012345398-3123456564-123",
"S-1-2-3-3123456786-1012345398-3123456784-124"
]
}
The Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
The Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.
Names of the Horizon Connection Servers the Horizon Agent is paired with.
The id of the Desktop Pool that the machine belongs to.
Supported Filters : 'Equals'.
DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
Unique ID representing machine.
Supported Filters : 'Equals'.
Indicates whether ENHANCED message security mode is currently supported by this machine.
The current JMS message security mode used by this machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The guest operating system. This property can be used for sorting.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
The guest operating system architecture.
- UNKNOWN: Operating System cannot be determined.
- BIT_32: 32 bit Operating System Architecture.
- BIT_64: 64 bit Operating System Architecture.
Horizon Agent pairing state.
- NOT_AVAILABLE: Agent pairing state is not available.
- IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.
- PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.
The remote experience Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
The remote experience Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
The state of the machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.
- AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.
- AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.
- AGENT_ERROR_DISABLED: Horizon Agent is disabled.
- AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.
- AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.
- AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.
- AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.
- AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.
- AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.
- ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.
- AVAILABLE: The machine is powered on and ready for active connections.
- BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.
- CONNECTED: The machine is in an active session and has an active connection to a Horizon client.
- CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.
- DELETING: The machine is marked for deletion.
- DISABLED: The machine is disabled.
- DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.
- DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.
- ERROR: An unknown error occurred in the machine.
- IN_PROGRESS: There is a machine operation in progress.
- MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.
- PROVISIONED: The machine is powered off or suspended.
- PROVISIONING: The machine is being provisioned.
- PROVISIONING_ERROR: An error occurred during provisioning.
- UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.
- UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.
- UNKNOWN: Could not determine the state of the machine.
- VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.
- 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.
The type of machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- MANAGED_MACHINE: The machine is a managed virtual machine.
- UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.
The unique SIDs of the users assigned to the machine.
Supported Filters : 'Equals', 'NotEquals' and 'Contains'.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"agent_build_number": "22673015",
"agent_version": "7.12",
"aliases": [
{
"ad_user_id": "S-1-5-21-2898529287-1016622242-505487308-1553",
"alias_name": "Alias1"
}
],
"attempted_theft_by_connection_server": [
"connection-server2.example.com"
],
"configured_by_connection_server": [
"connection-server1.example.com"
],
"desktop_pool_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"dns_name": "machine1.example.com",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"managed_machine_data": {
"base_vm_id": "vm-23",
"base_vm_snapshot_id": "snapshot-2",
"clone_error_message": "Timeout expired trying to clone a virtual machine.",
"clone_error_time": 1575285661395,
"create_time": 1575285661395,
"datastore_ids": [
"datastore1",
"datastore2"
],
"host_name": "WD332H5",
"image_management_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"in_hold_customization": "boolean",
"in_maintenance_mode": "boolean",
"last_maintenance_time": 1587081283000,
"logoff_policy": "FORCE_LOGOFF",
"memory_mb": 1024,
"missing_in_vcenter": "boolean",
"network_labels": [
{
"network_label_name": "example-network",
"nic_name": "network1"
}
],
"operation": "REFRESH",
"operation_state": "AVAILABLE",
"path": "/path/host",
"pending_base_vm_id": "vm-8",
"pending_base_vm_snapshot_id": "snapshot-7",
"pending_image_management_stream_id": "ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25",
"pending_image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"storage_accelerator_state": "CURRENT",
"virtual_center_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"virtual_disks": [
{
"capacity_mb": 102400,
"datastore_path": "datastore1",
"path": "/path/host"
}
],
"virtual_machine_power_state": "POWERED_ON"
},
"message_security_enhanced_mode_supported": true,
"message_security_mode": "MIXED",
"name": "machine1",
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pairing_state": "IN_PAIRING",
"remote_experience_agent_build_number": "32573985",
"remote_experience_agent_version": "7.12",
"session_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"state": "PROVISIONING",
"type": "MANAGED_MACHINE",
"user_ids": [
"S-1-1-1-3965912346-1012345398-3123456564-123",
"S-1-2-3-3123456786-1012345398-3123456784-124"
]
}
Access group id of this Machine.
The Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
The Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.
Names of the Horizon Connection Servers the Horizon Agent is paired with.
The id of the Desktop Pool that the machine belongs to.
Supported Filters : 'Equals'.
DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
Unique ID representing machine.
Supported Filters : 'Equals'.
Indicates whether ENHANCED message security mode is currently supported by this machine.
The current JMS message security mode used by this machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The guest operating system. This property can be used for sorting.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
The guest operating system architecture.
- UNKNOWN: Operating System cannot be determined.
- BIT_32: 32 bit Operating System Architecture.
- BIT_64: 64 bit Operating System Architecture.
Horizon Agent pairing state.
- NOT_AVAILABLE: Agent pairing state is not available.
- IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.
- PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.
The remote experience Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
The remote experience Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
The ID of the session on the Machine (if one exists).
The state of the machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.
- AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.
- AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.
- AGENT_ERROR_DISABLED: Horizon Agent is disabled.
- AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.
- AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.
- AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.
- AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.
- AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.
- AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.
- ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.
- AVAILABLE: The machine is powered on and ready for active connections.
- BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.
- CONNECTED: The machine is in an active session and has an active connection to a Horizon client.
- CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.
- DELETING: The machine is marked for deletion.
- DISABLED: The machine is disabled.
- DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.
- DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.
- ERROR: An unknown error occurred in the machine.
- IN_PROGRESS: There is a machine operation in progress.
- MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.
- PROVISIONED: The machine is powered off or suspended.
- PROVISIONING: The machine is being provisioned.
- PROVISIONING_ERROR: An error occurred during provisioning.
- UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.
- UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.
- UNKNOWN: Could not determine the state of the machine.
- VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.
- 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.
The type of machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- MANAGED_MACHINE: The machine is a managed virtual machine.
- UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.
The unique SIDs of the users assigned to the machine.
Supported Filters : 'Equals', 'NotEquals' and 'Contains'.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"agent_build_number": "22673015",
"agent_version": "7.12",
"aliases": [
{
"ad_user_id": "S-1-5-21-2898529287-1016622242-505487308-1553",
"alias_name": "Alias1"
}
],
"attempted_theft_by_connection_server": [
"connection-server2.example.com"
],
"configured_by_connection_server": [
"connection-server1.example.com"
],
"desktop_pool_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"dns_name": "machine1.example.com",
"held_machine": true,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"managed_machine_data": {
"base_vm_id": "vm-23",
"base_vm_snapshot_id": "snapshot-2",
"clone_error_message": "Timeout expired trying to clone a virtual machine.",
"clone_error_time": 1575285661395,
"create_time": 1575285661395,
"datastore_ids": [
"datastore1",
"datastore2"
],
"host_name": "WD332H5",
"image_management_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"in_hold_customization": "boolean",
"in_maintenance_mode": "boolean",
"last_maintenance_time": 1587081283000,
"logoff_policy": "FORCE_LOGOFF",
"memory_mb": 1024,
"missing_in_vcenter": "boolean",
"network_labels": [
{
"network_label_name": "example-network",
"nic_name": "network1"
}
],
"operation": "REFRESH",
"operation_state": "AVAILABLE",
"path": "/path/host",
"pending_base_vm_id": "vm-8",
"pending_base_vm_snapshot_id": "snapshot-7",
"pending_image_management_stream_id": "ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25",
"pending_image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"storage_accelerator_state": "CURRENT",
"virtual_center_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"virtual_disks": [
{
"capacity_mb": 102400,
"datastore_path": "datastore1",
"path": "/path/host"
}
],
"virtual_machine_power_state": "POWERED_ON"
},
"message_security_enhanced_mode_supported": true,
"message_security_mode": "MIXED",
"name": "machine1",
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pairing_state": "IN_PAIRING",
"remote_experience_agent_build_number": "32573985",
"remote_experience_agent_version": "7.12",
"session_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"state": "PROVISIONING",
"type": "MANAGED_MACHINE",
"user_ids": [
"S-1-1-1-3965912346-1012345398-3123456564-123",
"S-1-2-3-3123456786-1012345398-3123456784-124"
]
}
Access group id of this Machine.
The Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
The Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.
Names of the Horizon Connection Servers the Horizon Agent is paired with.
The id of the Desktop Pool that the machine belongs to.
Supported Filters : 'Equals'.
DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
Indicates whether the machine is in held state.Supported Filters: 'Equals'. This property can be used for sorting.
Unique ID representing machine.
Supported Filters : 'Equals'.
Indicates whether ENHANCED message security mode is currently supported by this machine.
The current JMS message security mode used by this machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The guest operating system. This property can be used for sorting.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
The guest operating system architecture.
- UNKNOWN: Operating System cannot be determined.
- BIT_32: 32 bit Operating System Architecture.
- BIT_64: 64 bit Operating System Architecture.
Horizon Agent pairing state.
- NOT_AVAILABLE: Agent pairing state is not available.
- IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.
- PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.
The remote experience Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
The remote experience Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
The ID of the session on the Machine (if one exists).
The state of the machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.
- AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.
- AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.
- AGENT_ERROR_DISABLED: Horizon Agent is disabled.
- AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.
- AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.
- AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.
- AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.
- AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.
- AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.
- ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.
- AVAILABLE: The machine is powered on and ready for active connections.
- BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.
- CONNECTED: The machine is in an active session and has an active connection to a Horizon client.
- CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.
- DELETING: The machine is marked for deletion.
- DISABLED: The machine is disabled.
- DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.
- DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.
- ERROR: An unknown error occurred in the machine.
- IN_PROGRESS: There is a machine operation in progress.
- MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.
- PROVISIONED: The machine is powered off or suspended.
- PROVISIONING: The machine is being provisioned.
- PROVISIONING_ERROR: An error occurred during provisioning.
- UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.
- UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.
- UNKNOWN: Could not determine the state of the machine.
- VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.
- 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.
The type of machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- MANAGED_MACHINE: The machine is a managed virtual machine.
- UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.
The unique SIDs of the users assigned to the machine.
Supported Filters : 'Equals', 'NotEquals' and 'Contains'.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"agent_build_number": "22673015",
"agent_upgrade_error_message": "true",
"agent_upgrade_result": "OK",
"agent_upgrade_state": "WAIT",
"agent_version": "7.12",
"aliases": [
{
"ad_user_id": "S-1-5-21-2898529287-1016622242-505487308-1553",
"alias_name": "Alias1"
}
],
"attempted_theft_by_connection_server": [
"connection-server2.example.com"
],
"configured_by_connection_server": [
"connection-server1.example.com"
],
"desktop_pool_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"dns_name": "machine1.example.com",
"held_machine": true,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"managed_machine_data": {
"base_vm_id": "vm-23",
"base_vm_snapshot_id": "snapshot-2",
"clone_error_message": "Timeout expired trying to clone a virtual machine.",
"clone_error_time": 1575285661395,
"create_time": 1575285661395,
"datastore_ids": [
"datastore1",
"datastore2"
],
"host_name": "WD332H5",
"image_management_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"in_hold_customization": "boolean",
"in_maintenance_mode": "boolean",
"last_maintenance_time": 1587081283000,
"logoff_policy": "FORCE_LOGOFF",
"memory_mb": 1024,
"missing_in_vcenter": "boolean",
"network_labels": [
{
"network_label_name": "example-network",
"nic_name": "network1"
}
],
"operation": "REFRESH",
"operation_state": "AVAILABLE",
"path": "/path/host",
"pending_base_vm_id": "vm-8",
"pending_base_vm_snapshot_id": "snapshot-7",
"pending_image_management_stream_id": "ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25",
"pending_image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"storage_accelerator_state": "CURRENT",
"virtual_center_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"virtual_disks": [
{
"capacity_mb": 102400,
"datastore_path": "datastore1",
"path": "/path/host"
}
],
"virtual_machine_power_state": "POWERED_ON"
},
"message_security_enhanced_mode_supported": true,
"message_security_mode": "MIXED",
"name": "machine1",
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pairing_state": "IN_PAIRING",
"remote_experience_agent_build_number": "32573985",
"remote_experience_agent_version": "7.12",
"session_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"state": "PROVISIONING",
"type": "MANAGED_MACHINE",
"user_ids": [
"S-1-1-1-3965912346-1012345398-3123456564-123",
"S-1-2-3-3123456786-1012345398-3123456784-124"
]
}
Access group id of this Machine.
The Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
Error message of the agent upgrade operation failure on the machine. This property can be used for sorting.
Result of the agent upgrade operation on the machine. This property can be used for sorting.
- DUPLICATE: Agent received duplicate upgrade request.
- ERROR: Agent upgrade has unknown error.
- FAILURE: Agent upgrade has failed.
- INVALID: Agent received invalid values for upgrade.
- NOT_FOUND: Agent could not find upgrade request.
- OK: Agent upgrade is OK.
- PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.
- PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.
- PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.
- PROGRESS: Agent upgrade is in progress.
- UNKNOWN: Agent upgrade result is unknown.
State of the agent upgrade operation on the machine. This property can be used for sorting.
- DONE: Agent upgrade task has ended.
- DOWNLOAD: Agent is downloading the upgrade binary.
- NOLOGON: Agent has no logged in user.
- READY: Agent is ready to be upgraded.
- UNKNOWN: Agent upgrade state is unknown.
- UPDATING: Agent is upgrading.
- WAIT: Agent is waiting for user to logoff or for reboot to complete.
The Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.
Names of the Horizon Connection Servers the Horizon Agent is paired with.
The id of the Desktop Pool that the machine belongs to.
Supported Filters : 'Equals'.
DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
Indicates whether the machine is in held state.Supported Filters: 'Equals'. This property can be used for sorting.
Unique ID representing machine.
Supported Filters : 'Equals'.
Indicates whether ENHANCED message security mode is currently supported by this machine.
The current JMS message security mode used by this machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The guest operating system. This property can be used for sorting.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
The guest operating system architecture.
- UNKNOWN: Operating System cannot be determined.
- BIT_32: 32 bit Operating System Architecture.
- BIT_64: 64 bit Operating System Architecture.
Horizon Agent pairing state.
- NOT_AVAILABLE: Agent pairing state is not available.
- IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.
- PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.
The remote experience Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
The remote experience Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
The ID of the session on the Machine (if one exists).
The state of the machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.
- AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.
- AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.
- AGENT_ERROR_DISABLED: Horizon Agent is disabled.
- AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.
- AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.
- AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.
- AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.
- AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.
- AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.
- ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.
- AVAILABLE: The machine is powered on and ready for active connections.
- BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.
- CONNECTED: The machine is in an active session and has an active connection to a Horizon client.
- CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.
- DELETING: The machine is marked for deletion.
- DISABLED: The machine is disabled.
- DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.
- DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.
- ERROR: An unknown error occurred in the machine.
- IN_PROGRESS: There is a machine operation in progress.
- MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.
- PROVISIONED: The machine is powered off or suspended.
- PROVISIONING: The machine is being provisioned.
- PROVISIONING_ERROR: An error occurred during provisioning.
- UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.
- UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.
- UNKNOWN: Could not determine the state of the machine.
- VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.
- 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.
The type of machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- MANAGED_MACHINE: The machine is a managed virtual machine.
- UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.
The unique SIDs of the users assigned to the machine.
Supported Filters : 'Equals', 'NotEquals' and 'Contains'.
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.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"agent_build_number": "22673015",
"agent_id": "agent/4ffe3d72-a490-4dd1-9a61-7a221c54c94f",
"agent_ipv4_address": "192.168.1.1",
"agent_ipv6_address": "2001:db8:3333:4444:5555:6666:7777:8888",
"agent_upgrade_error_message": "true",
"agent_upgrade_result": "OK",
"agent_upgrade_state": "WAIT",
"agent_version": "7.12",
"aliases": [
{
"ad_user_id": "S-1-5-21-2898529287-1016622242-505487308-1553",
"alias_name": "Alias1"
}
],
"attempted_theft_by_connection_server": [
"connection-server2.example.com"
],
"configured_by_connection_server": [
"connection-server1.example.com"
],
"desktop_pool_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"dns_name": "machine1.example.com",
"held_machine": true,
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"managed_machine_data": {
"base_vm_id": "vm-23",
"base_vm_snapshot_id": "snapshot-2",
"clone_error_message": "Timeout expired trying to clone a virtual machine.",
"clone_error_time": 1575285661395,
"create_time": 1575285661395,
"datastore_ids": [
"datastore1",
"datastore2"
],
"host_name": "WD332H5",
"image_management_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"in_hold_customization": "boolean",
"in_maintenance_mode": "boolean",
"last_maintenance_time": 1587081283000,
"logoff_policy": "FORCE_LOGOFF",
"memory_mb": 1024,
"missing_in_vcenter": "boolean",
"network_labels": [
{
"network_label_name": "example-network",
"nic_name": "network1"
}
],
"operation": "REFRESH",
"operation_state": "AVAILABLE",
"path": "/path/host",
"pending_base_vm_id": "vm-8",
"pending_base_vm_snapshot_id": "snapshot-7",
"pending_image_management_stream_id": "ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25",
"pending_image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"persistent_disk_ids": [
"c1d5aec7-2126-3c55-aefa-11949003c9c2"
],
"storage_accelerator_state": "CURRENT",
"virtual_center_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"virtual_disks": [
{
"capacity_mb": 102400,
"datastore_path": "datastore1",
"path": "/path/host"
}
],
"virtual_machine_power_state": "POWERED_ON",
"vm_moid": "vm-123"
},
"message_security_enhanced_mode_supported": true,
"message_security_mode": "MIXED",
"name": "machine1",
"operating_system": "WINDOWS_SERVER_2016",
"operating_system_architecture": "BIT_64",
"pairing_state": "IN_PAIRING",
"remote_experience_agent_build_number": "32573985",
"remote_experience_agent_version": "7.12",
"session_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"state": "PROVISIONING",
"type": "MANAGED_MACHINE",
"user_ids": [
"S-1-1-1-3965912346-1012345398-3123456564-123",
"S-1-2-3-3123456786-1012345398-3123456784-124"
]
}
Access group id of this Machine.
The Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
Agent Id.
Supported Filters: 'Equals'.
The agent ipv4 address.
The agent ipv6 address.
Error message of the agent upgrade operation failure on the machine. This property can be used for sorting.
Result of the agent upgrade operation on the machine. This property can be used for sorting.
- DUPLICATE: Agent received duplicate upgrade request.
- ERROR: Agent upgrade has unknown error.
- FAILURE: Agent upgrade has failed.
- INVALID: Agent received invalid values for upgrade.
- NOT_FOUND: Agent could not find upgrade request.
- OK: Agent upgrade is OK.
- PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.
- PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.
- PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.
- PROGRESS: Agent upgrade is in progress.
- UNKNOWN: Agent upgrade result is unknown.
State of the agent upgrade operation on the machine. This property can be used for sorting.
- DONE: Agent upgrade task has ended.
- DOWNLOAD: Agent is downloading the upgrade binary.
- NOLOGON: Agent has no logged in user.
- READY: Agent is ready to be upgraded.
- UNKNOWN: Agent upgrade state is unknown.
- UPDATING: Agent is upgrading.
- WAIT: Agent is waiting for user to logoff or for reboot to complete.
The Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
Names of the Horizon Connection Servers that attempted theft of pairing for this Agent.
Names of the Horizon Connection Servers the Horizon Agent is paired with.
The id of the Desktop Pool that the machine belongs to.
Supported Filters : 'Equals'.
DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
Indicates whether the machine is in held state.Supported Filters: 'Equals'. This property can be used for sorting.
Unique ID representing machine.
Supported Filters : 'Equals'.
Indicates whether ENHANCED message security mode is currently supported by this machine.
The current JMS message security mode used by this machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The guest operating system. This property can be used for sorting.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
The guest operating system architecture.
- UNKNOWN: Operating System cannot be determined.
- BIT_32: 32 bit Operating System Architecture.
- BIT_64: 64 bit Operating System Architecture.
Horizon Agent pairing state.
- NOT_AVAILABLE: Agent pairing state is not available.
- IN_PAIRING: Agent pairing with Horizon Connection Server is in progress.
- PAIRED_AND_SECURED: Agent is paired and secured with a Horizon Connection Server.
The remote experience Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
The remote experience Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
The ID of the session on the Machine (if one exists).
The state of the machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.
- AGENT_DRAIN_MODE: RDS host is configured for drain mode. New connections are currently disabled.
- AGENT_DRAIN_UNTIL_RESTART: RDS host is configured for drain-until-restart mode.
- AGENT_ERROR_DISABLED: Horizon Agent is disabled.
- AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.
- AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.
- AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.
- AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.
- AGENT_ERROR_DOMAIN_FAILURE: The Remote Desktop Services domain failure.
- AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.
- ALREADY_USED: The machine is configured to have only one session which is currently in progress and cannot accept new sessions.
- AVAILABLE: The machine is powered on and ready for active connections.
- BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.
- CONNECTED: The machine is in an active session and has an active connection to a Horizon client.
- CUSTOMIZING: The machine which is from an automated desktop pool is being customized after provisioning.
- DELETING: The machine is marked for deletion.
- DISABLED: The machine is disabled.
- DISABLE_IN_PROGRESS: Disabled Horizon Connection Server still has some Horizon brokered sessions. It can still accept re-connections.
- DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.
- ERROR: An unknown error occurred in the machine.
- IN_PROGRESS: There is a machine operation in progress.
- MAINTENANCE: The machine is in maintenance mode. Users cannot log in or use the machine.
- PROVISIONED: The machine is powered off or suspended.
- PROVISIONING: The machine is being provisioned.
- PROVISIONING_ERROR: An error occurred during provisioning.
- UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.
- UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.
- UNKNOWN: Could not determine the state of the machine.
- VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.
- 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.
The type of machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- MANAGED_MACHINE: The machine is a managed virtual machine.
- UNMANAGED_MACHINE: The machine is an unmanaged physical or virtual machine.
The unique SIDs of the users assigned to the machine.
Supported Filters : 'Equals', 'NotEquals' and 'Contains'.
Attach specification.
{
"persistent_disk_id": "73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d"
}
ID of the persistent disk to be attached to the machine.
Detach specification.
{
"archive_datastore_id": "datastore-44",
"archive_datastore_path_id": "bd3ff8fc-b09a-47f7-917c-cc15c7301db6",
"persistent_disk_id": "73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d"
}
Datastore to which the persistent disk is to be archived.
If this is set, archive_datastore_path_id must also be set.
If unset, the persistent disk will be archived in place.
Datastore path to which the persistent disk is to be archived.
If this is set, archive_datastore_id must also be set.
If unset, the persistent disk will be archived in place.
ID of persistent disk to be detached from the machine.
Information required to recreate a machine from a persistent disk.
{
"desktop_pool_id": "4d480465-39e9-415e-8f0c-d7f6dc2bad52",
"machine_name": "machine-name",
"persistent_disk_id": "73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d"
}
ID of the desktop pool where the machine is to be recreated.
Name of the newly created machine, valid for specified naming desktop pools.
ID of the persistent disk from which the machine is to be recreated.
Information required to add a machine to a desktop pool.
{
"name": "machine1",
"user_id": "S-1-1-1-3965912346-1012345398-3123456564-123"
}
Name of the machine.
The unique SID of the user assigned to the machine.
Information related to Managed machines.
{
"clone_error_message": "Timeout expired trying to clone a virtual machine.",
"clone_error_time": 1575285661395,
"create_time": 1575285661395,
"host_name": "WD332H5",
"in_hold_customization": "boolean",
"in_maintenance_mode": "boolean",
"memory_mb": 1024,
"missing_in_vcenter": "boolean",
"network_labels": [
{
"network_label_name": "example-network",
"nic_name": "network1"
}
],
"path": "/path/host",
"storage_accelerator_state": "CURRENT",
"virtual_center_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"virtual_disks": [
{
"capacity_mb": 102400,
"datastore_path": "datastore1",
"path": "/path/host"
}
],
"virtual_machine_power_state": "POWERED_ON"
}
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.
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.
Time at which the machine was created in milliseconds. Measured as epoch time. This property can be used for sorting.
The name of the host on which this virtual machine is registered.
This condition determines if this virtual machine should be on hold before customization is started.
Supported Filters : 'Equals'. This property can be used for sorting.
Indicates whether the Machine is in maintenance mode.
The virtual machine physical memory in MB.
This condition determines if the virtual machine is missing in vCenter Server.
Supported Filters : 'Equals'. This property can be used for sorting.
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.
The virtual machine path.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.Field name to be used in filter : managedMachineData.path. This property can be used for sorting.
The Horizon Storage Accelerator state. Storage acceleration will be available for managed machines if configured.
Supported Filters : 'Equals'. This property can be used for sorting.
- CURRENT: The machine cached data is updated.
- ERROR: The Storage Accelerator has encountered an error.
- OFF: The Storage Accelerator is off.
- OUT_OF_DATE: The machine cached data is not updated and requires regeneration.
The ID of the Virtual Center managing this machine.
Supported Filters : 'Equals'.
The virtual machine power state.
Supported Filters : 'Equals'. This property can be used for sorting.
- POWERED_OFF: The machine is powered off.
- POWERED_ON: The machine is powered on.
- SUSPENDED: The machine is suspended.
Information related to Managed machines V2.
{
"base_vm_id": "vm-23",
"base_vm_snapshot_id": "snapshot-2",
"clone_error_message": "Timeout expired trying to clone a virtual machine.",
"clone_error_time": 1575285661395,
"create_time": 1575285661395,
"datastore_ids": [
"datastore1",
"datastore2"
],
"host_name": "WD332H5",
"image_management_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"in_hold_customization": "boolean",
"in_maintenance_mode": "boolean",
"last_maintenance_time": 1587081283000,
"logoff_policy": "FORCE_LOGOFF",
"memory_mb": 1024,
"missing_in_vcenter": "boolean",
"network_labels": [
{
"network_label_name": "example-network",
"nic_name": "network1"
}
],
"operation": "REFRESH",
"operation_state": "AVAILABLE",
"path": "/path/host",
"pending_base_vm_id": "vm-8",
"pending_base_vm_snapshot_id": "snapshot-7",
"pending_image_management_stream_id": "ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25",
"pending_image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"storage_accelerator_state": "CURRENT",
"virtual_center_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"virtual_disks": [
{
"capacity_mb": 102400,
"datastore_path": "datastore1",
"path": "/path/host"
}
],
"virtual_machine_power_state": "POWERED_ON"
}
The base VM id.
Supported Filters : 'Equals'.
The base VM snapshot id.
Supported Filters : 'Equals'.
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.
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.
Time at which the machine was created in milliseconds. Measured as epoch time. This property can be used for sorting.
The ids of the datastores.
The name of the host on which this virtual machine is registered.
The id of the image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.
The id of the image management tag. This will be populated only for instant clone machines provisioned from pools created using image catalog.
This condition determines if this virtual machine should be on hold before customization is started.
Supported Filters : 'Equals'. This property can be used for sorting.
Indicates whether the Machine is in maintenance mode.
The time of the last maintenance operation. This property can be used for sorting.
The user log off behavior at the time of maintenance. This property can be used for sorting.
- 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.
- WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
The virtual machine physical memory in MB.
This condition determines if the virtual machine is missing in vCenter Server.
Supported Filters : 'Equals'. This property can be used for sorting.
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.
The current maintenance operation on the machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- ARCHIVE: An archive operation.
- ATTACH: A persistent disk attach operation.
- DETACH: A persistent disk detach operation.
- PUSH_IMAGE: A push image operation.
- TAGGING: A tagging operation.
The state of the current maintenance operation on the machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- CANCELLING: The operation has been cancelled.
- COMPLETED: The operation has completed.
- CREATE: The operation is being initiated.
- FAULT: The operation has encountered an error.
- HOLDING: The operation has been paused.
- PROGRESSING: The operation is in progress.
- SCHEDULED: The operation is scheduled for future execution.
- STANDBY: The operation is on standby for a selective resync.
- UNDEFINED: The operation state is unrecognized.
The virtual machine path.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.Field name to be used in filter : managedMachineData.path. This property can be used for sorting.
The pending base VM id.
Supported Filters : 'Equals'.
The pending base VM snapshot id.
Supported Filters : 'Equals'.
The id of the pending image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.
The id of the pending image management tag. This will be populated only for machines belonging to Instant Clone farms created using image catalog.
The Horizon Storage Accelerator state. Storage acceleration will be available for managed machines if configured.
Supported Filters : 'Equals'. This property can be used for sorting.
- CURRENT: The machine cached data is updated.
- ERROR: The Storage Accelerator has encountered an error.
- OFF: The Storage Accelerator is off.
- OUT_OF_DATE: The machine cached data is not updated and requires regeneration.
The ID of the Virtual Center managing this machine.
Supported Filters : 'Equals'.
The virtual machine power state.
Supported Filters : 'Equals'. This property can be used for sorting.
- POWERED_OFF: The machine is powered off.
- POWERED_ON: The machine is powered on.
- SUSPENDED: The machine is suspended.
Information related to Managed machines.
{
"base_vm_id": "vm-23",
"base_vm_snapshot_id": "snapshot-2",
"clone_error_message": "Timeout expired trying to clone a virtual machine.",
"clone_error_time": 1575285661395,
"create_time": 1575285661395,
"datastore_ids": [
"datastore1",
"datastore2"
],
"host_name": "WD332H5",
"image_management_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"in_hold_customization": "boolean",
"in_maintenance_mode": "boolean",
"last_maintenance_time": 1587081283000,
"logoff_policy": "FORCE_LOGOFF",
"memory_mb": 1024,
"missing_in_vcenter": "boolean",
"network_labels": [
{
"network_label_name": "example-network",
"nic_name": "network1"
}
],
"operation": "REFRESH",
"operation_state": "AVAILABLE",
"path": "/path/host",
"pending_base_vm_id": "vm-8",
"pending_base_vm_snapshot_id": "snapshot-7",
"pending_image_management_stream_id": "ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25",
"pending_image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"persistent_disk_ids": [
"c1d5aec7-2126-3c55-aefa-11949003c9c2"
],
"storage_accelerator_state": "CURRENT",
"virtual_center_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"virtual_disks": [
{
"capacity_mb": 102400,
"datastore_path": "datastore1",
"path": "/path/host"
}
],
"virtual_machine_power_state": "POWERED_ON",
"vm_moid": "vm-123"
}
The base VM id.
Supported Filters : 'Equals'.
The base VM snapshot id.
Supported Filters : 'Equals'.
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.
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.
Time at which the machine was created in milliseconds. Measured as epoch time. This property can be used for sorting.
The ids of the datastores.
The name of the host on which this virtual machine is registered.
The id of the image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.
The id of the image management tag. This will be populated only for instant clone machines provisioned from pools created using image catalog.
This condition determines if this virtual machine should be on hold before customization is started.
Supported Filters : 'Equals'. This property can be used for sorting.
Indicates whether the Machine is in maintenance mode.
The time of the last maintenance operation. This property can be used for sorting.
The user log off behavior at the time of maintenance. This property can be used for sorting.
- 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.
- WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
The virtual machine physical memory in MB.
This condition determines if the virtual machine is missing in vCenter Server.
Supported Filters : 'Equals'. This property can be used for sorting.
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.
The current maintenance operation on the machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- ARCHIVE: An archive operation.
- ATTACH: A persistent disk attach operation.
- DETACH: A persistent disk detach operation.
- PUSH_IMAGE: A push image operation.
- TAGGING: A tagging operation.
The state of the current maintenance operation on the machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- CANCELLING: The operation has been cancelled.
- COMPLETED: The operation has completed.
- CREATE: The operation is being initiated.
- FAULT: The operation has encountered an error.
- HOLDING: The operation has been paused.
- PROGRESSING: The operation is in progress.
- SCHEDULED: The operation is scheduled for future execution.
- STANDBY: The operation is on standby for a selective resync.
- UNDEFINED: The operation state is unrecognized.
The virtual machine path.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.Field name to be used in filter : managedMachineData.path. This property can be used for sorting.
The pending base VM id.
Supported Filters : 'Equals'.
The pending base VM snapshot id.
Supported Filters : 'Equals'.
The id of the pending image management stream. This will be populated only for instant clone machines provisioned from pools created using image catalog.
The id of the pending image management tag. This will be populated only for machines belonging to Instant Clone farms created using image catalog.
The persistent disk(s) attached to this machine.
The Horizon Storage Accelerator state. Storage acceleration will be available for managed machines if configured.
Supported Filters : 'Equals'. This property can be used for sorting.
- CURRENT: The machine cached data is updated.
- ERROR: The Storage Accelerator has encountered an error.
- OFF: The Storage Accelerator is off.
- OUT_OF_DATE: The machine cached data is not updated and requires regeneration.
The ID of the Virtual Center managing this machine.
Supported Filters : 'Equals'.
The virtual machine power state.
Supported Filters : 'Equals'. This property can be used for sorting.
- POWERED_OFF: The machine is powered off.
- POWERED_ON: The machine is powered on.
- SUSPENDED: The machine is suspended.
The moid of managed machine.
Supported Filters: 'Equals'.
Message Client specification
{
"client_type": "EDGE",
"client_uuid": "6414a63f-694a-4982-b670-f564af076986",
"pem_certificate": "-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"
}
The message client type, which should be a member of MessageClientType.
- EDGE: EDGE Gateway user.
- CSMS: CSMS user.
The message client uuid, which is generated by client itself.
The message client certificate in PEM format. PemCertificate should be valid and its subject should be CN=clientType/clientUuid,
Information about message client.
{
"client_type": "EDGE",
"id": "EDGE-665b09dd-92cc-4da5-8521-1c9a4361493b",
"marked_for_delete": true
}
The message client type, which should be a member of MessageClientType.
- EDGE: EDGE Gateway user.
- CSMS: CSMS user.
Unique ID representing the message client.
Indicates whether the message client is triggered for deletion.
Health information about message client.
{
"client_type": "EDGE",
"id": "EDGE-665b09dd-92cc-4da5-8521-1c9a4361493b",
"last_disconnect_timestamp": 1582029025748,
"message_client_status": "CONNECTED"
}
The message client type.
- EDGE: EDGE Gateway user.
- CSMS: CSMS user.
Unique ID representing the message client.
The timestamp in milliseconds when the message client was last seen. Measured as epoch time.
The message client status.
- CONNECTED: Connected.
- DISCONNECTED: Disconnected.
- REGISTERED: Registered.
Message client object to be updated.
{
"pem_certificate": "-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n"
}
The message client certificate in PEM format. PemCertificate should be valid and its subject should be CN=clientType/clientUuid,
Information about name availability of an inventory resource.
{
"available": "boolean"
}
Indicates whether name is available for resource creation.
Name Availability Spec.
{
"name": "string"
}
Name of the inventory resource to be checked for availability.
Manually defined virtual machines and users.
{
"machine_name": "Machine-002-jdoe",
"user_name": "abcorp.com\\jdoe"
}
The virtual machine name.
The name of the user entitled to the VM, used only in case of persistent desktop pools.
Information related to network interface card.
{
"id": "74390016-2dea-4b8c-8181-385783effaeb",
"mac_address": "00:50:56:a6:62:ac",
"name": "Network adapter 1"
}
Unique ID representing the network interface card.
Network interface card MAC address.
Network interface card name.
Information related to network interface card.
{
"id": "74390016-2dea-4b8c-8181-385783effaeb",
"mac_address": "00:50:56:a6:62:ac",
"name": "Network adapter 1",
"network_type": "OPAQUE_NETWORK"
}
Unique ID representing the network interface card.
Network interface card MAC address.
Network interface card name.
Type of network interface card.
- NETWORK: Standard network.
- OPAQUE_NETWORK: Opaque network.
- DISTRUBUTED_VIRTUAL_PORT_GROUP: DVS Port group.
Specification for an individual network label assignment, stipulating the label and how many times it may be assigned to machines with this spec.
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
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.
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.
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.
- UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.
- LIMITED: The network label assignment specification has a limited number of labels to assign.
The network label id for this spec. This network label must not have any incompatibility reasons that would preclude it from automatic machine assignment.
Network label assignment settings for the farm.
{
"enabled": true,
"max_label": 1,
"max_label_type": "LIMITED",
"network_label_name": "vm-network"
}
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.
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.
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.
- UNLIMITED: The network label assignment specification has no limit on the number of labels to assign.
- LIMITED: The network label assignment specification has a limited number of labels to assign.
The network label id for this spec. This network label must not have any incompatibility reasons that would preclude it from automatic machine assignment.
Information related to a network label.
{
"network_label_name": "example-network",
"nic_name": "network1"
}
The network label name.
The network interface name
Information related to network label.
{
"available_ports": "integer",
"id": "network-1",
"incompatible_reasons": [
"string"
],
"label_type": "EARLY_BINDING",
"max_ports": "integer",
"name": "VM Network",
"switch_type": "STANDARD_SWITCH"
}
Available ports in network label.
Unique ID representing the network label.
Reasons that may preclude this Network Label from being used in desktoppool/farm configuration.
Network label type.
- 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.
- 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.
- 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.
The total number of ports present.
Network label name.
Network label switch type.
- STANDARD_SWITCH: Standard Switch.
- DISTRIBUTED_VIRTUAL_SWITCH: Distributed Virtual Switch.
- NSX_NETWORK_SWITCH: NSX network Switch.
Information related to PCoIP Performance Data.
{
"audio_bytes_received": 1652079610000,
"audio_bytes_sent": 1652079610000,
"audio_rx_bandwidth": 1652079610000,
"audio_tx_bandwidth": 1652079610000,
"audio_tx_bandwidth_limit": 1652079610000,
"general_bytes_received": 3872079619320,
"general_bytes_sent": 1652079610000,
"general_duration_seconds": 1652079610000,
"general_packets_received": 1652079610000,
"general_packets_sent": 1652079610000,
"general_rx_packets_lost": 1652079610000,
"general_tx_packets_lost": 1652079610000,
"imaging_active_minimum_quality": 1652079610000,
"imaging_apex2800_offload": 1652079610000,
"imaging_bytes_received": 1652079610000,
"imaging_bytes_sent": 3872079619320,
"imaging_decoder_capability": 1652079610000,
"imaging_encoded_frames": 1652079610000,
"imaging_megapixel": 1652079610000,
"imaging_negative_acknowledgements": 1652079610000,
"imaging_rx_bandwidth": 1652079610000,
"imaging_svga_dev_tap_frames": 1652079610000,
"imaging_tx_bandwidth": 1652079610000,
"network_round_trip_latency": 1652079610000,
"network_rx_bandwidth": 1652079610000,
"network_rx_bandwidth_peak": 1652079610000,
"network_rx_packet_loss": 1652079610000,
"network_tx_bandwidth": 1652079610000,
"network_tx_bandwidth_active_limit": 1652079610000,
"network_tx_bandwidth_limit": 3872079619320,
"network_tx_packet_loss": 1652079610000,
"usb_bytes_received": 1652079610000,
"usb_bytes_sent": 1652079610000,
"usb_rx_bandwidth": 1652079610000,
"usb_tx_bandwidth": 1652079610000
}
Total number of bytes of audio data that have been received since the PCoIP session started.
Total number of bytes of audio data that have been sent since the PCoIP session started.
Bandwidth for incoming audio packets averaged over the sampling period, in kilobits per second.
Bandwidth for outgoing audio packets averaged over the sampling period, in kilobits per second.
Transmission bandwidth limit in kilobits per second for outgoing audio packets. The limit is defined by a GPO setting.
Total number of bytes of PCoIP data that have been received since the PCoIP session started.
Total number of bytes of PCoIP data that have been transmitted since the PCoIP session started.
Total number of seconds that the PCoIP session has been open.
Total number of packets that have been received successfully since the PCoIP session started. Not all packets are the same size.
Total number of packets that have been sent since the PCoIP session started. Not all packets are the same size.
Total number of received packets that have been lost since the PCoIP session started.
Total number of transmitted packets that have been lost since the PCoIP session started.
Lowest encoded quality value on a scale from 0 to 100. This statistic is updated once per second. This counter does not correspond to the GPO setting for minimum quality.
The number of times Apex2800 offloading is utilized over a one-second sampling period.
Total number of bytes of audio data that have been received since the PCoIP session started.
Total number of bytes of audio data that have been sent since the PCoIP session started.
Estimated processing capability of the imaging decoder in kilobits per second. This statistic is updated once per second.
Number of imaging frames that were encoded over a one-second sampling period..
Number of megapixel that were rendered over a one-second sampling period.
Number of negative acknowledgements for incoming packets.
Bandwidth for incoming audio packets averaged over the sampling period, in kilobits per second.
Number of frames that were processed in SVGA devtap over one-second sampling.
Bandwidth for outgoing audio packets averaged over the sampling period, in kilobits per second.
Round trip latency in milliseconds between the PCoIP server and the PCoIP client.
Overall bandwidth for incoming PCoIP packets averaged over the sampling period, in kilobits per second.
Peak bandwidth in kilobits per second for incoming PCoIP packets over a one-second sampling period.
Percentage of incoming packets lost during a sampling period.
Overall bandwidth for outgoing PCoIP packets averaged over the sampling period, in kilobits per second.
Estimated available network bandwidth in kilobits per second. This statistic is updated once per second.
Transmission bandwidth limit in kilobits per second for outgoing packets. The limit is the minimum of the following values.
- GPO bandwidth limit for the PCoIP client.
- GPO bandwidth limit for the PCoIP server.
- Bandwidth limit for the local network connection.
- Negotiated bandwidth limit for the Zero Client firmware based on encryption limits.
Percentage of transmitted packets lost during a sampling period.
Total number of bytes of USB data that have been received since the PCoIP session started.
Total number of bytes of USB data that have been sent since the PCoIP session started.
Bandwidth for incoming USB packets averaged over the sampling period, in kilobits per second.
Bandwidth for outgoing USB packets averaged over the sampling period, in kilobits per second.
Information about permission.
{
"ad_user_or_group_id": "S-1-5-21-1042673909-920613684-1833544874-512",
"federation_access_group_id": "f4c5d06e-791c-4ef8-af6f-1b95955e24df",
"local_access_group_id": "b59b3791-88de-42ed-a61a-561b7fd267ab",
"role_id": "9b50589d-818f-40c2-9ced-161d0f1d67dd"
}
The AD User or Group SID for this permission.
The federation access group ID for this permission.
The local access group ID for this permission.
Role ID for this permission.
Information about permission.
{
"ad_user_or_group_id": "S-1-5-21-1042673909-920613684-1833544874-512",
"federation_access_group_id": "f4c5d06e-791c-4ef8-af6f-1b95955e24df",
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"local_access_group_id": "b59b3791-88de-42ed-a61a-561b7fd267ab",
"role_id": "9b50589d-818f-40c2-9ced-161d0f1d67dd"
}
The AD User or Group SID for this permission.
The federation access group ID for this permission.
Unique ID representing this permission.
The local access group ID for this permission.
Role ID for this permission.
Information about permission.
{
"ad_user_or_group_id": "S-1-5-21-1042673909-920613684-1833544874-512",
"display_name": "example.com\\\\testuser",
"federation_access_group_id": "f4c5d06e-791c-4ef8-af6f-1b95955e24df",
"group": "boolean",
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"local_access_group_id": "b59b3791-88de-42ed-a61a-561b7fd267ab",
"role_id": "9b50589d-818f-40c2-9ced-161d0f1d67dd"
}
The AD User or Group SID for this permission.
Login name with domain of user or group having this permission.
The federation access group ID for this permission.
Indicates if ad user or group having this permission represents a group.
Unique ID representing this permission.
The local access group ID for this permission.
Role ID for this permission.
Persistent disk object to be created.
{
"access_group_id": "73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d",
"datastore_id": "datastore-33",
"user_id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"vcenter_id": "b32e941f-f272-4a4b-9d78-21b4602ed33f",
"virtual_disk_id": "7c31387f-9d3b-45e7-9035-00b05769626f"
}
ID of the access group to be associated with the persistent disk.
ID of the datastore containing the virtual disk.
SID of the user to own the persistent disk.
ID of the vCenter server containing the virtual disk.
ID of the virtual disk from which the persistent disk is to be created.
Persistent disk 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.
{
"access_group_id": "73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d",
"capacity_mb": 2048,
"datastore_id": "datastore-33",
"datastore_name": "Datastore1",
"desktop_pool_id": "ce910882-e6ef-447a-a88b-333abe0c9c8a",
"desktop_pool_name": "sales-pool1",
"id": "c1d5aec7-2126-3c55-aefa-11949003c9c2",
"last_attached_time": 1621512686000,
"machine_id": "0f9f20be-4fa5-47dc-bcf2-f4fb555c51d2",
"machine_name": "machine1",
"name": "virtual-disk.vmdk",
"status": "IN_USE",
"usage": "PRIMARY",
"user_id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"user_name": "testuser",
"vcenter_id": "b32e941f-f272-4a4b-9d78-21b4602ed33f"
}
ID of the access group of the persistent disk.
Supported Filters: 'Equals'.
Capacity of the persistent disk in MB. This property can be used for sorting.
ID of the datastore containing the persistent disk.
Supported Filters: 'Equals'.
Name of the datastore containing the persistent disk.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of the desktop pool associated with the persistent disk.
Supported Filters: 'Equals'.
Name of the desktop pool associated with the persistent disk.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Unique identifier for this persistent disk.
Supported Filters: 'Equals'.
If the persistent disk is detached, indicates when it was last attached to a machine or created from a virtual disk. This property can be used for sorting.
ID of the machine the persistent disk is attached to.
Supported Filters: 'Equals'.
Name of the machine the persistent disk is attached to.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Name of the persistent disk.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Status of the persistent disk.
Supported Filters: 'Equals'. This property can be used for sorting.
- ARCHIVING: The persistent disk is being archived.
- ATTACHING: The persistent disk is attaching to a virtual machine.
- DELETING: The persistent disk is being deleted.
- DETACHING: The persistent disk is being detached from a virtual machine.
- IN_USE: This persistent disk is in use.
- REPLACING: The persistent disk is being replaced.
- UNATTACHED: The persistent disk is not in use and available to attach to a virtual machine.
Usage of the persistent disk.
Supported Filters: 'Equals'. This property can be used for sorting.
- DELETING: This data disk is in the process of being deleted or archived.
- PRIMARY: This data disk is attached to a Virtual Machine and the user profile is redirected to it.
- SECONDARY: This data disk is attached to a Virtual Machine.
- UNATTACHED: This data disk is not attached to a Virtual Machine.
SID of the user owning the persistent disk.
Supported Filters: 'Equals'.
Name of the user owning the persistent disk.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of the vCenter server containing the persistent disk.
Supported Filters: 'Equals'.
Information about machine which can be attached to persistent disk.
Supported Filters : 'And', 'Or', 'Equals', 'NotEquals', 'StartsWith' and 'Contains'.
See the field description to know the filter types it supports.
{
"desktop_pool_id": "ce910882-e6ef-447a-a88b-333abe0c9c8a",
"desktop_pool_name": "pool-1",
"incompatible_reason": "string",
"machine_id": "0f9f20be-4fa5-47dc-bcf2-f4fb555c51d2",
"machine_name": "machine-1",
"user_id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"user_name": "user-1"
}
ID of the desktop pool of the machine.
Supported Filters : 'Equals'.
Name of the desktop pool.
Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Incompatible reason for attaching machine to persistent disk.
- PERSISTENT_DISK_MACHINE_VC_MISMATCH: Virtual centers of persistent disk and machine do not match.
- PERSISTENT_DISK_MACHINE_VSAN_MISMATCH: vSAN policies of persistent disk and machine do not match.
- PERSISTENT_DISK_DATASTORE_INACCESSIBLE_TO_MACHINE: Datastore of persistent disk is inaccessible to machine.
ID of the machine which may be attached to persistent disk.
Supported Filters : 'Equals'.
Name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
SID of the user the machine is assigned to.
Supported Filters : 'Equals'.
Name of the user.
Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Persistent disk object to be updated.
{
"access_group_id": "73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d",
"user_id": "S-1-5-21-1111111111-2222222222-3333333333-500"
}
ID of the access group to be associated with the persistent disk.
SID of the user to own the persistent disk.
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.
{
"description": "This is a physical machine.",
"dns_name": "machine1.example.com",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"message_security_enhanced_mode_supported": true,
"message_security_mode": "MIXED",
"name": "machine1",
"operating_system": "WINDOWS_SERVER_2016",
"state": "AVAILABLE"
}
Description of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
Unique ID representing machine.
Supported Filters : 'Equals'.
Indicates whether ENHANCED message security mode is currently supported by this machine. This property can be used for sorting.
The current JMS message security mode used by this machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The machine operating system. This property can be used for sorting.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
The state of the machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.
- AGENT_ERROR_DISABLED: Horizon Agent is disabled.
- AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.
- AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.
- AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.
- AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.
- AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.
- AVAILABLE: The machine is powered on and ready for active connections.
- CONNECTED: The machine is in an active session and has an active connection to a Horizon client.
- DISABLED: The machine is disabled.
- DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.
- UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.
- UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.
- UNKNOWN: Could not determine the state of the machine.
- VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.
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.
{
"description": "This is a physical machine.",
"dns_name": "machine1.example.com",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"message_security_enhanced_mode_supported": true,
"message_security_mode": "MIXED",
"name": "machine1",
"operating_system": "WINDOWS_SERVER_2016",
"rds_server": true,
"state": "AVAILABLE"
}
Description of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
Unique ID representing machine.
Supported Filters : 'Equals'.
Indicates whether ENHANCED message security mode is currently supported by this machine. This property can be used for sorting.
The current JMS message security mode used by this machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The machine operating system. This property can be used for sorting.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
Indicates if the physical machine is RDS Server.
Supported Filters : 'Equals'. This property can be used for sorting.
The state of the machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- AGENT_CONFIG_ERROR: The Remote Desktop Services role is not enabled on the windows server.
- AGENT_ERROR_DISABLED: Horizon Agent is disabled.
- AGENT_ERROR_INVALID_IP: Horizon Agent has an invalid IP address.
- AGENT_ERROR_NEEDS_REBOOT: Horizon Agent needs reboot.
- AGENT_ERROR_PROTOCOL_FAILURE: Protocol such as BLAST, RDP or PCoIP is not enabled.
- AGENT_ERROR_STARTUP_IN_PROGRESS: Horizon Agent has started on the machine, but other required services such as the display protocol are still starting.
- AGENT_UNREACHABLE: Horizon Connection Server cannot establish communication with Horizon Agent on the machine.
- AVAILABLE: The machine is powered on and ready for active connections.
- CONNECTED: The machine is in an active session and has an active connection to a Horizon client.
- DISABLED: The machine is disabled.
- DISCONNECTED: The machine is in an active session, but it is disconnected from the Horizon client.
- UNASSIGNED_USER_CONNECTED: A user other than the assigned user is logged in to the machine in a dedicated desktop pool.
- UNASSIGNED_USER_DISCONNECTED: A user other than the assigned user is logged in and disconnected from the machine in a dedicated desktop pool.
- UNKNOWN: Could not determine the state of the machine.
- VALIDATING: The Horizon Connection Server is synchronizing state information with the agent.
Physical machine register response.
{
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"pairing_token": "<agent.pairing.token>"
}
Unique ID representing the physical machine.
The pairing token for the physical machine.
The specification for registering the physical machine.
{
"description": "Newly added physical machine",
"dns_name": "machine1.example.com",
"operating_system": "WINDOWS_10"
}
An optional string to describe how and why this physical machine was registered.
The DNS name for the physical machine.
The Operating System of the physical machine.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
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.
{
"global_application_entitlement_id": "e285ebe1-194b-4563-80e0-0ad21134c503",
"global_desktop_entitlement_id": "7493bfc7-834a-4d9b-ac7d-b5f60893a3a6",
"id": "28deeb70-97d5-409e-abb4-497196f1ee18",
"pod_id": "32a5ea06-cd09-4609-b3e5-df8379e99c13",
"user_id": "S-1-1-1-3965912346-1012345398-3123456564-123"
}
ID of the Global Application Entitlement associated with this pod assignment.
Supported Filters: 'Equals'.
ID of the Global Desktop Entitlement associated with this pod assignment.
Supported Filters: 'Equals'.
Unique ID representing this pod assignment.
Supported Filters: 'Equals'.
ID representing the pod associated with this pod assignment.
Supported Filters: 'Equals'.
SID of the user associated with this pod assignment.
Supported Filters: 'Equals'.
The list of pod endpoints within this pod. An endpoint is basically a connection server in that pod.
{
"enabled": true,
"id": "c5337d77-2bf1-4fa4-b027-c301114f2d1e",
"name": "connection-server1.example.com",
"roundtrip_time": 1234,
"status": "ONLINE",
"url": "https://connection-server1.example.com:8742"
}
Indicates whether an endpoint is enabled. A disabled endpoint will be excluded from participating inter-pod communication.
Unique ID for a pod endpoint.
Name for the pod endpoint.
Round trip time (in milliseconds) for ping request between the local pod endpoint and the remote pod.
Status of the pod endpoint.
- ONLINE: Pod endpoint is online and functional.
- UNCHECKED: Pod endpoint was offline and it just came back online but the system has not verified that it is functional.
- OFFLINE: Pod endpoint is offline or unreachable.
The URL for the pod endpoint. This address and special port will be used for inter-pod communication.
The list of pod endpoints within this pod. An endpoint is basically a connection server in that pod.
{
"enabled": true,
"id": "c5337d77-2bf1-4fa4-b027-c301114f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "connection-server1.example.com",
"roundtrip_time": 1234,
"status": "ONLINE",
"url": "https://connection-server1.example.com:8742"
}
Indicates whether an endpoint is enabled. A disabled endpoint will be excluded from participating inter-pod communication.
Unique ID for a pod endpoint.
The timestamp in milliseconds when the last update was obtained. Measured as epoch time.
Name for the pod endpoint.
Round trip time (in milliseconds) for ping request between the local pod endpoint and the remote pod.
Status of the pod endpoint.
- ONLINE: Pod endpoint is online and functional.
- UNCHECKED: Pod endpoint was offline and it just came back online but the system has not verified that it is functional.
- OFFLINE: Pod endpoint is offline or unreachable.
The URL for the pod endpoint. This address and special port will be used for inter-pod communication.
Information related to pod endpoint.
{
"enabled": true,
"id": "48dreb70-97g6-405e-abb5-497136g2ee35",
"name": "Horizon Connection Server",
"server_address": "https://horizon-CS.xyz.local:8472"
}
Indicates whether an endpoint is enabled. A disabled endpoint is excluded from participating in inter-pod communication.
Unique ID representing this pod endpoint.
Name of the pod endpoint.
The URL for the pod endpoint. This address and port is used for inter-pod communication.
Information related to Pod Federation.
{
"connection_server_statuses": [
{
"id": "c617fd51-e118-4cae-970c-54a7144aaadc",
"message": "OK",
"message_code": "LMV_OP_OK",
"name": "CS1",
"pending_percentage": 80,
"status": "ENABLED"
}
],
"guid": "97b8c51e-2e30-47f8-8c3c-3b2d3ec1a2a7",
"local_connection_server_status": "ENABLED",
"name": "Horizon Cloud Pod Federation",
"sites": [
"c617fd51-e118-4cae-970c-54a7144aaadc",
"bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"
]
}
Individual connection server CPA status for this pod.
GUID representing the pod federation.
CPA status of the current connection server in the pod.
- ENABLED: CPA is enabled.
- DISABLED: CPA is disabled.
- PENDING: CPA is undergoing an operation related to initialization, uninitialization, joining, or unjoining.
- 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.
- DISABLE_ERROR: The connection server has failed to reach the DISABLED status in a timely manner.
Name of the pod federation.
Member sites in the pod federation.
Information related to pods in a pod federation.
{
"active_global_application_entitlements": [
"01c42e80-d31e-4633-93c6-44ff8a5b1afe",
"86ba95e0-9d59-4b1f-934e-2deba13fcecb"
],
"active_global_desktop_entitlements": [
"648d8fc5-94e5-438f-8524-8edb533c7de2",
"50075a5b-6a68-4be5-b079-cff355945856"
],
"cloud_managed": true,
"description": "Pod Description.",
"endpoints": [
"716269b7-e43d-4874-877a-c5af36a11322",
"d56671b5-42a6-490e-ab40-8373f839f2d3"
],
"id": "28deeb70-97d5-409e-abb4-497196f1ee18",
"local_pod": true,
"name": "Cluster-CS-1",
"site_id": "9a892821-8c3d-4e61-9d65-69dfec7b70dc"
}
List of Global Application Entitlements with mappings to application pools within this pod.
List of Global Desktop Entitlements with mappings to desktop pools within this pod.
Indicates whether this pod is managed from cloud.
Description of this pod.
List of endpoints within this pod.
Unique ID representing this pod.
Indicates whether this is the local pod the request was made from.
Only one pod in the pod federation will return true.
Name of this pod.
ID of the site this pod belongs to.
Monitoring information related to a pod.
{
"endpoints": [
{
"enabled": true,
"id": "c5337d77-2bf1-4fa4-b027-c301114f2d1e",
"name": "connection-server1.example.com",
"roundtrip_time": 1234,
"status": "ONLINE",
"url": "https://connection-server1.example.com:8742"
}
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"name": "Cluster-SITE1-POD1",
"site_id": "a5882e23-3bf4-1ba6-c128-e780004f2d1e"
}
The list of pod endpoints within this pod. An endpoint is basically a connection server in that pod.
Unique ID of the pod.
Display name for the pod.
The Id of the site this pod belongs to.
Monitoring information related to a pod.
{
"endpoints": [
{
"enabled": true,
"id": "c5337d77-2bf1-4fa4-b027-c301114f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "connection-server1.example.com",
"roundtrip_time": 1234,
"status": "ONLINE",
"url": "https://connection-server1.example.com:8742"
}
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"name": "Cluster-SITE1-POD1",
"site_id": "a5882e23-3bf4-1ba6-c128-e780004f2d1e"
}
The list of pod endpoints within this pod. An endpoint is basically a connection server in that pod.
Unique ID of the pod.
Display name for the pod.
The Id of the site this pod belongs to.
Metrics related to Pod Session. This considers the sessions launched using Desktop or Application that are part of Global Entitlement and Global Application Entitlement.
{
"local_pod": true,
"num_brokered_sessions": 6,
"num_hosted_sessions": 4,
"pod_id": "fd69e42f-9812-4bf2-b000-84e92882616d",
"pod_name": "test_pod"
}
Indicates if the counter details belong to the local POD. This is going to be true for only one POD in the Federation.
Total number of brokered global sessions.
- This value will not be set for pods running on an older version(before 7.12.0).
Total number of hosted global sessions.
- This value will not be set if there is atleast one pod in federation which is running on an older version(before 7.12.0).
Pod id.
Name of the pod.
Pod object to be updated.
{
"cloud_managed": true,
"description": "Pod Description.",
"name": "Cluster-CS-1",
"site_id": "9a892821-8c3d-4e61-9d65-69dfec7b70dc"
}
Indicates whether this pod is managed from cloud. Default value is false.
Description of this pod.
Name of this pod.
ID of the site this pod belongs to.
Information related to Policies settings.
{
"allow_multimedia_redirection": "ALLOW",
"allow_pcoip_hardware_acceleration": "ALLOW",
"allow_remote_mode": "ALLOW",
"allow_usb_access": "ALLOW",
"pcoip_hardware_acceleration_priority": "MEDIUM"
}
Determines whether MMR (Multimedia Redirection, a Microsoft DirectShow filter) is enabled for client systems. Default value is DENY.
- ALLOW: This policy option is set to allow.
- DENY: This policy option is set to deny.
- INHERIT: This policy option will be inherited from the parent.
Determines whether to enable hardware acceleration of the PCoIP display protocol. Default value is ALLOW. If the property is set, pcoip_hardware_acceleration_priority must be set. This setting has an effect only if a PCoIP hardware acceleration device is present on the physical computer that hosts the machine.
- ALLOW: This policy option is set to allow.
- DENY: This policy option is set to deny.
- INHERIT: This policy option will be inherited from the parent.
Determines whether users can connect to and use machines running on vCenter Server instances. If set to deny, machines must be used in local mode.
- ALLOW: This policy option is set to allow.
- DENY: This policy option is set to deny.
- INHERIT: This policy option will be inherited from the parent.
Determines whether machines can use USB devices connected to the client system. Default value is ALLOW.
- ALLOW: This policy option is set to allow.
- DENY: This policy option is set to deny.
- INHERIT: This policy option will be inherited from the parent.
Determines priority for hardware acceleration. This property is ignored, if allow_pcoip_hardware_acceleration is not set to ALLOW. Default value is MEDIUM priority.
- LOWEST: PCOIP Hardware acceleration priority is lowest possible.
- LOWER: PCOIP Hardware acceleration priority is lower.
- MEDIUM: PCOIP Hardware acceleration priority is medium. Default.
- HIGHER: PCOIP Hardware acceleration priority is higher.
- HIGHEST: PCOIP Hardware acceleration priority is highest.
Policies Settings to be updated.
{
"allow_multimedia_redirection": "ALLOW",
"allow_pcoip_hardware_acceleration": "ALLOW",
"allow_remote_mode": "ALLOW",
"allow_usb_access": "ALLOW",
"pcoip_hardware_acceleration_priority": "MEDIUM"
}
Determines whether MMR (Multimedia Redirection, a Microsoft DirectShow filter) is enabled for client systems.
- ALLOW: This policy option is set to allow.
- DENY: This policy option is set to deny.
- INHERIT: This policy option will be inherited from the parent.
Determines whether to enable hardware acceleration of the PCoIP display protocol. Default value is ALLOW. If the property is set, pcoip_hardware_acceleration_priority must be set. This setting has an effect only if a PCoIP hardware acceleration device is present on the physical computer that hosts the machine.
- ALLOW: This policy option is set to allow.
- DENY: This policy option is set to deny.
- INHERIT: This policy option will be inherited from the parent.
Determines whether users can connect to and use machines running on vCenter Server instances. If set to deny, machines must be used in local mode.
- ALLOW: This policy option is set to allow.
- DENY: This policy option is set to deny.
- INHERIT: This policy option will be inherited from the parent.
Determines whether machines can use USB devices connected to the client system.
- ALLOW: This policy option is set to allow.
- DENY: This policy option is set to deny.
- INHERIT: This policy option will be inherited from the parent.
Determines priority for hardware acceleration. This property is ignored, if allow_pcoip_hardware_acceleration is not set to ALLOW. Default value is MEDIUM priority.
- LOWEST: PCOIP Hardware acceleration priority is lowest possible.
- LOWER: PCOIP Hardware acceleration priority is lower.
- MEDIUM: PCOIP Hardware acceleration priority is medium. Default.
- HIGHER: PCOIP Hardware acceleration priority is higher.
- HIGHEST: PCOIP Hardware acceleration priority is highest.
Information related to Pre Logon Settings.
{
"api_session_timeout_minutes": 30,
"console_session_timeout_minutes": 30,
"display_pre_login_admin_banner": "boolean",
"enable_user_name_caching": true,
"pre_login_admin_banner_header": "Attention",
"pre_login_admin_banner_message": "Attention"
}
Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out.
Determines how long an idle admin console session continues before the session times out.
Enable/disable pre login message pop up before logging into Horizon admin console
UI Client provide 'remember me' option when this is set to true
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.
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.
Information about privileges.
{
"name": "FEDERATED_LDAP_MANAGE",
"sub_privileges": [
"FEDERATED_LDAP_VIEW",
"POOL_VIEW",
"MACHINE_VIEW"
]
}
Name of the privilege.
- ADMINISTRATOR: Full administrator privilege, including Multi-Datacenter View configuration. This is a non-selectable privilege.
- ADMINISTRATOR_VIEW: Full read only administrator privilege, including Multi-Datacenter View configuration. This is a non-selectable privilege.
- VC_CONFIG_VIEW: Manage vCenter Configuration (Read Only).
- LOG_COLLECTION: Collect Operation Logs.
- FORENSICS: Manage Forensics Operations.
- MANAGE_CERTIFICATES: Manage Certificates.
- LOCAL_ADMINISTRATOR: Full administrator privilege, except to Multi-Datacenter View configuration and to manage roles and privileges. This is a non-selectable privilege.
- LOCAL_ADMINISTRATOR_VIEW: Full read only administrator privilege, except to Multi-Datacenter View configuration. This is a non-selectable privilege.
- INVENTORY_ADMINISTRATOR: Access to all inventory objects. This is a non-selectable privilege.
- INVENTORY_ADMINISTRATOR_VIEW: Read only access to all inventory objects. This is a non-selectable privilege.
- HELPDESK_ADMINISTRATOR: Manage Help Desk. This is a non-selectable privilege.
- HELPDESK_ADMINISTRATOR_VIEW: Manage Help Desk (Read only).
- FEDERATED_LDAP_MANAGE: Manage Pod Federation.
- FEDERATED_LDAP_VIEW: Manage Global LDAP (Read only). This is a non-selectable privilege.
- FEDERATED_SESSIONS_MANAGE: Manage Federated Sessions.
- FEDERATED_SESSIONS_VIEW: Manage Federated Sessions (Read only). This is a non-selectable privilege.
- GLOBAL_ADMINISTRATOR: Manage Global Configuration. This is a non-selectable privilege.
- GLOBAL_ADMINISTRATOR_VIEW: Manage Global Configuration (Read only). This is a non-selectable privilege.
- GLOBAL_ADMIN_UI_INTERACTIVE: Can log into View Administrator. This is a non-selectable privilege.
- GLOBAL_ADMIN_SDK_INTERACTIVE: Can run all command line utilities and PowerShell commands. This is a non-selectable privilege.
- GLOBAL_MACHINE_REGISTER: Register non-vCenter machine sources such as Windows Terminal Servers and physical PCs.
- GLOBAL_ROLE_PERMISSION_MANAGEMENT: Add, modify, and delete administrator roles and permissions.
- GLOBAL_ROLE_MANAGEMENT: Add, modify, and delete administrator roles. This is a non-selectable privilege.
- GLOBAL_ROLE_VIEW: Read only access to administrator roles. This is a non-selectable privilege.
- GLOBAL_PERMISSION_VIEW: Read only access to administrator permissions. This is a non-selectable privilege.
- GLOBAL_PERMISSION_MANAGEMENT: Add, modify, and delete administrator permissions. This is a non-selectable privilege.
- 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.
- GLOBAL_CONFIG_MANAGEMENT: View and change global (non-inventory) policy, configuration, and RDS server settings, except for administrator roles and permissions.
- FOLDER_MANAGEMENT: Add, modify, and delete access groups.
- FOLDER_VIEW: Read only access to access groups. This is a non-selectable privilege.
- POOL_VIEW: Read only access to desktop pools, farms, applications, their local sessions, and their machines. This is a non-selectable privilege.
- POOL_MANAGEMENT: Add, modify, and delete desktop pools, applications and farms. Add and remove machines from desktop pools.
- POOL_ENABLE: Enable and disable desktop pools, farms, and applications.
- POOL_ENTITLE: Add and remove desktop pool and application entitlements.
- POOL_SVI_IMAGE_MANAGEMENT: Schedule push image, schedule maintenance and change default image for desktop pool and farm.
- MACHINE_VIEW: Read only access to machines and their local sessions. This is a non-selectable privilege.
- MACHINE_MANAGEMENT: Perform all machine and session-related commands.
- MACHINE_REBOOT: Reset local machines.
- MACHINE_MANAGE_VDI_SESSION: Disconnect, logoff, and send messages to local sessions.
- MACHINE_MANAGE_OFFLINE_SESSION: Roll back offline sessions and initiate replications.
- MACHINE_USER_MANAGEMENT: Assign and un-assign users for machines, Update machine aliases for machines.
- MACHINE_MAINTENANCE: Put machine in and out of maintenance mode.
- MANAGE_REMOTE_PROCESS: Manage Remote Processes and Applications.
- REMOTE_ASSISTANCE: Remote Assistance to Remote desktop pool.
- GLOBAL_CVP_REGISTER: Global CVP Register. This is a non-selectable privilege.
- GLOBAL_CVP_PUBLICATION: Global CVP Publication. This is a non-selectable privilege.
- CVP_INTERACTIVE: CVP Interactive. This is a non-selectable privilege.
- CVP_VIEW: CVP View. This is a non-selectable privilege.
- CVP_MANAGEMENT: CVP Management.This is a non-selectable privilege.
- CVP_OWNERSHIP: CVP Ownership.This is a non-selectable privilege.
- API_SMART_CARD_BYPASS: Allows API's credential based login when smart card authentication mode is REQUIRED.
- UDD_VIEW: Read only access to persistent disks. This is a non-selectable privilege.
- UDD_MANAGEMENT: Manage persistent disks.
- HORIZON_CLOUD_SERVICE: Allows subscription license activation and cloud monitoring through horizon cloud service.
- SUBSCRIPTION_LICENSE_ADD: Allows subscription license activation.
- CLOUD_ADMIN: Allows Cloud Admin Authentication.
- UNKNOWN_PRIVILEGE: Unknown Privilege type. This is a non-selectable privilege.
List of sub-privileges.
Information about process performance.
{
"cpu": "number",
"create_time": 1687202598,
"disk": "number",
"memory": 1323008,
"name": "svchost.exe",
"process_id": 1636,
"user_name": "SYSTEM"
}
The cpu utilization.
The process creation time.
the disk utilization.
The memory utilization.
The name of the process
The process id.
The owner of the process.
RADIUS authenticator object to be created.
{
"description": "test radius auth ",
"label": "radius-auth-lablel",
"passcode_label": "test radius auth user passcode",
"radius_servers": [
{
"accounting_port": 1813,
"authentication_port": 1812,
"authentication_type": "PAP",
"hostname": "10.109.69.213",
"max_attempts": 5,
"primary_radius_server": true,
"realm_prefix": "test_realm_prefix",
"realm_suffix": "test_realm_suffix",
"server_timeout_seconds": 4,
"shared_secret": [
"<password>"
]
}
],
"user_name_label": "test radius auth user"
}
The description for this RADIUS authenticator.
The label for this RADIUS authenticator. It must be unique among all other RADIUS authenticators.
The label for the RADIUS authenticator passcode.
List of RADIUS servers. The list must have exactly one primary RADIUS server i.e. with primary_radius_server set to true.
The label for the RADIUS authenticator user name.
Information about to RADIUS Authenticator.
{
"description": "test radius auth ",
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"label": "radius-auth-lablel",
"passcode_label": "test radius auth user passcode",
"radius_servers": [
{
"accounting_port": 1813,
"authentication_port": 1812,
"authentication_type": "PAP",
"hostname": "10.109.69.213",
"max_attempts": 5,
"primary_radius_server": true,
"realm_prefix": "test_realm_prefix",
"realm_suffix": "test_realm_suffix",
"server_timeout_seconds": 4
}
],
"user_name_label": "test radius auth user"
}
The description for this RADIUS authenticator.
Unique ID representing this RADIUS Authenticator.
The label for this RADIUS authenticator.
The label for the RADIUS authenticator passcode.
The label for the RADIUS authenticator user name.
RADIUS authenticator object to be updated.
{
"description": "test radius auth ",
"label": "radius-auth-lablel",
"passcode_label": "test radius auth user passcode",
"radius_servers": [
{
"accounting_port": 1813,
"authentication_port": 1812,
"authentication_type": "PAP",
"hostname": "10.109.69.213",
"max_attempts": 5,
"primary_radius_server": true,
"realm_prefix": "test_realm_prefix",
"realm_suffix": "test_realm_suffix",
"server_timeout_seconds": 4,
"shared_secret": [
"<password>"
]
}
],
"user_name_label": "test radius auth user"
}
The description for this RADIUS authenticator.
The label for this RADIUS authenticator. It must be unique among all other RADIUS authenticators.
The label for the RADIUS authenticator passcode.
List of RADIUS servers. The list must have exactly one primary RADIUS server i.e. with primary_radius_server set to true.
The label for the RADIUS authenticator user name.
Information required to create a RADIUS authentication server.
{
"accounting_port": 1813,
"authentication_port": 1812,
"authentication_type": "PAP",
"hostname": "10.109.69.213",
"max_attempts": 5,
"primary_radius_server": true,
"realm_prefix": "test_realm_prefix",
"realm_suffix": "test_realm_suffix",
"server_timeout_seconds": 4,
"shared_secret": [
"<password>"
]
}
The accounting port of the RADIUS authentication server.
The authentication port of the RADIUS authentication server. Radius servers should not have both hostname and authentication port same.
The authentication type of the RADIUS authentication server.
- PAP: Password authentication protocol.
- CHAP: Challenge-handshake authentication protocol.
- MSCHAP1: Microsoft challenge-handshake authentication protocol, version 1.
- MSCHAP2: Microsoft challenge-handshake authentication protocol, version 2.
- UNKNOWN: Indicates Auth type is unkonwn.
The hostname of the RADIUS authentication server. Radius servers should not have both hostname and authentication port same.
The maximum number of authentication attempts for the RADIUS authentication server.
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.
The realm prefix of the RADIUS authentication server.
The realm suffix of the RADIUS authentication server.
The server timeout (in seconds) of the RADIUS authentication server.
The shared secret of the RADIUS authentication server.
Information related to a RADIUS authentication server.
{
"accounting_port": 1813,
"authentication_port": 1812,
"authentication_type": "PAP",
"hostname": "10.109.69.213",
"max_attempts": 5,
"primary_radius_server": true,
"realm_prefix": "test_realm_prefix",
"realm_suffix": "test_realm_suffix",
"server_timeout_seconds": 4
}
The accounting port of the RADIUS authentication server.
The authentication port of the RADIUS authentication server.
The authentication type of the RADIUS authentication server.
- PAP: Password authentication protocol.
- CHAP: Challenge-handshake authentication protocol.
- MSCHAP1: Microsoft challenge-handshake authentication protocol, version 1.
- MSCHAP2: Microsoft challenge-handshake authentication protocol, version 2.
- UNKNOWN: Indicates Auth type is unkonwn.
The hostname of the RADIUS authentication server.
The maximum number of authentication attempts for the RADIUS authentication server.
Indicates whether it is a primary RADIUS authentication server.
The realm prefix of the RADIUS authentication server.
The realm suffix of the RADIUS authentication server.
The server timeout (in seconds) of the RADIUS authentication server.
Information required to create a RADIUS authentication server.
{
"accounting_port": 1813,
"authentication_port": 1812,
"authentication_type": "PAP",
"hostname": "10.109.69.213",
"max_attempts": 5,
"primary_radius_server": true,
"realm_prefix": "test_realm_prefix",
"realm_suffix": "test_realm_suffix",
"server_timeout_seconds": 4,
"shared_secret": [
"<password>"
]
}
The accounting port of the RADIUS authentication server.
The authentication port of the RADIUS authentication server. Primary and secondary servers should not have both hostname and authentication port same.
The authentication type of the RADIUS authentication server.
- PAP: Password authentication protocol.
- CHAP: Challenge-handshake authentication protocol.
- MSCHAP1: Microsoft challenge-handshake authentication protocol, version 1.
- MSCHAP2: Microsoft challenge-handshake authentication protocol, version 2.
- UNKNOWN: Indicates Auth type is unkonwn.
The hostname of the RADIUS authentication server. Primary and secondary servers should not have both hostname and authentication port same.
The maximum number of authentication attempts for the RADIUS authentication server.
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.
The realm prefix of the RADIUS authentication server.
The realm suffix of the RADIUS authentication server.
The server timeout (in seconds) of the RADIUS authentication server.
The shared secret of the RADIUS authentication server.
RCX client object to be registered.
{
"ip_address": "127.0.0.1",
"name": "example.com",
"thumbprints": [
{
"ssl_cert_thumbprint": "8f:92:9d:3b:a7:85:55:88:60:cd:e1:c8:1e:70:9a:8b:37:6d:a6:e6",
"ssl_cert_thumbprint_algorithm": "SHA_1"
}
]
}
IP address of the RCX client.
The RCX client certificate name.
RCX client object to be updated.
{
"ip_address": "127.0.0.1",
"thumbprints": [
{
"ssl_cert_thumbprint": "8f:92:9d:3b:a7:85:55:88:60:cd:e1:c8:1e:70:9a:8b:37:6d:a6:e6",
"ssl_cert_thumbprint_algorithm": "SHA_1"
}
]
}
IP address of the RCX client.
Information related to RCX servers of the cluster.
{
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"name": "rcxserver.example.com",
"port": 81,
"status": "UP",
"thumbprints": [
{
"ssl_cert_thumbprint": "8f:92:9d:3b:a7:85:55:88:60:cd:e1:c8:1e:70:9a:8b:37:6d:a6:e6",
"ssl_cert_thumbprint_algorithm": "SHA_1"
}
],
"version": "7.12"
}
Unique ID representing RCX server.
FQDN/IP address of the RCX server.
RCX server's port.
This indicates the current status of RCX server.
- UP: RCX server is running.
- DOWN: RCX server is down.
- UNKNOWN: RCX server status is unknown.
Version information of RCX server.
RDSH load balancer settings for the farm.
{
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"memory_threshold": 10
}
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.
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.
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.
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.
Indicates whether to include session count for load balancing. Default value is true when use_custom_script_for_load_balancing is false.
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.
RDSH load balancer settings for the farm.
{
"connecting_session_threshold": 10,
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"load_index_threshold": 20,
"memory_threshold": 10
}
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.
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.
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.
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.
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.
Indicates whether to include session count for load balancing. Default value is true when use_custom_script_for_load_balancing is false.
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.
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.
RDSH load balancer settings for the farm.
{
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"memory_threshold": 10
}
Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.
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.
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.
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.
Indicates whether to include session count for load balancing.
Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing.
RDSH load balancer settings for the farm.
{
"connecting_session_threshold": 10,
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"load_index_threshold": 20,
"memory_threshold": 10
}
Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions.
Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.
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.
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.
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.
Indicates whether to include session count for load balancing.
Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions.
Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing.
RDSH load balancer settings for the farm. This is required if use_custom_script_for_load_balancing is false.
{
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"memory_threshold": 10
}
Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.
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.
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.
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.
Indicates whether to include session count for load balancing.
Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing.
RDSH load balancer settings for the farm.
{
"connecting_session_threshold": 10,
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"load_index_threshold": 20,
"memory_threshold": 10
}
Represents the maximum number of sessions that can concurrently log into each RDSH agent machine in the farm, exempting reconnecting sessions.
Represents threshold of CPU usage, in percentage. If the value is 0, then this metric is not considered for load balancing.
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.
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.
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.
Indicates whether to include session count for load balancing.
Represents the minimum load index at which each RDSH agent machine in the farm will start denying session logins, exempting reconnecting sessions.
Represents threshold of memory usage, in percentage. If the value is 0, then this metric is not considered for load balancing.
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.
{
"access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"agent_build_number": "22673015",
"agent_version": "7.12",
"base_vm_id": "vm-23",
"base_vm_snapshot_id": "snapshot-2",
"description": "New RDS Server.",
"dns_name": "machine1.example.com",
"enabled": true,
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"image_management_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"load_index": 60,
"load_preference": "NORMAL",
"logoff_policy": "FORCE_LOGOFF",
"max_sessions_count": 123,
"max_sessions_count_configured": 123,
"max_sessions_type": "LIMITED",
"max_sessions_type_configured": "LIMITED",
"message_security_enhanced_mode_supported": true,
"message_security_mode": "MIXED",
"name": "server1",
"operating_system": "WINDOWS_SERVER_2012",
"operation": "REFRESH",
"operation_state": "AVAILABLE",
"pending_base_vm_id": "vm-8",
"pending_base_vm_snapshot_id": "snapshot-7",
"pending_image_management_stream_id": "ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25",
"pending_image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"remote_experience_agent_build_number": "32573985",
"remote_experience_agent_version": "7.12",
"session_count": 35,
"state": "AVAILABLE"
}
The id of the Access Group that the RDS Server belongs to.
Supported Filters : 'Equals'.
The Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
The Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
The base vm id.
Supported Filters : 'Equals'.
The base vm snapshot id.
Supported Filters : 'Equals'.
Description of the RDS Server.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
Indicates if RDS server is enabled.
Supported Filters : 'Equals'. This property can be used for sorting.
The id of the Farm that the RDS Server belongs to.
Supported Filters : 'Equals'.
Unique ID representing the RDS Server.
Supported Filters : 'Equals'.
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'.
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'.
This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100. This property can be used for sorting.
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. This property can be used for sorting.
- BLOCK: RDS Server is blocked and new sessions will not be accepted.
- HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.
- LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.
- NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.
- 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.
The user log off behavior at the time of maintenance. This property can be used for sorting.
- 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.
- WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
Maximum number of sessions for RDS server as reported by the Horizon Agent. This will be unset if the value is not configured.
Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.
RDS Server max sessions type as reported by the Horizon Agent.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
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.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
- UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.
Indicates whether ENHANCED message security mode is currently supported by this machine. This property can be used for sorting.
The current JMS message security mode used by this machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
Name of the RDS Server.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The machine operating system.
- LINUX_SERVER_OTHER: Linux Server (other)
- UNKNOWN: Unknown
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
The current maintenance operation on the RDS Server.
Supported Filters : 'Equals'. This property can be used for sorting.
- ARCHIVE: An archive operation.
- ATTACH: A persistent disk attach operation.
- DETACH: A persistent disk detach operation.
- PUSH_IMAGE: A push image operation.
- TAGGING: A tagging operation.
The state of the current maintenance operation on the RDS Server.
Supported Filters : 'Equals'. This property can be used for sorting.
- CANCELLING: The operation has been cancelled.
- COMPLETED: The operation has completed.
- CREATE: The operation is being initiated.
- FAULT: The operation has encountered an error.
- HOLDING: The operation has been paused.
- PROGRESSING: The operation is in progress.
- SCHEDULED: The operation is scheduled for future execution.
- STANDBY: The operation is on standby for a selective resync.
- UNDEFINED: The operation state is unrecognized.
The pending base vm id.
Supported Filters : 'Equals'.
The pending base vm snapshot id.
Supported Filters : 'Equals'.
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'.
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'.
The remote experience Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
The remote experience Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
RDS server session count.
This property can be used for sorting.
The state of the RDS server.
Supported Filters : 'Equals'. This property can be used for sorting.
- AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.
- AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.
- AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.
- AGENT_ERR_DISABLED: The Horizon Agent is disabled.
- AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.
- AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.
- AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.
- AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.
- 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.
- AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.
- ALREADY_USED: The RDS Server cannot accept new sessions.
- AVAILABLE: The RDS Server is powered on and ready for an active connection.
- BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.
- CONNECTED: The RDS Server is in an active session.
- CUSTOMIZING: The RDS Server is being customized.
- DELETING: The RDS Server is marked for deletion. It will be deleted soon.
- DISABLED: The RDS Server is disabled.
- DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.
- DISCONNECTED: The RDS Server is in an active session but is disconnected.
- ERROR: An unknown error occurred in the RDS Server.
- IN_PROGRESS: There is a RDS Server operation in progress.
- MAINTENANCE: The RDS Server is in maintenance mode.
- PROVISIONED: The RDS Server has been provisioned.
- PROVISIONING: The RDS Server is being provisioned.
- PROVISIONING_ERROR: An error occurred during provisioning.
- UNKNOWN: Could not determine the state of the RDS Server.
- VALIDATING: The connection server is synchronizing state information with the agent.
- WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.
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.
{
"access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"agent_build_number": "22673015",
"agent_upgrade_error_message": "true",
"agent_upgrade_result": "OK",
"agent_upgrade_state": "WAIT",
"agent_version": "7.12",
"base_vm_id": "vm-23",
"base_vm_snapshot_id": "snapshot-2",
"description": "New RDS Server.",
"dns_name": "machine1.example.com",
"enabled": true,
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"image_management_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"load_index": 60,
"load_preference": "NORMAL",
"logoff_policy": "FORCE_LOGOFF",
"max_sessions_count": 123,
"max_sessions_count_configured": 123,
"max_sessions_type": "LIMITED",
"max_sessions_type_configured": "LIMITED",
"message_security_enhanced_mode_supported": true,
"message_security_mode": "MIXED",
"name": "server1",
"operating_system": "WINDOWS_SERVER_2012",
"operation": "REFRESH",
"operation_state": "AVAILABLE",
"pending_base_vm_id": "vm-8",
"pending_base_vm_snapshot_id": "snapshot-7",
"pending_image_management_stream_id": "ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25",
"pending_image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
"remote_experience_agent_build_number": "32573985",
"remote_experience_agent_version": "7.12",
"session_count": 35,
"state": "AVAILABLE"
}
The id of the Access Group that the RDS Server belongs to.
Supported Filters : 'Equals'.
The Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
Error message of the agent upgrade operation failure on the rds server. This property can be used for sorting.
Result of the agent upgrade operation on the rds server. This property can be used for sorting.
- DUPLICATE: Agent received duplicate upgrade request.
- ERROR: Agent upgrade has unknown error.
- FAILURE: Agent upgrade has failed.
- INVALID: Agent received invalid values for upgrade.
- NOT_FOUND: Agent could not find upgrade request.
- OK: Agent upgrade is OK.
- PREFLIGHTCHECK_FAILURE: Preflight check failed for agent upgrade.
- PREFLIGHTCHECK_INPROGRESS: Preflight check is in progress for agent upgrade.
- PREFLIGHTCHECK_OK: Preflight check succeeded for agent upgrade.
- PROGRESS: Agent upgrade is in progress.
- UNKNOWN: Agent upgrade result is unknown.
State of the agent upgrade operation on the rds server. This property can be used for sorting.
- DONE: Agent upgrade task has ended.
- DOWNLOAD: Agent is downloading the upgrade binary.
- NOLOGON: Agent has no logged in user.
- READY: Agent is ready to be upgraded.
- UNKNOWN: Agent upgrade state is unknown.
- UPDATING: Agent is upgrading.
- WAIT: Agent is waiting for user to logoff or for reboot to complete.
The Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
The base vm id.
Supported Filters : 'Equals'.
The base vm snapshot id.
Supported Filters : 'Equals'.
Description of the RDS Server.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
Indicates if RDS server is enabled.
Supported Filters : 'Equals'. This property can be used for sorting.
The id of the Farm that the RDS Server belongs to.
Supported Filters : 'Equals'.
Unique ID representing the RDS Server.
Supported Filters : 'Equals'.
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'.
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'.
This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100. This property can be used for sorting.
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. This property can be used for sorting.
- BLOCK: RDS Server is blocked and new sessions will not be accepted.
- HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.
- LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.
- NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.
- 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.
The user log off behavior at the time of maintenance. This property can be used for sorting.
- 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.
- WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
Maximum number of sessions for RDS server as reported by the Horizon Agent. This will be unset if the value is not configured.
Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.
RDS Server max sessions type as reported by the Horizon Agent.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
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.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
- UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.
Indicates whether ENHANCED message security mode is currently supported by this machine. This property can be used for sorting.
The current JMS message security mode used by this machine.
Supported Filters : 'Equals'. This property can be used for sorting.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
Name of the RDS Server.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The machine operating system.
- LINUX_SERVER_OTHER: Linux Server (other)
- UNKNOWN: Unknown
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
The current maintenance operation on the RDS Server.
Supported Filters : 'Equals'. This property can be used for sorting.
- ARCHIVE: An archive operation.
- ATTACH: A persistent disk attach operation.
- DETACH: A persistent disk detach operation.
- PUSH_IMAGE: A push image operation.
- TAGGING: A tagging operation.
The state of the current maintenance operation on the RDS Server.
Supported Filters : 'Equals'. This property can be used for sorting.
- CANCELLING: The operation has been cancelled.
- COMPLETED: The operation has completed.
- CREATE: The operation is being initiated.
- FAULT: The operation has encountered an error.
- HOLDING: The operation has been paused.
- PROGRESSING: The operation is in progress.
- SCHEDULED: The operation is scheduled for future execution.
- STANDBY: The operation is on standby for a selective resync.
- UNDEFINED: The operation state is unrecognized.
The pending base vm id.
Supported Filters : 'Equals'.
The pending base vm snapshot id.
Supported Filters : 'Equals'.
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'.
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'.
The remote experience Horizon Agent build number.
Supported Filters : 'Equals'. This property can be used for sorting.
The remote experience Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.
RDS server session count.
This property can be used for sorting.
The state of the RDS server.
Supported Filters : 'Equals'. This property can be used for sorting.
- AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.
- AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.
- AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.
- AGENT_ERR_DISABLED: The Horizon Agent is disabled.
- AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.
- AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.
- AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.
- AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.
- 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.
- AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.
- ALREADY_USED: The RDS Server cannot accept new sessions.
- AVAILABLE: The RDS Server is powered on and ready for an active connection.
- BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.
- CONNECTED: The RDS Server is in an active session.
- CUSTOMIZING: The RDS Server is being customized.
- DELETING: The RDS Server is marked for deletion. It will be deleted soon.
- DISABLED: The RDS Server is disabled.
- DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.
- DISCONNECTED: The RDS Server is in an active session but is disconnected.
- ERROR: An unknown error occurred in the RDS Server.
- IN_PROGRESS: There is a RDS Server operation in progress.
- MAINTENANCE: The RDS Server is in maintenance mode.
- PROVISIONED: The RDS Server has been provisioned.
- PROVISIONING: The RDS Server is being provisioned.
- PROVISIONING_ERROR: An error occurred during provisioning.
- UNKNOWN: Could not determine the state of the RDS Server.
- VALIDATING: The connection server is synchronizing state information with the agent.
- WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.
Details of RDS Server.
{
"agent_build": "4445678",
"agent_version": "7.9.0",
"max_sessions_count_configured": 123,
"operating_system": "WINDOWS_SERVER_2016",
"state": "AVAILABLE"
}
Agent build number.
Agent version.
Maximum number of sessions for RDS server as configured by administrator. Will be unset if the value is not configured.
Operating System version.
- LINUX_SERVER_OTHER: Linux Server (other)
- UNKNOWN: Unknown
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
State of RDS Server.
- AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.
- AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.
- AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.
- AGENT_ERR_DISABLED: The Horizon Agent is disabled.
- AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.
- AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.
- AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.
- AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.
- 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.
- AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.
- ALREADY_USED: The RDS Server cannot accept new sessions.
- AVAILABLE: The RDS Server is powered on and ready for an active connection.
- BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.
- CONNECTED: The RDS Server is in an active session.
- CUSTOMIZING: The RDS Server is being customized.
- DELETING: The RDS Server is marked for deletion. It will be deleted soon.
- DISABLED: The RDS Server is disabled.
- DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.
- DISCONNECTED: The RDS Server is in an active session but is disconnected.
- ERROR: An unknown error occurred in the RDS Server.
- IN_PROGRESS: There is a RDS Server operation in progress.
- MAINTENANCE: The RDS Server is in maintenance mode.
- PROVISIONED: The RDS Server has been provisioned.
- PROVISIONING: The RDS Server is being provisioned.
- PROVISIONING_ERROR: An error occurred during provisioning.
- UNKNOWN: Could not determine the state of the RDS Server.
- VALIDATING: The connection server is synchronizing state information with the agent.
- WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.
RDS Server Monitor Information.
{
"details": {
"agent_build": "4445678",
"agent_version": "7.9.0",
"max_sessions_count_configured": 123,
"operating_system": "WINDOWS_SERVER_2016",
"state": "AVAILABLE"
},
"enabled": true,
"farm_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"load_index": 60,
"load_preference": "NORMAL",
"name": "rds-server.example.com",
"session_count": 35,
"status": "OK"
}
Indicates if RDS server is enabled.
Indicates the Farm ID to which the RDS Server belongs to.
Unique ID of the RDS server.
This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.
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.
- BLOCK: RDS Server is blocked and new sessions will not be accepted.
- HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.
- LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.
- NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.
- 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.
RDS Server name.
RDS server session count.
RDS server status.
- OK: RDS Server is reachable. All applications (defined on its farm) are verified installed on the RDS Server.
- WARNING: RDS Server is reachable. Some applications are detected as not installed on the RDS Server.
- ERROR: RDS Server is unreachable, or, none of the applications are installed.
- DISABLED: RDS Server is disabled.
RDS Server register response.
{
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"pairing_token": "<agent.pairing.token>"
}
Unique ID representing the RDS Server.
The pairing token for the RDS Server.
The specification for registering the RDS Server.
{
"description": "New RDS Server",
"dns_name": "rdsserver1.example.com",
"farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"operating_system": "WINDOWS_SERVER_2012"
}
An optional string to describe how and why this RDS Server was registered.
The DNS name for the RDS Server.
The farm to which the RDS Server will be added.
The Operating System of the RDS Server.
- LINUX_SERVER_OTHER: Linux Server (other)
- UNKNOWN: Unknown
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
The specification for updating the RDS Server.
{
"enabled": true,
"max_sessions_count_configured": 123,
"max_sessions_type_configured": "LIMITED"
}
Indicates if RDS server is enabled.
Maximum number of sessions for RDS server as configured by administrator.
The configured RDS Server max sessions type.
- UNLIMITED: The RDS Server has an unlimited number of sessions.
- LIMITED: The RDS Server has a limited number of sessions.
- UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.
Refresh token needed for Logout
{
"refresh_token": "<jwt.refresh.token>"
}
Refresh Token to be used to get a new Access token.
Information about Remote Application performance.
{
"description": "notepad.exe",
"name": "notepad",
"process_id": 1652079,
"remote_application_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"status": "RUNNING"
}
The description of a remote application.
The name of a remote application.
The process Id.
The identity of an application.
The status of a remote application.
- RUNNING: The remote application is working properly.
- NOT_RESPONDING: The remote application is working properly.
- UNKNOWN: The remote application is working properly.
Information related to Desktop Pool Policies.
{
"effective_policies": {
"allow_multimedia_redirection": "ALLOW",
"allow_pcoip_hardware_acceleration": "ALLOW",
"allow_remote_mode": "ALLOW",
"allow_usb_access": "ALLOW",
"pcoip_hardware_acceleration_priority": "MEDIUM"
},
"resource_policies": {
"allow_multimedia_redirection": "ALLOW",
"allow_pcoip_hardware_acceleration": "ALLOW",
"allow_remote_mode": "ALLOW",
"allow_usb_access": "ALLOW",
"pcoip_hardware_acceleration_priority": "MEDIUM"
}
}
Information related to resource pool.
{
"children": [
"ResourcePoolInfo Object"
],
"id": "resgroup-1",
"name": "RP1",
"path": "/Datacenter/host/Cluster/Resources/RP1",
"type": "RESOURCE_POOL"
}
Unique ID representing the resource pool.
Resource pool name.
Resource pool path.
Resource pool type.
- HOST: Host used as a resource pool suitable for use in desktop pool/farm.
- CLUSTER: Cluster used as a resource pool suitable for use in desktop pool/farm.
- RESOURCE_POOL: Regular resource pool suitable for use in desktop pool/farm.
- OTHER: Other resource type which cannot be used in desktop pool/farm.
Information related to restricted Horizon Agents.
{
"block_specific_versions": [
"7.6,0",
"8.0.0"
],
"type": "WINDOWS",
"version": "7.5.0"
}
Blocks specific versions of Horizon Agent connections.
The type of Horizon Agent.
- WINDOWS: The Agent is the Horizon Agent for Windows.
- OTHER: Agent type is other.
Blocks versions of Horizon Agent connections which are older than the specified version.
Information related to update restricted Horizon Agents.
{
"block_specific_versions": [
"7.6,0",
"8.0.0"
],
"type": "WINDOWS",
"version": "7.5.0"
}
Blocks specific versions of Horizon Agent connections.
The type of Horizon Agent.
- WINDOWS: The Agent is the Horizon Agent for Windows.
- OTHER: Agent type is other.
Blocks versions of Horizon Agent connections which are older than the specified version.
Information related to Restricted Horizon Clients.
[
{
"type": "WINDOWS",
"version": "7.5"
},
{
"type": "LINUX",
"version": "6.5"
}
]
The type of Horizon Client.
- WINDOWS: The client is the Horizon Client for Windows.
- MAC: The client is the Horizon Client for MacOS.
- HTMLACCESS: The client is a Web client.
- LINUX: The client is the Horizon Client for Linux.
- IOS: The client is the Horizon Client for IOS devices.
- ANDROID: The client is the Horizon Client for Android.
- WINSTORE: The client is the Horizon Client for Windows 10 UWP.
- CHROME: The client is the Horizon Client for Chrome Native OS.
- OTHER: Client type is other.
Blocks versions of Horizon Client connections which are older than the specified version.
Information related to Restricted Horizon Clients.
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
Blocks specific versions of Horizon Client connections.
The type of Horizon Client.
- WINDOWS: The client is the Horizon Client for Windows.
- MAC: The client is the Horizon Client for MacOS.
- HTMLACCESS: The client is a Web client.
- LINUX: The client is the Horizon Client for Linux.
- IOS: The client is the Horizon Client for IOS devices.
- ANDROID: The client is the Horizon Client for Android.
- WINSTORE: The client is the Horizon Client for Windows 10 UWP.
- CHROME: The client is the Horizon Client for Chrome Native OS.
- OTHER: Client type is other.
Blocks versions of Horizon Client connections which are older than the specified version.
Warns specific versions of Horizon Client connections.
Specification for resuming the task. If not provided, specification will be set to default values.
{
"retry_failed_vms": true,
"stop_on_error": "boolean"
}
Indicates whether to restart the task for virtual machines whose task status is in error state. Default value is false.
Indicates whether to stop the task at first error. Default value is true.
Role object to be created.
{
"description": "Custom administrator role.",
"name": "Custom",
"privileges": [
"VC_CONFIG_VIEW",
"FEDERATED_LDAP_MANAGE",
"GLOBAL_CONFIG_MANAGEMENT"
]
}
Role description.
Role name. This property must contain only alphanumerics, underscores, and dashes.
Privileges for this role. When being created or updated, input non-selectable privileges are ignored.
Information about role.
{
"applies_to_federation_access_group": true,
"applies_to_local_access_group": true,
"built_in_role_type": "INVENTORY_ADMIN",
"description": "Administration users with rights for global and per Connection Server configuration settings.",
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"name": "Global Configuration and Policy Administrators",
"permission_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"6fd4638a-381f-4518-aed6-042aa3d9f14c"
],
"privileges": [
"GLOBAL_ADMIN_UI_INTERACTIVE",
"GLOBAL_CONFIG_MANAGEMENT",
"GLOBAL_CONFIG_VIEW",
"GLOBAL_CVP_PUBLICATION"
]
}
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.
Specifies whether local access group is applicable for this role. This will be true when the role contains atleast one inventory specific privilege.
The role type. It will be null for custom roles.
- ADMINISTRATOR: Role with full administrative rights.
- ADMINISTRATOR_READ_ONLY: Role with full read-only administrative rights.
- AGENT_REGISTRATION_ADMIN: Role with rights to register Agents.
- GLOBAL_CONFIG_AND_POLICY_ADMIN: Role with rights for View Configuration settings and policies.
- GLOBAL_CONFIG_AND_POLICY_ADMIN_READ_ONLY: Role with read-only rights for View Configuration settings and policies.
- HELP_DESK_ADMIN: Role with rights for Help Desk portal management.
- HELP_DESK_ADMIN_READ_ONLY: Role with read only rights for Help Desk portal management.
- INVENTORY_ADMIN: Role with rights for inventory management.
- INVENTORY_ADMIN_READ_ONLY: Role with read only rights for inventory management.
- LOCAL_ADMIN: Local Pod Administration role with full administrative rights.
- LOCAL_ADMIN_READ_ONLY: Local Pod Administration role with full read-only administrative rights.
- UNKNOWN_ROLE: Unknown Role type.
Role description.
Unique ID representing this role.
Role name.
Administrative permissions (user/group and access group) for this role.
Privileges for this role.
Role object to be updated.
{
"description": "Administration users with full administrative rights.",
"privileges": [
"VC_CONFIG_VIEW",
"FEDERATED_LDAP_MANAGE",
"GLOBAL_CONFIG_MANAGEMENT"
]
}
Role description.
Privileges for this role. When being created or updated, input non-selectable privileges are ignored.
Details of the SAML authenticator.
{
"administrator_url": "https://vidm.example.com/saas/api/1.0/GET/admindata",
"label": "vidm.example.com",
"metadata_url": "https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"
}
The administrator URL for the SAML authenticator.
The label of the SAML Authenticator.
The metadata URL of the SAML Authenticator.
SAML Authenticator specification
{
"administrator_url": "https://vidm.example.com/saas/api/1.0/GET/admindata",
"authenticator_type": "DYNAMIC",
"certificate": "-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n",
"certificate_type": "PEM",
"connection_server_ids": [
"11bd230b-87ce-3306-a943-810affe7b68a",
"aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b"
],
"description": "Dynamic Saml Authenticator",
"label": "vidm.example.com",
"metadata_url": "https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml",
"password_mode": "REMOVE",
"static_metadata": "<md:EntityDescriptor xmlns:..</md:EntityDescriptor>",
"trigger_mode": "DISABLED"
}
The administrator URL for this SAML authenticator. This must specify a protocol (scheme) of http or https.
The type of SAML authenticator.
- STATIC: Static SAML Authenticator, which contains SAML metadata.
- DYNAMIC: Dynamic SAML Authenticator fetches metadata dynamically using a provided URL.
SAML Authenticator certificate.
Type of Certificate.
- PEM: PEM encoded certificate type
- UNKNOWN: Unknown certificate type
The list of Connection Servers for which this SAML authenticator is enabled.
The description of this SAML authenticator.
The label for this SAML authenticator. It must be unique among all other SAML authenticators.
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.
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.
- REMOVE: Remove any passwords.
- PASSTHRU: Pass through any passwords.
- ERROR: Error if there is a password.
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.
Indicates how True SSO is triggered on sessions using this authenticator.
- DISABLED: Do not use True SSO.
- ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.
- REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.
- ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.
- REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.
Information about SAML Authenticator.
{
"administrator_url": "https://vidm.example.com/saas/api/1.0/GET/admindata",
"authenticator_type": "DYNAMIC",
"certificate": "-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n",
"certificate_type": "PEM",
"description": "Dynamic Saml Authenticator",
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"label": "vidm.example.com",
"metadata_url": "https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml",
"password_mode": "REMOVE",
"static_metadata": "<md:EntityDescriptor xmlns:..</md:EntityDescriptor>",
"trigger_mode": "DISABLED"
}
The administrator URL for the SAML authenticator.
The type of SAML authenticator.
- STATIC: Static SAML Authenticator, which contains SAML metadata.
- DYNAMIC: Dynamic SAML Authenticator fetches metadata dynamically using a provided URL.
SAML Authenticator certificate.
Type of Certificate.
- PEM: PEM encoded certificate type
- UNKNOWN: Unknown certificate type
The description of this SAML authenticator.
Unique ID representing this SAML Authenticator.
The label for this SAML authenticator.
The metadata URL of the SAML Authenticator.
Indicates how password present in SAML assertion is handled if True SSO is triggered.
- REMOVE: Remove any passwords.
- PASSTHRU: Pass through any passwords.
- ERROR: Error if there is a password.
The static metadata of a SAML authenticator which contains an entity id, signing keys, and encryption keys for processing SAML authentication.
Indicates how True SSO is triggered on sessions using this authenticator.
- DISABLED: Do not use True SSO.
- ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.
- REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.
- ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.
- REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.
Information about the SAML authenticator connection from a connection server.
{
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": "boolean"
}
Unique ID of the Connection Server.
Connection server host name or IP address.
Status of the SAML authenticator with respect to this Connection Server.
- OK: The connection to SAML authenticator is working properly.
- ERROR: Error occurred when connecting to SAML authenticator.
- WARN: The connection to SAML authenticator has minor issues.
- UNKNOWN: State of SAML authenticator is unknown.
Indicates if the thumbprint of the SAML authenticator was accepted.
Information about the SAML authenticator connection from a connection server.
{
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": "boolean"
}
Unique ID of the Connection Server.
The timestamp in milliseconds when the last update was obtained. Measured as epoch time.
Connection server host name or IP address.
Status of the SAML authenticator with respect to this Connection Server.
- OK: The connection to SAML authenticator is working properly.
- ERROR: Error occurred when connecting to SAML authenticator.
- WARN: The connection to SAML authenticator has minor issues.
- UNKNOWN: State of SAML authenticator is unknown.
Indicates if the thumbprint of the SAML authenticator was accepted.
Monitoring information related to SAML Authenticator.
{
"connection_servers": [
{
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": "boolean"
}
],
"details": {
"administrator_url": "https://vidm.example.com/saas/api/1.0/GET/admindata",
"label": "vidm.example.com",
"metadata_url": "https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e"
}
Information about the SAML authenticator connections from each of the connection servers.
Unique ID of the SAML Authenticator.
Monitoring information related to SAML Authenticator.
{
"connection_servers": [
{
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": "boolean"
}
],
"details": {
"administrator_url": "https://vidm.example.com/saas/api/1.0/GET/admindata",
"label": "vidm.example.com",
"metadata_url": "https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml"
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e"
}
Information about the SAML authenticator connections from each of the connection servers.
Unique ID of the SAML Authenticator.
SAML Authenticator Server Spec.
{
"administrator_url": "https://vidm.example.com/SAAS/API/1.0/GET/admindata",
"metadata_url": "https://vidm.example.com/SAAS/API/1.0/GET/metadata/idp.xml"
}
The administrator URL for the SAML authenticator.
The metadata URL of the SAML Authenticator.
SAML Authenticator object to be updated.
{
"administrator_url": "https://vidm.example.com/saas/api/1.0/GET/admindata",
"certificate": "-----BEGIN CERTIFICATE-----\nMIID8DCCAtigAwIBAgIFFVeQUwEwDQY...-----END CERTIFICATE-----\n",
"certificate_type": "PEM",
"description": "Dynamic Saml Authenticator",
"label": "vidm.example.com",
"metadata_url": "https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml",
"password_mode": "REMOVE",
"static_metadata": "<md:EntityDescriptor xmlns:..</md:EntityDescriptor>",
"trigger_mode": "DISABLED"
}
The administrator URL for this SAML authenticator. This must specify a protocol (scheme) of http or https.
SAML Authenticator certificate.
Type of Certificate.
- PEM: PEM encoded certificate type
- UNKNOWN: Unknown certificate type
The description of this SAML authenticator.
The label for this SAML authenticator. It must be unique among all other SAML authenticators.
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.
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.
- REMOVE: Remove any passwords.
- PASSTHRU: Pass through any passwords.
- ERROR: Error if there is a password.
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.
Indicates how True SSO is triggered on sessions using this authenticator.
- DISABLED: Do not use True SSO.
- ENABLE_IF_NO_PASSWORD: If no password is supplied, use a valid (domain matching) connector if it exists.
- REQUIRE_IF_NO_PASSWORD: If no password is supplied, use and require a valid (domain matching) connector.
- ENABLE_ALWAYS: Regardless of a password, use a valid (domain matching) connector if it exists.
- REQUIRE_ALWAYS: Regardless of a password, use and require a valid (domain matching) connector.
Secondary credential object to be created
{
"domain": "AD-TEST-DOMAIN",
"owner_id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"password": [
"<password>"
],
"username": "administrator"
}
DNS name of one way or two way trusted domain.
The user sid of the owner of the secondary credential.
Password for secondary credentials account of the one way or two way trusted domain.
Username for secondary credentials account of the one way or two way trusted domain.
Information about secondary credentials.
{
"ad_distinguished_name": "CN=user3,CN=Users,DC=test,DC=eng,DC=example,DC=com",
"domain": "AD-TEST-DOMAIN",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"owner_id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"username": "administrator"
}
Distinguished name of secondary user account of the one way or two way trusted domain.
DNS name of one way or two way trusted domain.
The id of the secondary credential account.
The user sid of the owner of the secondary credential.
Username for secondary credentials account of the one way or two way trusted domain.
Password object to be updated.
{
"password": [
"<password>"
]
}
Password for secondary credentials account of the one way or two way trusted domain.
Security configuration of connection server and secure gateway.
{
"certificate_properties": {
"key_length": 2048,
"validity": 365
},
"connection_server_security_config": {
"client_properties": {
"cipher_suites": [
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384"
],
"named_groups": [
"SECP384_R1",
"FFDHE_2048"
],
"signature_algorithms": [
"RSA_PSS_RSAE_SHA512",
"RSA_PKCS1_SHA512",
"ECDSA_SECP521R1_SHA512"
],
"thumbprint_algorithms": [
"SHA_512",
"SHA_384"
]
},
"server_properties": {
"cipher_suites": [
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_RSA_WITH_AES_128_CBC_SHA256"
],
"named_groups": [
"SECP384_R1",
"FFDHE_4096"
],
"signature_algorithms": [
"RSA_PSS_RSAE_SHA512",
"RSA_PKCS1_SHA512",
"RSA_PKCS1_SHA1"
],
"thumbprint_algorithms": [
"SHA_512",
"SHA_384"
]
}
},
"secure_gateway_security_config": {
"client_properties": {
"cipher_suites": [
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384"
],
"named_groups": [
"SECP384_R1",
"FFDHE_2048"
],
"signature_algorithms": [
"RSA_PSS_RSAE_SHA512",
"RSA_PKCS1_SHA512",
"ECDSA_SECP521R1_SHA512"
],
"thumbprint_algorithms": [
"SHA_512",
"SHA_384"
]
},
"server_properties": {
"cipher_suites": [
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_RSA_WITH_AES_128_CBC_SHA256"
],
"named_groups": [
"SECP384_R1",
"FFDHE_4096"
],
"signature_algorithms": [
"RSA_PSS_RSAE_SHA512",
"RSA_PKCS1_SHA512",
"RSA_PKCS1_SHA1"
],
"thumbprint_algorithms": [
"SHA_512",
"SHA_384"
]
}
}
}
Client and server properties of Security configuration.
{
"client_properties": {
"cipher_suites": [
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384"
],
"named_groups": [
"SECP384_R1",
"FFDHE_2048"
],
"signature_algorithms": [
"RSA_PSS_RSAE_SHA512",
"RSA_PKCS1_SHA512",
"ECDSA_SECP521R1_SHA512"
],
"thumbprint_algorithms": [
"SHA_512",
"SHA_384"
]
},
"server_properties": {
"cipher_suites": [
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_RSA_WITH_AES_128_CBC_SHA256"
],
"named_groups": [
"SECP384_R1",
"FFDHE_4096"
],
"signature_algorithms": [
"RSA_PSS_RSAE_SHA512",
"RSA_PKCS1_SHA512",
"RSA_PKCS1_SHA1"
],
"thumbprint_algorithms": [
"SHA_512",
"SHA_384"
]
}
}
Security gateway data associated with the session.
{
"address": "127.0.0.1",
"domain_name": "SECURE-GW.example.com",
"location": "EXTERNAL"
}
IP address of the security gateway. This property need not be set.
Supported Filters : 'Equals'. This property can be used for sorting.
Computer machine name or DNS name of the security gateway. This property need not be set.
Supported Filters : 'Equals'. This property can be used for sorting.
Location of the security gateway. This property need not be set.
Supported Filters : 'Equals'. This property can be used for sorting.
- EXTERNAL: Gateway location is external.
- INTERNAL: Gateway location is internal.
- UNKNOWN: Gateway location is unknown.
Information related to Security Settings.
{
"cluster_public_key": "3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c",
"cluster_public_key_id": "cluster key",
"data_recovery_password_configured": true,
"message_security_mode": "ENABLED",
"message_security_status": "NOTSET",
"re_auth_secure_tunnel_after_interruption": true
}
The Base 64 encoded public key of the cluster in PEM format.
Key Id to identify the cluster's active key pair.
Indicates whether the backup recovery password has been configured.
Determines if signing and verification of the JMS messages passed between Horizon components takes place.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
The status of the JMS message security. This tracks the application of changes to messageSecurityMode.
- NOTSET: The cluster is performing at the specified message security mode.
- ENHANCED: The Cluster is in Enhanced message security mode.
- 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 .
- PENDING_ENHANCED: The cluster is propagating the change to ENHANCED message security mode to all nodes.
- LEAVING_ENHANCED: The cluster is leaving the ENHANCED message security mode.
- PREPARING_ENHANCED: The cluster is preparing to go in Enhanced mode.
- DISABLED: Message security mode is disabled.
- MIXED: Message security mode is enabled but not enforced.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
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.
Security settings object to be updated.
{
"data_recovery_password_hash": [
"5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"
],
"data_recovery_password_hint": "password hint",
"message_security_mode": "ENABLED",
"re_auth_secure_tunnel_after_interruption": true
}
The SHA-256 hash of the (UTF-8) data recovery password.
The data recovery password hint. This property has a maximum length of 128 characters.
Determines if signing and verification of the JMS messages passed between Horizon components takes place.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
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.
Security settings object to be updated.
{
"cert_auth_mapping": [
"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%",
"x509:<I>%issuer_dn%<SR>%serial%"
],
"cert_auth_mapping_control": [
"CUSTOM",
"SID"
],
"data_recovery_password_hash": [
"5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"
],
"data_recovery_password_hint": "password hint",
"message_security_mode": "ENABLED",
"re_auth_secure_tunnel_after_interruption": true
}
Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.
Indicates the type of search for validating the Smart card.
The SHA-256 hash of the (UTF-8) data recovery password.
The data recovery password hint. This property has a maximum length of 128 characters.
Determines if signing and verification of the JMS messages passed between Horizon components takes place.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
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.
Security settings object to be updated.
{
"cert_auth_mapping": [
"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%",
"x509:<I>%issuer_dn%<SR>%serial%"
],
"cert_auth_mapping_control": [
"CUSTOM",
"SID"
],
"crl_distribution_points": [
"http://www.cdpexample.com/file.crl",
"http://crls.pki.goog/gts1c3/file1.pem"
],
"crl_file_max_size_kb": 1024,
"crl_refresh_period_minutes": 100,
"data_recovery_password_hash": [
"5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"
],
"data_recovery_password_hint": "password hint",
"message_security_mode": "ENABLED",
"re_auth_secure_tunnel_after_interruption": true
}
Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.
Indicates the type of search for validating the Smart card.
List of CRL distribution point urls, from where CRLs will be fetched by crl prefetch service.It supports only http url and .crl and .pem file type.
Maximum allowed size in kb for CRL file that can be downloaded by crl prefetch service. This property has a default value of 1024.
Refresh time period in minutes for CRL prefetch. This property has a default value of 60.
The SHA-256 hash of the (UTF-8) data recovery password.
The data recovery password hint. This property has a maximum length of 128 characters.
Determines if signing and verification of the JMS messages passed between Horizon components takes place.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
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.
Information related to Security Settings.
{
"cluster_public_key": "3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c",
"cluster_public_key_id": "cluster key",
"data_recovery_password_configured": true,
"getdisallowEnhancedSecurityMode": true,
"message_security_mode": "ENABLED",
"message_security_status": "NOTSET",
"re_auth_secure_tunnel_after_interruption": true
}
The Base 64 encoded public key of the cluster in PEM format.
Key Id to identify the cluster's active key pair.
Indicates whether the backup recovery password has been configured.
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.
Determines if signing and verification of the JMS messages passed between Horizon components takes place.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
The status of the JMS message security. This tracks the application of changes to messageSecurityMode.
- NOTSET: The cluster is performing at the specified message security mode.
- ENHANCED: The Cluster is in Enhanced message security mode.
- 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 .
- PENDING_ENHANCED: The cluster is propagating the change to ENHANCED message security mode to all nodes.
- LEAVING_ENHANCED: The cluster is leaving the ENHANCED message security mode.
- PREPARING_ENHANCED: The cluster is preparing to go in Enhanced mode.
- DISABLED: Message security mode is disabled.
- MIXED: Message security mode is enabled but not enforced.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
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.
Information related to Security Settings.
{
"cert_auth_mapping": [
"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%",
"x509:<I>%issuer_dn%<SR>%serial%"
],
"cert_auth_mapping_control": [
"CUSTOM",
"SID"
],
"cert_auth_mapping_names": [
"issuer_dn",
"subject_dn",
"san_dns"
],
"cluster_public_key": "3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c",
"cluster_public_key_id": "cluster key",
"data_recovery_password_configured": true,
"getdisallowEnhancedSecurityMode": true,
"message_security_mode": "ENABLED",
"message_security_status": "NOTSET",
"re_auth_secure_tunnel_after_interruption": true
}
Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.
Indicates the type of search for validating the smart card.
List of all supported certificate properties.
The Base 64 encoded public key of the cluster in PEM format.
Key Id to identify the cluster's active key pair.
Indicates whether the backup recovery password has been configured.
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.
Determines if signing and verification of the JMS messages passed between Horizon components takes place.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
The status of the JMS message security. This tracks the application of changes to messageSecurityMode.
- NOTSET: The cluster is performing at the specified message security mode.
- ENHANCED: The Cluster is in Enhanced message security mode.
- 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 .
- PENDING_ENHANCED: The cluster is propagating the change to ENHANCED message security mode to all nodes.
- LEAVING_ENHANCED: The cluster is leaving the ENHANCED message security mode.
- PREPARING_ENHANCED: The cluster is preparing to go in Enhanced mode.
- DISABLED: Message security mode is disabled.
- MIXED: Message security mode is enabled but not enforced.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
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.
Information related to Security Settings.
{
"cert_auth_mapping": [
"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%",
"x509:<I>%issuer_dn%<SR>%serial%"
],
"cert_auth_mapping_control": [
"CUSTOM",
"SID"
],
"cert_auth_mapping_names": [
"issuer_dn",
"subject_dn",
"san_dns"
],
"cluster_public_key": "3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c",
"cluster_public_key_id": "cluster key",
"crl_distribution_points": [
"http://www.cdpexample.com/file.crl",
"http://crls.pki.goog/gts1c3/file1.pem"
],
"crl_file_max_size_kb": 1024,
"crl_refresh_period_minutes": 100,
"data_recovery_password_configured": true,
"getdisallowEnhancedSecurityMode": true,
"message_security_mode": "ENABLED",
"message_security_status": "NOTSET",
"re_auth_secure_tunnel_after_interruption": true
}
Indicates the certificate authentication mapping, which will be used to validate against (objectClass=user,altSecurityIdentities=) in Active directory.
Indicates the type of search for validating the smart card.
List of all supported certificate properties.
The Base 64 encoded public key of the cluster in PEM format.
Key Id to identify the cluster's active key pair.
List of CRL distribution point urls, from where CRLs will be fetched by crl prefetch service.
Maximum allowed size in kb for CRL file that can be downloaded by crl prefetch service.
Refresh time period in minutes for CRL prefetch.
Indicates whether the backup recovery password has been configured.
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.
Determines if signing and verification of the JMS messages passed between Horizon components takes place.
- DISABLED: Message security mode is disabled.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
- ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
- MIXED: Message security mode is enabled but not enforced.
The status of the JMS message security. This tracks the application of changes to messageSecurityMode.
- NOTSET: The cluster is performing at the specified message security mode.
- ENHANCED: The Cluster is in Enhanced message security mode.
- 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 .
- PENDING_ENHANCED: The cluster is propagating the change to ENHANCED message security mode to all nodes.
- LEAVING_ENHANCED: The cluster is leaving the ENHANCED message security mode.
- PREPARING_ENHANCED: The cluster is preparing to go in Enhanced mode.
- DISABLED: Message security mode is disabled.
- MIXED: Message security mode is enabled but not enforced.
- ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
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.
Server information.
{
"certificate_thumbprint": {
"certificate": "string",
"type": "PEM"
},
"password": [
"<password>"
],
"port": 443,
"server_name": "vc1.example.com",
"user_name": "[email protected]"
}
Password to use for the connection
Port of the virtual center to connect to.
Virtual Center’s server name or IP address
User name to use for the connection.
Server key derivation information.
{
"client_reference_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"identifier": "QnJva2Vy",
"proof": "qck2eXsbiOpFJMGKEBzyPTidLwwCzsG8PgvyncQpeZU=",
"public_key": "<public key>",
"scheme": "SCHEME-AES2"
}
Client reference identifier which is required to be passed as query param to login api, to enable decryption of encrypted sensitive information.
Identifier as Base64 encoded binary data.
Proof as Base64 encoded binary data.
Diffie Hellman public key as Base64 encoded binary data.
Selected scheme for key derivation.
- SCHEME_AES1: Diffie Hellman algo used by low power clients.
- SCHEME_AES2: Diffie Hellman algo used by high power clients.
- SCHEME_EC_AES1: Elliptic-curve Diffie Hellman algo used by low power clients.
- SCHEME_EC_AES2: Elliptic-curve Diffie Hellman algo used by high power clients.
Server properties of Security configuration.
{
"cipher_suites": [
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_RSA_WITH_AES_128_CBC_SHA256"
],
"named_groups": [
"SECP384_R1",
"FFDHE_4096"
],
"signature_algorithms": [
"RSA_PSS_RSAE_SHA512",
"RSA_PKCS1_SHA512",
"RSA_PKCS1_SHA1"
],
"thumbprint_algorithms": [
"SHA_512",
"SHA_384"
]
}
List of cipher suites of server.
List of named groups of server.
List of signature algorithms of server.
List of thumbprint algorithms of server.
Server Spec.
{
"password": [
"<password>"
],
"port": 443,
"server_name": "horizon.com",
"username": "administrator"
}
Password to use for the connection. This property is not required if the server is already added.
Port of the server to connect to.
Url of the server without the protocol prefix.
User name to use for the connection.
Service accounts for the domain.
{
"owner_id": "S-1-1-1-3965912346-1012345398-3123456564-123",
"status": "ACTIVE",
"username": "USER1"
}
The owner of the service account.
The status of the service account.
- ACTIVE: The service account credentials are working properly.
- ERROR: The service account credentials are not working.
- UNKNOWN: Status of the service account credentials is unknown.
The username of the service account.
The client Metrics for sessions.
{
"num_android_clients": "integer",
"num_browser_clients": "integer",
"num_ios_clients": "integer",
"num_linux_clients": "integer",
"num_mac_clients": "integer",
"num_other_clients": "integer",
"num_windows_clients": "integer"
}
The number of sessions whose client type is Android.
The number of sessions whose client type is htmlaccess.
The number of sessions whose client type is iOS.
The number of sessions whose client type is Linux.
The number of sessions whose client type is Mac.
The number of sessions whose client type is other.
The number of sessions whose client type is Windows.
The gateway Metrics for sessions.
{
"num_external_gateways": "integer",
"num_internal_gateways": "integer",
"num_unknown_gateways": "integer"
}
The number of sessions whose gateway location is external.
The number of sessions whose gateway location is internal.
The number of sessions whose gateway location is unknown. If the agent of a session is not upgraded to required version, the gateway location is unknown, this number is for this type of sessions.
Information related to Session.
Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.
See the field description to know the filter types it supports.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"agent_version": "7.12.0",
"application_names": [
"Calculator"
],
"broker_user_id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"brokered_remotely": "boolean",
"client_data": {
"address": "127.0.0.1",
"location_id": "6bda20e66cda315084edc8b5c67f9cf1e3b0f4559ba990b1004a",
"name": "EXAMPLE-CLIENT1",
"type": "WINDOWS",
"version": "5.4.0"
},
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"disconnected_time": 1582181947320,
"farm_id": "0dbd14ba-5795-4141-9cec-128ff6d494b0",
"id": "7cdd624f-37d1-46c1-ab96-695a5d13956f",
"idle_duration": 60,
"last_session_duration_ms": 116320,
"machine_id": "a00eda55-708a-4f7d-8cbc-1d1b3a2b5f73",
"rds_server_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"resourced_remotely": "boolean",
"security_gateway_data": {
"address": "127.0.0.1",
"domain_name": "SECURE-GW.example.com",
"location": "EXTERNAL"
},
"session_protocol": "PCOIP",
"session_state": "CONNECTED",
"session_type": "APPLICATION",
"start_time": 1582181831000,
"unauthenticated": "boolean",
"user_id": "S-1-5-21-1111111111-2222222222-3333333333-500"
}
Access group id associated with the session. For a non-RDS desktop session, this is the desktop pool's access group id. For an RDS desktop session, this is the RDS desktop pool's farm's access group id. For an application session, this is the application's farm's access group id.
Supported Filters : 'Equals'.
Version of agent This property need not be set.
Supported Filters : 'Equals'. This property can be used for sorting.
Names of the applications launched in the session. It will be only set when session_type is APPLICATION.
Supported Filters : 'Contains'.
User SID for the broker user associated with the session. It will be unset for non-broker sessions.
Supported Filters : 'Equals'.
Indicates whether the session is brokered from a remote pod. It is set only if the Horizon View agent where the session resides is version 6.0 or later.
Supported Filters : 'Equals'. This property can be used for sorting.
Unique desktop pool id for the session. This is unset if the session is not brokered through a desktop, such as for direct console access.
Supported Filters : 'Equals'.
Epoch time in milli seconds, when the session was last disconnected. This will be unset if the session's machine has an error state, or if the session has never been disconnected.
Supported Filters : 'Equals'. This property can be used for sorting.
Unique farm id for this RDS desktop or application session. This is unset if the session is not brokered through a farm, such as for application sessions or direct console access.
Supported Filters : 'Equals'.
Unique id representing a session.
Supported Filters : 'Equals'.
Idle time duration in minutes, indicating how long the end user of the session has been idle for. This property need not be set.
Supported Filters : 'Equals'. This property can be used for sorting.
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'. This property can be used for sorting.
Unique machine id for the session. This 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'.
Unique RDS server id for the RDS desktop or application session. This property need not be set.
Supported Filters : 'Equals'.
Indicates whether the session is running on remote pod resource.
Supported Filters : 'Equals'. This property can be used for sorting.
Protocol for the session. It will be unset for disconnected sessions.
Supported Filters : 'Equals'. This property can be used for sorting.
- PCOIP: Display protocol is PCoIP.
- RDP: Display protocol is RDP.
- BLAST: Display protocol is BLAST.
- CONSOLE: Display protocol is console.
- UNKNOWN: Display protocol is unknown.
State of session.
Supported Filters : 'Equals', 'NotEquals'. This property can be used for sorting.
- CONNECTED: Session is connected
- DISCONNECTED: Session is disconnected
- PENDING: Session is pending
Type of session.
Supported Filters : 'Equals'. This property can be used for sorting.
- DESKTOP: Desktop or RDS desktop session.
- APPLICATION: Application session.
Epoch time in milli seconds, when the session was originally logged in. The 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. This property need not be set.
Supported Filters : 'Equals'. This property can be used for sorting.
Indicates whether the session is of unauthenticated access user. This property need not be set.
Supported Filters : 'Equals'. This property can be used for sorting.
Unique SID of the user logged into the session. It may not match the broker user id for non-SSO scenarios.
Supported Filters : 'Equals'.
Session Metrics.
{
"application_session_metrics": {
"num_active_sessions": "integer",
"num_disconnected_sessions": "integer",
"num_idle_sessions": "integer",
"num_pending_sessions": "integer"
},
"client_metrics": {
"num_android_clients": "integer",
"num_browser_clients": "integer",
"num_ios_clients": "integer",
"num_linux_clients": "integer",
"num_mac_clients": "integer",
"num_other_clients": "integer",
"num_windows_clients": "integer"
},
"desktop_session_metrics": {
"num_active_sessions": "integer",
"num_disconnected_sessions": "integer",
"num_idle_sessions": "integer",
"num_pending_sessions": "integer"
},
"gateway_metrics": {
"num_external_gateways": "integer",
"num_internal_gateways": "integer",
"num_unknown_gateways": "integer"
},
"num_sessions": "integer",
"num_users": "integer",
"protocol_metrics": {
"num_blast_sessions": "integer",
"num_other_protocols": "integer",
"num_pcoip_sessions": "integer",
"num_rdp_sessions": "integer"
},
"rds_session_metrics": {
"num_active_sessions": "integer",
"num_disconnected_sessions": "integer",
"num_idle_sessions": "integer",
"num_pending_sessions": "integer"
}
}
The total number of sessions.
The total number of users.
The protocol Metrics for sessions.
{
"num_blast_sessions": "integer",
"num_other_protocols": "integer",
"num_pcoip_sessions": "integer",
"num_rdp_sessions": "integer"
}
The number of sessions using blast display protocol.
The number of sessions using protocol not belonging to blast, pcoip, RDP.
The number of sessions using pcoip display protocol.
The number of sessions using RDP display protocol.
Message information object to be sent to sessions.
{
"message": "Sample Info Message",
"message_type": "INFO",
"session_ids": [
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
]
}
Message to be sent to session(s).
Type of message to be sent to session(s).
- ERROR: Message is of error type.
- WARNING: Message is of warning type.
- INFO: Message is of information type.
List of session ids to which message is to be sent
The session state Metrics for application sessions.
{
"num_active_sessions": "integer",
"num_disconnected_sessions": "integer",
"num_idle_sessions": "integer",
"num_pending_sessions": "integer"
}
The number of active sessions.
The number of disconnected sessions.
The number of idle sessions.
The number of pending sessions.
Information related to Settings.
{
"feature_settings": {
"cloud_managed": true,
"enable_helpdesk": true,
"enable_image_management": true
},
"general_settings": {
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data": [
{
"type": "WINDOWS",
"version": "7.5"
},
{
"type": "LINUX",
"version": "6.5"
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
},
"security_settings": {
"cluster_public_key": "3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c",
"cluster_public_key_id": "cluster key",
"data_recovery_password_configured": true,
"message_security_mode": "ENABLED",
"message_security_status": "NOTSET",
"re_auth_secure_tunnel_after_interruption": true
}
}
Information related to Settings.
{
"feature_settings": {
"cloud_managed": true,
"enable_helpdesk": true,
"enable_image_management": true
},
"general_settings": {
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
},
"security_settings": {
"cluster_public_key": "3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c",
"cluster_public_key_id": "cluster key",
"data_recovery_password_configured": true,
"getdisallowEnhancedSecurityMode": true,
"message_security_mode": "ENABLED",
"message_security_status": "NOTSET",
"re_auth_secure_tunnel_after_interruption": true
}
}
Information related to Settings.
{
"feature_settings": {
"cloud_managed": true,
"enable_helpdesk": true,
"enable_image_management": true
},
"general_settings": {
"api_session_timeout_minutes": 30,
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_admin_banner": "boolean",
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_admin_banner_header": "Attention",
"pre_login_admin_banner_message": "On proceeding, you agree that you fully comply with the laws of this organisation.",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
},
"security_settings": {
"cluster_public_key": "3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c",
"cluster_public_key_id": "cluster key",
"data_recovery_password_configured": true,
"getdisallowEnhancedSecurityMode": true,
"message_security_mode": "ENABLED",
"message_security_status": "NOTSET",
"re_auth_secure_tunnel_after_interruption": true
}
}
Information related to Settings.
{
"agent_restriction_settings": {
"restricted_agent_data": [
{
"block_specific_versions": [
"7.6,0",
"8.0.0"
],
"type": "WINDOWS",
"version": "7.5.0"
}
],
"restricted_agent_message": "The system does not support this version of the Horizon Agent."
},
"client_settings": {
"client_policies": [
{
"enforcement_state": "REQUIRED",
"policy": "CERTIFICATE_VALIDATION",
"policy_values": [
"ENFORCE"
]
}
]
},
"feature_settings": {
"cloud_managed": true,
"enable_helpdesk": true,
"enable_image_management": true
},
"general_settings": {
"api_session_timeout_minutes": 30,
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_admin_banner": "boolean",
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_admin_banner_header": "Attention",
"pre_login_admin_banner_message": "On proceeding, you agree that you fully comply with the laws of this organisation.",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"sso_discard_connection_type": "BOTH",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
},
"security_settings": {
"cert_auth_mapping": [
"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%",
"x509:<I>%issuer_dn%<SR>%serial%"
],
"cert_auth_mapping_control": [
"CUSTOM",
"SID"
],
"cert_auth_mapping_names": [
"issuer_dn",
"subject_dn",
"san_dns"
],
"cluster_public_key": "3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c",
"cluster_public_key_id": "cluster key",
"data_recovery_password_configured": true,
"getdisallowEnhancedSecurityMode": true,
"message_security_mode": "ENABLED",
"message_security_status": "NOTSET",
"re_auth_secure_tunnel_after_interruption": true
}
}
Information related to Settings.
{
"agent_restriction_settings": {
"restricted_agent_data": [
{
"block_specific_versions": [
"7.6,0",
"8.0.0"
],
"type": "WINDOWS",
"version": "7.5.0"
}
],
"restricted_agent_message": "The system does not support this version of the Horizon Agent."
},
"client_settings": {
"client_policies": [
{
"enforcement_state": "REQUIRED",
"policy": "CERTIFICATE_VALIDATION",
"policy_values": [
"ENFORCE"
]
}
]
},
"feature_settings": {
"cloud_managed": true,
"enable_helpdesk": true,
"enable_image_management": true
},
"general_settings": {
"api_session_timeout_minutes": 30,
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_admin_banner": "boolean",
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_admin_banner_header": "Attention",
"pre_login_admin_banner_message": "On proceeding, you agree that you fully comply with the laws of this organisation.",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"sso_discard_connection_type": "BOTH",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
},
"security_settings": {
"cert_auth_mapping": [
"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%",
"x509:<I>%issuer_dn%<SR>%serial%"
],
"cert_auth_mapping_control": [
"CUSTOM",
"SID"
],
"cert_auth_mapping_names": [
"issuer_dn",
"subject_dn",
"san_dns"
],
"cluster_public_key": "3d43f005bfd5ade4c6853bd337f4d205e189c28793063087d1c0aeb58931e02c",
"cluster_public_key_id": "cluster key",
"crl_distribution_points": [
"http://www.cdpexample.com/file.crl",
"http://crls.pki.goog/gts1c3/file1.pem"
],
"crl_file_max_size_kb": 1024,
"crl_refresh_period_minutes": 100,
"data_recovery_password_configured": true,
"getdisallowEnhancedSecurityMode": true,
"message_security_mode": "ENABLED",
"message_security_status": "NOTSET",
"re_auth_secure_tunnel_after_interruption": true
}
}
Configuration settings object to be updated.
{
"feature_settings": {
"cloud_managed": true
},
"general_settings": {
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data": [
{
"type": "WINDOWS",
"version": "7.5"
},
{
"type": "LINUX",
"version": "6.5"
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
},
"security_settings": {
"data_recovery_password_hash": [
"5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"
],
"data_recovery_password_hint": "password hint",
"message_security_mode": "ENABLED",
"re_auth_secure_tunnel_after_interruption": true
}
}
Configuration settings object to be updated.
{
"feature_settings": {
"cloud_managed": true
},
"general_settings": {
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
},
"security_settings": {
"data_recovery_password_hash": [
"5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"
],
"data_recovery_password_hint": "password hint",
"message_security_mode": "ENABLED",
"re_auth_secure_tunnel_after_interruption": true
}
}
Configuration settings object to be updated.
{
"feature_settings": {
"cloud_managed": true
},
"general_settings": {
"api_session_timeout_minutes": 30,
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_admin_banner": "boolean",
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"enable_user_name_caching": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_admin_banner_header": "Attention",
"pre_login_admin_banner_message": "On proceeding, you agree that you fully comply with the laws of this organisation.",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
},
"security_settings": {
"data_recovery_password_hash": [
"5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"
],
"data_recovery_password_hint": "password hint",
"message_security_mode": "ENABLED",
"re_auth_secure_tunnel_after_interruption": true
}
}
Configuration settings object to be updated.
{
"agent_restriction_settings": {
"restricted_agent_data": [
{
"block_specific_versions": [
"7.6,0",
"8.0.0"
],
"type": "WINDOWS",
"version": "7.5.0"
}
],
"restricted_agent_message": "The system does not support this version of the Horizon Agent."
},
"client_settings": {
"client_policies": [
{
"enforcement_state": "REQUIRED",
"policy": "CERTIFICATE_VALIDATION",
"policy_values": [
"ENFORCE"
]
}
]
},
"feature_settings": {
"cloud_managed": true
},
"general_settings": {
"api_session_timeout_minutes": 30,
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_admin_banner": "boolean",
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"enable_user_name_caching": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_admin_banner_header": "Attention",
"pre_login_admin_banner_message": "On proceeding, you agree that you fully comply with the laws of this organisation.",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"sso_discard_connection_type": "BOTH",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
},
"security_settings": {
"cert_auth_mapping": [
"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%",
"x509:<I>%issuer_dn%<SR>%serial%"
],
"cert_auth_mapping_control": [
"CUSTOM",
"SID"
],
"data_recovery_password_hash": [
"5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"
],
"data_recovery_password_hint": "password hint",
"message_security_mode": "ENABLED",
"re_auth_secure_tunnel_after_interruption": true
}
}
Configuration settings object to be updated.
{
"agent_restriction_settings": {
"restricted_agent_data": [
{
"block_specific_versions": [
"7.6,0",
"8.0.0"
],
"type": "WINDOWS",
"version": "7.5.0"
}
],
"restricted_agent_message": "The system does not support this version of the Horizon Agent."
},
"client_settings": {
"client_policies": [
{
"enforcement_state": "REQUIRED",
"policy": "CERTIFICATE_VALIDATION",
"policy_values": [
"ENFORCE"
]
}
]
},
"feature_settings": {
"cloud_managed": true
},
"general_settings": {
"api_session_timeout_minutes": 30,
"application_sso_timeout_minutes": 30,
"application_sso_timeout_policy": "ENABLED",
"block_restricted_clients": "boolean",
"client_idle_session_timeout_minutes": 300,
"client_idle_session_timeout_policy": "NEVER",
"client_max_session_timeout_minutes": 300,
"client_max_session_timeout_policy": "TIMEOUT_AFTER",
"client_session_timeout_minutes": 300,
"console_session_timeout_minutes": 30,
"display_pre_login_admin_banner": "boolean",
"display_pre_login_message": "boolean",
"display_warning_before_forced_logoff": true,
"enable_automatic_status_updates": true,
"enable_credential_cleanup_for_htmlaccess": "boolean",
"enable_multi_factor_re_authentication": "boolean",
"enable_sending_domain_list": "boolean",
"enable_server_in_single_user_mode": true,
"enable_user_name_caching": true,
"forced_logoff_message": "The system will shut down shortly. Please save your work.",
"forced_logoff_timeout_minutes": 3,
"hide_domain_list_in_client": true,
"hide_server_information_in_client": "boolean",
"machine_sso_timeout_minutes": 300,
"machine_sso_timeout_policy": "DISABLED_AFTER",
"pre_login_admin_banner_header": "Attention",
"pre_login_admin_banner_message": "On proceeding, you agree that you fully comply with the laws of this organisation.",
"pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
"restricted_client_data_v2": [
{
"block_specific_versions": [
"3.5,4",
"4.0.1"
],
"type": "WINDOWS",
"version": "7.5",
"warn_specific_versions": [
"7.5,4",
"5.0.2"
]
}
],
"restricted_client_message": "The system does not support this version of the Horizon client.",
"restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
"sso_discard_connection_type": "BOTH",
"store_cal_on_client": "boolean",
"store_cal_on_connection_server": "boolean"
},
"security_settings": {
"cert_auth_mapping": [
"x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%",
"x509:<I>%issuer_dn%<SR>%serial%"
],
"cert_auth_mapping_control": [
"CUSTOM",
"SID"
],
"crl_distribution_points": [
"http://www.cdpexample.com/file.crl",
"http://crls.pki.goog/gts1c3/file1.pem"
],
"crl_file_max_size_kb": 1024,
"crl_refresh_period_minutes": 100,
"data_recovery_password_hash": [
"5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"
],
"data_recovery_password_hint": "password hint",
"message_security_mode": "ENABLED",
"re_auth_secure_tunnel_after_interruption": true
}
}
Site object to be created.
{
"description": "This is US site",
"name": "US Site"
}
Detailed description of the site.
The name of the site.
Information related to sites in a pod federation.
{
"description": "This is US site",
"id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"name": "US Site",
"pods": [
"c617fd51-e118-4cae-970c-54a7144aaadc",
"bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"
]
}
Detailed description of the site.
Unique ID representing the site.
Name of the site.
Member pods for this site.
Site object to be updated.
{
"description": "This is US site",
"name": "US Site"
}
Detailed description of the site.
The name of the site.
Smart card authentication tokens.
{
"access_token": "<jwt.access.token>",
"domain": "AD-TEST-DOMAIN",
"refresh_token": "<jwt.refresh.token>",
"user_name": "Administrator"
}
Access Token to be used in API calls.
Domain
Refresh Token to be used to get a new Access token.
User Name
Information about specified names validation.
{
"machine_name": "Machine-002-jdoe",
"specified_names_statuses": [
"VM_NAME_TOO_LONG"
],
"user_id": "S-1-5-21-3711839221-3344336616-3511462156-1117",
"user_name": "abcorp.com\\jdoe"
}
The virtual machine name.
The status information captured after validation.
The SID of the user.
The name of the user entitled to the VM.
The specification for specified names validation that needs to be validated.
{
"dedicated": "boolean",
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"names_spec": [
{
"machine_name": "Machine-002-jdoe",
"user_name": "abcorp.com\\jdoe"
}
]
}
Indicates whether desktop pool is dedicated or floating. Default value is false.
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.
Information about the Storage Accelerator Data
{
"default_cache_size_mb": 1024,
"enabled": "boolean",
"host_overrides": [
{
"cache_size_mb": 2048,
"path": "/path/host"
}
]
}
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.
Is View Storage Accelerator enabled? This property has a default value of false.
Cache size overrides for hosts which support View Storage Accelerator.
Information about the Storage Accelerator Data
{
"default_cache_size_mb": 1024,
"enabled": "boolean",
"host_overrides": [
{
"cache_size_mb": 2048,
"path": "/path/host"
}
]
}
Default size of the cache in megabytes. This property has a default value of 1024. This property has a minimum value of 100. This property has a maximum value of 32768.
Indicates if View Storage Accelerator enabled This property has a default value of false.
Cache size overrides for hosts which support View Storage Accelerator.
Information about the Storage Accelerator Data
{
"default_cache_size_mb": 1024,
"enabled": "boolean",
"host_overrides": [
{
"cache_size_mb": 2048,
"path": "/path/host"
}
]
}
Default size of the cache in megabytes. This property has a default value of 1024. This property has a minimum value of 100. This property has a maximum value of 32768.
Indicates if View Storage Accelerator enabled This property has a default value of false.
Cache size overrides for hosts which support View Storage Accelerator.
Information related to Storage Accelerator Host.
{
"name": "blrkm.example.com",
"path": "/blr/host/cluster/blrkm.example.com",
"version": "7.0.1"
}
Host name or IP address.
Host path.
Version of the host.
Information related to Storage Details.
{
"space_reclamation_status": "VALIDATION_OK",
"storage_accelerator_host_details": [
{
"name": "blrkm.example.com",
"path": "/blr/host/cluster/blrkm.example.com",
"version": "7.0.1"
}
],
"storage_accelerator_status": "VALIDATION_OK",
"version": "6.5.0"
}
Space reclamation status of the given virtual center.
- VALIDATION_OK: Virtual center supports space reclamation.
- UNSUPPORTED_VC: Virtual center does not support space reclamation.
- RECLAMATION_DISABLED: The feature has been disabled for the virtual center.
- FEATURE_DISABLED: Space reclamation has been disabled globally.
Storage accelerator status of the given virtual center.
- VALIDATION_OK: Virtual center supports View Storage Accelerator.
- UNSUPPORTED_VC: Virtual center does not support View Storage Accelerator.
Version of the Virtual Center.
Storage Details Spec. Note:Either id or server_details_spec should be set
{
"server_details_spec": {
"certificate_thumbprint": {
"certificate": "string",
"type": "PEM"
},
"password": [
"<password>"
],
"port": 443,
"server_name": "vc1.example.com",
"user_name": "[email protected]"
},
"virtual_center_id": "446b6892-f3a6-463a-8b39-ac59c8c0d245"
}
Unique id representing virtual center.
Information related to File based logging data.
{
"enabled": true,
"enabled_on_error": true,
"unc_domain": "domain",
"unc_path": "//10.117.146.17/temp",
"unc_username": "administrator"
}
Indicates whether local/remote file based logging is enabled for all events.
Indicates whether local/remote file based logging is enabled for audit events when there is any error in writing events to EventDatabase or syslog.
The remote UNC password.
The remote UNC path for syslog to move files. If not set, logs are kept locally at path PROGRAMDATA%\VMware\VDM\events.
The remote UNC user name.
Information related to File based logging data.
{
"enabled": true,
"enabled_on_error": true,
"unc_domain": "domain",
"unc_password": [
"<password>"
],
"unc_path": "//10.117.146.17/temp",
"unc_username": "administrator"
}
Indicates whether local/remote file based logging is enabled for all events.
Indicates whether local/remote file based logging is enabled for audit events when there is any error in writing events to EventDatabase or syslog.
The remote UNC domain
The remote UNC password.This field is required if unc_user_name is set.
The remote UNC path for syslog to move files. If not set, logs are kept locally at path PROGRAMDATA%\VMware\VDM\events. This field is required if any of the unc_user_name, unc_password, unc_domain is set.
The remote UNC user name. This field is required if any of the unc_path, unc_password, unc_domain is set.
Information about Syslog.
{
"file_data": {
"enabled": true,
"enabled_on_error": true,
"unc_domain": "domain",
"unc_path": "//10.117.146.17/temp",
"unc_username": "administrator"
},
"syslog_server_addresses": [
"10.117.146.90:514",
"10.117.146.89:514"
]
}
List of Syslog Server addresses
Syslog configuration to be updated.
{
"file_data": {
"enabled": true,
"enabled_on_error": true,
"unc_domain": "domain",
"unc_password": [
"<password>"
],
"unc_path": "//10.117.146.17/temp",
"unc_username": "administrator"
},
"syslog_server_addresses": [
"10.117.146.90:514",
"10.117.146.89:514"
]
}
List of Syslog Server addresses
System Metrics information.
{
"event_error_count": 3,
"event_warning_count": 6,
"health_metrics_info": {
"component": "ALL",
"error_count": 3,
"healthy_count": 5,
"total_count": 13,
"unknown_count": 2,
"warning_count": 3
},
"problem_rds_hosts_count": 3,
"problem_vcenter_vms_count": 2,
"sessions_count": 6
}
Number of events with the "Error" severity.
Number of events with the "Warn" severity.
Number of RDS Hosts that are part of a farm and which are in any of the following status statesAGENT_UNREACHABLE, AGENT_CONFIG_ERROR, UNKNOWN, ALREADY_USED, PROVISIONING_ERROR, ERROR and AGENT_ERR_PROTOCOL_FAILURE.
Number of the managed VMs which are in any of the following machine's basic_state states AGENT_ERR_DISABLED, AGENT_UNREACHABLE, AGENT_ERR_INVALID_IP, AGENT_ERR_NEED_REBOOT,AGENT_ERR_PROTOCOL_FAILURE, AGENT_ERR_DOMAIN_FAILURE, AGENT_CONFIG_ERROR, PROVISIONING_ERROR, ERROR, UNASSIGNED_USER_CONNECTED,UNASSIGNED_USER_DISCONNECTED, UNKNOWN.
Number of active sessions.
Information related to CPA tasks.
{
"category": "POD_FEDERATION_CATEGORY",
"id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"percentage_complete": 80,
"result": {
"message": "PodFederation initialization completed.",
"message_id": "POD_FEDERATION_INIT_SUCCESS.",
"result_code": "SUCCESS"
},
"status": "COMPLETED",
"type": "POD_FEDERATION_INITIALIZING"
}
The category of the task.
- POD_FEDERATION_CATEGORY: Category for PodFederation related tasks.
Unique ID representing the task.
The amount of task completed, in percentage.
The state of the task.
- RUNNING: The task is currently running.
- WAITING: The task is currently waiting to execute.
- COMPLETED: The task execution has completed.
- FAILED: The task execution has failed.
- PAUSED: The task execution has been paused.
- CANCELLED: The task execution has been cancelled.
The type of the task.
- POD_FEDERATION_INITIALIZING: Task performing PodFederation initialize operation.
- POD_FEDERATION_UNINITIALIZING: Task performing PodFederation uninitialize operation.
- POD_FEDERATION_JOINING: Task performing PodFederation join operation.
- POD_FEDERATION_UNJOINING: Task performing PodFederation unjoin operation.
Information about a task result.
{
"message": "PodFederation initialization completed.",
"message_id": "POD_FEDERATION_INIT_SUCCESS.",
"result_code": "SUCCESS"
}
The result message.
The result message ID.
The result code of the task.
- SUCCESS: Task is completed successfully.
- WARN: Task is finished but has warning.
- ERROR: Task is finished but the it has error.
Domain data available to this enrollment server.
{
"certificate_servers": [
{
"certificate_server_name": "pod07-POD07-CA1-CA",
"certificate_server_network_address": "POD07-CA1.pod07.example.com",
"certificate_status": "VALID",
"connection_status": "CONNECTED",
"connection_status_reason": "string",
"template_names": [
"TrueSso2",
"TrueSso1",
"TrueSsoTemplate"
]
}
],
"dns_name": "az.example.com",
"domain_id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"domain_status": "READY",
"domain_status_reason": "string",
"enrollment_certificate_status": "VALID",
"forest_dns_name": "example.com",
"replication_status": "OK",
"replication_status_reason": "string",
"templates": [
{
"hash_algorithm": "SHA_256",
"minimum_key_length": 2048,
"template_name": "TrueSsoTemplate",
"template_status": "SUPPORTED_OPTIMAL",
"template_status_reason": "string",
"validity_seconds": 36000000000
}
]
}
Collection of certificate server data available to this domain.
DNS name of the domain.
Id of the domain.
The status of this domain to the enrollment server.
- READY: The domain is ready.
- CREATED: The domain is created.
- INITIALIZED: The domain is initialized.
- CONNECTING: The domain is connecting.
- 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.
- STOPPING: The domain is stopping. A domain with this status cannot be used in connector creation.
- FAILED: The domain is failed. A domain with this status cannot be used in connector creation.
- UNKNOWN: The domain status is unknown. A domain with this status cannot be used in connector creation.
Additional non-localized explanation of the domain status.
The status of the enrollment server's certificate for this domain's forest.
- VALID: A valid enrollment certificate for this domain's forest is installed on the enrollment server.
- 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.
DNS name of the domain's forest, if any.
This domain's forest's replication status with the domain controller.
- OK: The enrollment server has read the enrollment properties at least once and is successfully able to update them periodically.
- 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.
- PENDING: he enrollment server has not yet read the enrollment properties from a domain controller.
- 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.
Additional non-localized explanation of the replication status.
Collection of certificate template data available to certificate servers on this domain. Not all certificate servers may have access to all of these templates.
Certificate server data available to this domain.
{
"certificate_server_name": "pod07-POD07-CA1-CA",
"certificate_server_network_address": "POD07-CA1.pod07.example.com",
"certificate_status": "VALID",
"connection_status": "CONNECTED",
"connection_status_reason": "string",
"template_names": [
"TrueSso2",
"TrueSso1",
"TrueSsoTemplate"
]
}
Unique (common) name of this certificate server.
DNS name network address of this certificate server.
The status of the certificate server's certificate.
- VALID: The certificate is valid.
- NOT_YET_VALID: The certificate is not yet valid.
- UNKNOWN: The certificate status is unknown. A certificate server with a certificate with this status cannot be used in connector creation.
- 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.
- EXPIRED: The certificate has expired. A certificate server with a certificate with this status cannot be used in connector creation.
- 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.
The status of the enrollment server's connection to the certificate server.
- CONNECTED: The enrollment server is connected to the certificate server.
- 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).
- 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.
- DISCONNECTED: The enrollment server is not connected to the certificate server.
Additional non-localized explanation of the connection status.
Collection of certificate template names available to this certificate server.
TrueSSO Connector object to be created.
{
"ad_domain_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"certificate_server_names": [
"SSOConnector"
],
"description": "TrueSSO Connector",
"enabled": true,
"name": "true-sso.example.com",
"primary_enrollment_server_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"secondary_enrollment_server_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed59",
"template_name": "TrueSSO Template"
}
The AD domain id that this connector applies to. This domain must be unique among all connectors. This domain must be accessible to all enrollment servers configured on this connector. This cannot be changed once created.
Specifies the certificate server (common) names to send certificate signing requests to. The enrollment service will round-robin the requests to available certificate servers.
Description of this TrueSSO Connector.
Indicates whether or not the connector is enabled. Default value is TRUE.
Name of this TrueSSO Connector.
The primary enrollment server id.
The secondary enrollment server id. This cannot be the same as the primary.
Name of the certificate template to use for this domain. This template must be accessible to all enrollment servers configured on this connector.
Information about TrueSSO Connector.
{
"ad_domain_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"certificate_server_names": [
"SSOConnector"
],
"description": "TrueSSO Connector",
"enabled": true,
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"name": "true-sso.example.com",
"primary_enrollment_server_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"secondary_enrollment_server_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"template_name": "TrueSSO Template"
}
The AD domain that this connector applies to.
Specifies the certificate server (common) names to send certificate signing requests to. The enrollment service will round-robin the requests to available certificate servers.
Description of this TrueSSO Connector.
Indicates whether or not the TrueSSO Connector is enabled.
Unique ID representing this TrueSSO Connector.
Name of this TrueSSO Connector.
The primary enrollment server.
The secondary enrollment server.
Name of the certificate template to use for this domain.
TrueSSO Connector object to be updated.
{
"certificate_server_names": [
"SSOConnector"
],
"description": "TrueSSO Connector",
"enabled": true,
"name": "true-sso.example.com",
"primary_enrollment_server_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"secondary_enrollment_server_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed59",
"template_name": "TrueSSO Template"
}
Specifies the certificate server (common) names to send certificate signing requests to. The enrollment service will round-robin the requests to available certificate servers.
Description of this TrueSSO Connector.
Indicates whether or not the connector is enabled.
Name of this TrueSSO Connector.
The primary enrollment server id.
The secondary enrollment server id. This cannot be the same as the primary.
Name of the certificate template to use for this domain. This template must be accessible to all enrollment servers configured on this connector.
Information about TrueSSO Enrollment Server.
{
"connector_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"domains": [
{
"certificate_servers": [
{
"certificate_server_name": "pod07-POD07-CA1-CA",
"certificate_server_network_address": "POD07-CA1.pod07.example.com",
"certificate_status": "VALID",
"connection_status": "CONNECTED",
"connection_status_reason": "string",
"template_names": [
"TrueSso2",
"TrueSso1",
"TrueSsoTemplate"
]
}
],
"dns_name": "az.example.com",
"domain_id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"domain_status": "READY",
"domain_status_reason": "string",
"enrollment_certificate_status": "VALID",
"forest_dns_name": "example.com",
"replication_status": "OK",
"replication_status_reason": "string",
"templates": [
{
"hash_algorithm": "SHA_256",
"minimum_key_length": 2048,
"template_name": "TrueSsoTemplate",
"template_status": "SUPPORTED_OPTIMAL",
"template_status_reason": "string",
"validity_seconds": 36000000000
}
]
}
],
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"name": "pod07-es1.pod07.example.com",
"network_address": "pod07-es1.pod07.example.com",
"status": "ONLINE",
"version": "1.0"
}
TrueSSO connectors, if any, associated with this enrollment server.
Collection of domain data available to this enrollment server.
Unique ID representing this TrueSSO Enrollment Server.
Name of this enrollment server.
DNS name network address of this enrollment server.
The status of this enrollment server.
- ONLINE: The connection to the enrollment server is working properly.
- OFFLINE: The enrollment server is not responding. An enrollment server with this status cannot be used in connector creation.
Version number of this enrollment server.
Monitoring information related to the True SSO Connector.
{
"ad_domain_dns_name": "ad-domain.example.com",
"ad_domain_id": "S-1-5-21-1085031214-1563985344-725345543",
"ad_domain_status": "OK",
"certificate_server_details": [
{
"name": "SSOConnector",
"status": "OK"
}
],
"enabled": true,
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"name": "true-sso.example.com",
"primary_enrollment_server": {
"dns_name": "enrollment-server.example.com",
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"status": "OK"
},
"secondary_enrollment_server": {
"dns_name": "enrollment-server.example.com",
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
"status": "OK"
},
"status": "OK",
"template_name": "TrueSSO Template",
"template_status": "OK"
}
The DNS name of the domain.
Unique SID of the AD Domain.
The state of the domain health, taken as the most severe reported by one of the enrollment servers.
- OK: The state of the domain is OK as reported by the enrollment servers.
- WARN: At least one of the enrollment servers has a warning.
- ERROR: At least one of the enrollment servers is in an error state.
Details of each certificate server.
Indicates if the True SSO connector is enabled.
Unique ID of the True SSO Connector.
True SSO connector name.
Overall status of the True SSO connector.
- OK: All the components of the True SSO connector are fine.
- WARN: At least one component of the True SSO connector has a warning.
- ERROR: At least one component of the True SSO connector has an error.
Unique name for the True SSO template.
The state of the template health, taken as the most severe reported by one of the enrollment servers.
- OK: The state of the template is OK as reported by the enrollment servers.
- WARN: At least one enrollment server reports a warning on this template.
- ERROR: At least one enrollment server reports an error on this template.
Certificate template data available to certificate servers on this domain.
{
"hash_algorithm": "SHA_256",
"minimum_key_length": 2048,
"template_name": "TrueSsoTemplate",
"template_status": "SUPPORTED_OPTIMAL",
"template_status_reason": "string",
"validity_seconds": 36000000000
}
Hash algorithm used in the certificate signing request.
- SHA1: SHA-1 hashing algorithm.
- SHA256: SHA-256 hashing algorithm.
- SHA384: SHA-384 hashing algorithm.
- SHA512: SHA-512 hashing algorithm.
Minimum key-length of the private/public key associated with the certificate.
Unique name for this template.
The status of this template.
- SUPPORTED_OPTIMAL: This template has the optimal properties for TrueSSO.
- SUPPORTED_NOT_OPTIMAL: This template does not have the ideal properties for TrueSSO.
- UNKNOWN: This status of this template is unknown. A template with this status cannot be used in connector creation.
- NO_CAPABILITY: This template is not configured to perform TrueSSO. A template with this status cannot be used in connector creation.
- INVALID: This template is smart card logon enabled, but some setting is invalid. A template with this status cannot be used in connector creation.
- MANUAL: This template is smart card logon enabled, but manual enrollment is needed. A template with this status cannot be used in connector creation.
- UNSUITABLE: This template is smart card logon enabled, but is unsuitable. A template with this status cannot be used in connector creation.
Additional non-localized explanation of the status.
Length of time, in seconds, that certificates issues with this template remain valid.
Unauthenticated access user specification
{
"alias_name": "unauthenticated-user",
"description": "example description",
"hybrid_logon_mode": "PASSWORD",
"hybrid_logon_password": [
"password"
],
"user_id": "S-1-5-21-1111111111-2222222222-3333333333-500"
}
Alias to be used for login from client. If unset, AD login name of the user would be used.
Description of the unauthenticated access user.
Mode to be used for hybrid logon. If unset, hybrid logon will be disabled.
- PASSWORD: Hybrid logon via username and password.
- TRUESSO: Hybrid logon via True SSO.
- DISABLED: Hybrid logon disabled.
Password for the user for hybrid logon. This is required when hybrid_logon_mode is set to PASSWORD.
SID of the user for whom unauthenticated access is to be configured.
Information related to Unauthenticated Access User.
{
"alias_name": "unauthenticated-user",
"description": "example description",
"hybrid_logon_mode": "TRUESSO",
"id": "11bd230b-87ce-3306-a943-810affe7b68a",
"source_pod_ids": [
"310927ee-1195-44c3-b877-5b194b4b4ea8",
"78669598-45b6-44a3-aa0d-11b16d45ab73"
],
"user_id": "S-1-5-21-1111111111-2222222222-3333333333-500"
}
Alias used for login from client.
Description of the unauthenticated access user.
Mode used for hybrid logon.
- PASSWORD: Hybrid logon via username and password.
- TRUESSO: Hybrid logon via True SSO.
- DISABLED: Hybrid logon disabled.
ID of the unauthenticated access configuration for the user.
Pods in which the unauthenticated access user was created. This will be unset if CPA is not initialized or if the caller does not have FEDERATED_LDAP_VIEW privilege.
SID of the user for whom unauthenticated access is configured.
Information related to unentitled Machines.
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.
{
"desktop_pool_name": "manualPool",
"dns_name": "machine1.example.com",
"id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"name": "machine1",
"unentitled_assigned_users": [
"[\"example.com\\user1\"]"
]
}
The name of the Desktop Pool that the machine belongs to.
Supported Filters : 'Equals'. This property can be used for sorting.
DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
Unique ID representing machine.
Supported Filters : 'Equals'.
Name of the machine.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
The display names of the unentitled users assigned to the machine.
Supported Filters : 'Contains'.
{
"concurrent_application_sessions": 5,
"concurrent_collaborative_sessions": 9,
"concurrent_full_vm_sessions": 5,
"concurrent_unmanaged_vm_sessions": 7,
"total_collaborators": 3,
"total_concurrent_connections": 10,
"total_concurrent_sessions": 2,
"total_named_users": 8
}
Number of concurrent application sessions.
Number of sessions where a session owner has invited one or more users for session collaboration.
Number of concurrent sessions for full clone virtual machines.
Number of concurrent sessions for unmanaged machines.
Total number of users that are connected to a collaborative session, including the session owner and any collaborators.
Concurrent connection user count.
Number of connected sessions.
Number of unique users that have accessed the Horizon environment since the Horizon deployment was first configured or since the last Named Users Count reset.
Global Summary Information related to AD Users or Groups.
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'.
See the field description to know the filter types it supports.
{
"application_local_session_ids": [
"bc6fc134-d197-3bbc-a6bf-24dc63123ae6"
],
"container": "example.com/Users",
"description": "Test User account",
"desktop_local_session_ids": [
"bc6fc134-d197-3bbc-a6bf-24dc63123ae6"
],
"display_name": "example.com\\\\testuser",
"distinguished_name": "CN=Test User,CN=Users,DC=example,DC=com",
"domain": "example.com",
"domain_net_bios_name": "example",
"email": "[email protected]",
"first_name": "Test",
"global_application_entitlements": [
"0223796c-102b-4ed3-953f-3dfe3d23e1de"
],
"global_desktop_entitlements": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe"
],
"global_user_application_entitlements": [
"S-1-1-1-3965912346-1012345398-3123456564-123"
],
"global_user_desktop_entitlements": [
"S-1-1-1-3965912346-1012345398-3123456564-123"
],
"group": "boolean",
"id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"kiosk_user": "boolean",
"last_name": "User",
"login_name": "testuser",
"long_display_name": "[email protected] (Test User)",
"name": "Test User",
"phone": "1-877-486-9273",
"pod_assignments": [
"58deeb70-97d5-409e-abb4-497196f1ee18"
],
"unauthenticated_access_user": "boolean",
"user_display_name": "Test User",
"user_home_sites": [
"32a5ea06-cd09-4609-b3e5-df8379e99c13"
],
"user_principal_name": "[email protected]"
}
Ids for local application sessions for this user. This will be unset if this is a group.
AD container for this user or group. This property can be used for sorting.
Description of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Ids for local desktop sessions for this user. This will be unset if this is a group.
Login name with domain of this user or group. This property can be used for sorting.
Active Directory distinguished name for this user or group. This property can be used for sorting.
DNS name of the domain in which this user or group belongs. Supported Filters : 'Equals'. 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. This property can be used for sorting.
The domain netbios the user or group is in. This will be the netbios name of the domain. This property can be used for sorting.
Email address of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
First name of this user or group. This property can be used for sorting.
Global application entitlements for this user. Supported Filters : 'Contains'.
Global desktop entitlements for this user. Supported Filters : 'Contains'.
Global application entitlement user entitlements for this user or group.
Global desktop entitlement user entitlements for this user or group.
Indicates if this object represents a group.
Supported Filters: 'Equals'. This property can be used for sorting.
Unique SID representing this AD User or Group. Supported Filters : 'Equals'. 'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.
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. This property can be used for sorting.
Last name of this user or group. This property can be used for sorting.
Login name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Login name, domain and name for this user or group, else display name. This property can be used for sorting.
Name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Phone number of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Pod assignments per global entitlement, if any, for this user or group. If this is a group, this will be unset.
Whether or not this is unauthenticated access user. Supported Filters : 'Equals'. This property can be used for sorting.
User or group's display name. This corresponds with displayName attribute in AD. This property can be used for sorting.
Home sites for this user or group. There may be home site overrides for each global entitlement specified for this user or group and one default site for the user or group in general.
User Principal name(UPN) of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Local Summary Information related to AD Users or Groups. 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'. See the field description to know the filter types it supports.
{
"application_entitlements": [
"S-1-1-1-3965912346-1012345398-3123456564-123"
],
"application_local_session_ids": [
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"application_pool_ids": [
"0223796c-102b-4ed3-953f-3dfe3d23e1de"
],
"container": "example.com/Users",
"description": "Test User account",
"desktop_entitlements": [
"S-1-1-1-3965912346-1012345398-3123456564-123"
],
"desktop_local_session_ids": [
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"desktop_pool_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe"
],
"display_name": "example.com\\\\testuser",
"distinguished_name": "CN=Test User,CN=Users,DC=example,DC=com",
"domain": "example.com",
"email": "[email protected]",
"first_name": "Test",
"group": "boolean",
"held_user": "boolean",
"id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"kiosk_user": "boolean",
"last_name": "User",
"login_name": "testuser",
"long_display_name": "[email protected] (Test User)",
"machine_ids": [
"0223796c-102b-4ed3-953f-3dfe3d23e1de"
],
"name": "Test User",
"phone": "1-877-486-9273",
"unauthenticated_access_user": "boolean",
"user_display_name": "Test User",
"user_principal_name": "[email protected]"
}
Local application entitlements for this user or group.
Ids for local application sessions for this user.
Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.
AD container for this user or group. This property can be used for sorting.
Description number of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Local desktop entitlements for this user or group.
Ids for local desktop sessions for this user.
Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.
Login name with domain of this user or group. This property can be used for sorting.
Active Directory distinguished name for this user or group. This property can be used for sorting.
DNS name of the domain in which this user or group belongs. Supported Filters : 'Equals'. 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. This property can be used for sorting.
Email address of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
First name of this user or group. This property can be used for sorting.
Indicates if this object represents a group. Supported Filters : 'Equals'. This property can be used for sorting.
Indicates if this user is a "held user". Supported Filters : 'Equals'. This property can be used for sorting.
Unique SID representing this AD User or Group. Supported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.
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. This property can be used for sorting.
Last name of this user or group. This property can be used for sorting.
Login name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Login name, domain and name for this user or group, else display name This property can be used for sorting.
Machines this user or group is assigned to.
Name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Phone number of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Whether or not this is unauthenticated access user.Supported Filters : 'Equals'. This property can be used for sorting.
User or group's display name. This corresponds with displayName attribute in AD. This property can be used for sorting.
User Principal name(UPN) of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Local Summary Information related to AD Users or Groups. 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'. See the field description to know the filter types it supports.
{
"application_entitlements": [
"S-1-1-1-3965912346-1012345398-3123456564-123"
],
"application_local_session_ids": [
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"application_pool_ids": [
"0223796c-102b-4ed3-953f-3dfe3d23e1de"
],
"container": "example.com/Users",
"description": "Test User account",
"desktop_entitlements": [
"S-1-1-1-3965912346-1012345398-3123456564-123"
],
"desktop_local_session_ids": [
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"desktop_pool_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe"
],
"display_name": "example.com\\\\testuser",
"distinguished_name": "CN=Test User,CN=Users,DC=example,DC=com",
"domain": "example.com",
"email": "[email protected]",
"first_name": "Test",
"group": "boolean",
"held_user": "boolean",
"id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"kiosk_user": "boolean",
"last_name": "User",
"login_name": "testuser",
"long_display_name": "[email protected] (Test User)",
"machine_ids": [
"0223796c-102b-4ed3-953f-3dfe3d23e1de"
],
"name": "Test User",
"persistent_disk_ids": [
"c1d5aec7-2126-3c55-aefa-11949003c9c2"
],
"phone": "1-877-486-9273",
"unauthenticated_access_user": "boolean",
"user_display_name": "Test User",
"user_principal_name": "[email protected]"
}
Local application entitlements for this user or group.
Ids for local application sessions for this user.
Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.
AD container for this user or group. This property can be used for sorting.
Description number of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Local desktop entitlements for this user or group.
Ids for local desktop sessions for this user.
Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.
Login name with domain of this user or group. This property can be used for sorting.
Active Directory distinguished name for this user or group. This property can be used for sorting.
DNS name of the domain in which this user or group belongs. Supported Filters : 'Equals'. 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. This property can be used for sorting.
Email address of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
First name of this user or group. This property can be used for sorting.
Indicates if this object represents a group. Supported Filters : 'Equals'. This property can be used for sorting.
Indicates if this user is a "held user". Supported Filters : 'Equals'. This property can be used for sorting.
Unique SID representing this AD User or Group. Supported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.
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. This property can be used for sorting.
Last name of this user or group. This property can be used for sorting.
Login name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Login name, domain and name for this user or group, else display name This property can be used for sorting.
Machines this user or group is assigned to.
Name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
The persistent disk(s) assigned to this user.
Phone number of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Whether or not this is unauthenticated access user.Supported Filters : 'Equals'. This property can be used for sorting.
User or group's display name. This corresponds with displayName attribute in AD. This property can be used for sorting.
User Principal name(UPN) of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
{
"application_entitlements": [
"S-1-1-1-3965912346-1012345398-3123456564-123"
],
"application_local_session_ids": [
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"application_pool_ids": [
"0223796c-102b-4ed3-953f-3dfe3d23e1de"
],
"container": "example.com/Users",
"description": "Test User account",
"desktop_entitlements": [
"S-1-1-1-3965912346-1012345398-3123456564-123"
],
"desktop_local_session_ids": [
"7cdd624f-37d1-46c1-ab96-695a5d13956f"
],
"desktop_pool_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe"
],
"display_name": "example.com\\\\testuser",
"distinguished_name": "CN=Test User,CN=Users,DC=example,DC=com",
"domain": "example.com",
"email": "[email protected]",
"first_name": "Test",
"gateway_access_user": "boolean",
"group": "boolean",
"held_user": "boolean",
"id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"kiosk_user": "boolean",
"last_name": "User",
"login_name": "testuser",
"long_display_name": "[email protected] (Test User)",
"machine_ids": [
"0223796c-102b-4ed3-953f-3dfe3d23e1de"
],
"name": "Test User",
"persistent_disk_ids": [
"c1d5aec7-2126-3c55-aefa-11949003c9c2"
],
"phone": "1-877-486-9273",
"unauthenticated_access_user": "boolean",
"user_display_name": "Test User",
"user_principal_name": "[email protected]"
}
Local application entitlements for this user or group.
Ids for local application sessions for this user.
Local application IDs for which this user has an entitlement. Supported Filters : 'Contains'.
AD container for this user or group. This property can be used for sorting.
Description number of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Local desktop entitlements for this user or group.
Ids for local desktop sessions for this user.
Local desktop IDs for which this user has an entitlement. Supported Filters : 'Contains'.
Login name with domain of this user or group. This property can be used for sorting.
Active Directory distinguished name for this user or group. This property can be used for sorting.
DNS name of the domain in which this user or group belongs. Supported Filters : 'Equals'. 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. This property can be used for sorting.
Email address of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
First name of this user or group. This property can be used for sorting.
Whether or not this is Gateway access user.Supported Filters : 'Equals'. This property can be used for sorting.
Indicates if this object represents a group. Supported Filters : 'Equals'. This property can be used for sorting.
Indicates if this user is a "held user". Supported Filters : 'Equals'. This property can be used for sorting.
Unique SID representing this AD User or Group. Supported Filters : 'Equals'.'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.
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. This property can be used for sorting.
Last name of this user or group. This property can be used for sorting.
Login name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Login name, domain and name for this user or group, else display name This property can be used for sorting.
Machines this user or group is assigned to.
Name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
The persistent disk(s) assigned to this user.
Phone number of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Whether or not this is unauthenticated access user.Supported Filters : 'Equals'. This property can be used for sorting.
User or group's display name. This corresponds with displayName attribute in AD. This property can be used for sorting.
User Principal name(UPN) of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Information related to user policies overrides. Supported Filters : 'Equals', 'StartsWith', 'Contains'.\n" + See the field description to know the filter types it supports.
{
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"desktop_pool_name": "pool",
"effective_policies": {
"allow_multimedia_redirection": "ALLOW",
"allow_pcoip_hardware_acceleration": "ALLOW",
"allow_remote_mode": "ALLOW",
"allow_usb_access": "ALLOW",
"pcoip_hardware_acceleration_priority": "MEDIUM"
},
"user_display_name": "test.local\\user1",
"user_id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"user_policies": {
"allow_multimedia_redirection": "ALLOW",
"allow_pcoip_hardware_acceleration": "ALLOW",
"allow_remote_mode": "ALLOW",
"allow_usb_access": "ALLOW",
"pcoip_hardware_acceleration_priority": "MEDIUM"
},
"user_principal_name": "[email protected]"
}
ID of the desktop pool associated with the user override.
Display name of the Desktop Pool.Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
User or group's display name of the user for whom unentitled policy override is configured. This corresponds with displayName attribute in AD. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
SID of the user.
User Principal name(UPN) of the user for whom policy override is configured.Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Information related to policy overrides for a user.
{
"user_id": "string",
"user_policies": {
"allow_multimedia_redirection": "ALLOW",
"allow_pcoip_hardware_acceleration": "ALLOW",
"allow_remote_mode": "ALLOW",
"allow_usb_access": "ALLOW",
"pcoip_hardware_acceleration_priority": "MEDIUM"
}
}
User SID.
Information related to policy overrides for a user.
{
"user_id": "string",
"user_policies": {
"allow_multimedia_redirection": "ALLOW",
"allow_pcoip_hardware_acceleration": "ALLOW",
"allow_remote_mode": "ALLOW",
"allow_usb_access": "ALLOW",
"pcoip_hardware_acceleration_priority": "MEDIUM"
}
}
User SID.
Information about the limits configured for Virtual Center
{
"instant_clone_engine_provisioning_limit": 20,
"power_operations_limit": 50,
"provisioning_limit": 20
}
Maximum concurrent instant clone engine provisioning operations. This property has a default value of 20. This property has a minimum value of 1.
Maximum concurrent virtual center power operations. This property has a default value of 50. This property has a minimum value of 1.
Maximum concurrent virtual center provisioning operations. This property has a default value of 20. This property has a minimum value of 1.
Information about the limits configured for Virtual Center
{
"instant_clone_engine_provisioning_limit": 20,
"instant_clone_maintenance_limit": 12,
"power_operations_limit": 50,
"provisioning_limit": 20
}
Maximum concurrent instant clone engine provisioning operations. This property has a default value of 20. This property has a minimum value of 1.
Maximum concurrent view composer refit operations. This property has a default value of 12. This property has a minimum value of 1.
Maximum concurrent virtual center power operations. This property has a default value of 50. This property has a minimum value of 1.
Maximum concurrent virtual center provisioning operations. This property has a default value of 20. This property has a minimum value of 1.
Information about the limits configured for Virtual Center
{
"instant_clone_engine_provisioning_limit": 20,
"instant_clone_maintenance_limit": 12,
"power_operations_limit": 50,
"provisioning_limit": 20
}
Maximum concurrent instant clone engine provisioning operations. This property has a default value of 20. This property has a minimum value of 1.
Maximum concurrent view composer refit operations. This property has a default value of 12. This property has a minimum value of 1.
Maximum concurrent virtual center power operations. This property has a default value of 50. This property has a minimum value of 1.
Maximum concurrent virtual center provisioning operations. This property has a default value of 20. This property has a minimum value of 1.
Information about the limits configured for Virtual Center
{
"instant_clone_engine_provisioning_limit": 20,
"instant_clone_maintenance_limit": 12,
"power_operations_limit": 50,
"provisioning_limit": 20
}
Maximum concurrent instant clone engine provisioning operations. This property has a default value of 20. This property has a minimum value of 1.
Maximum concurrent view composer refit operations. This property has a default value of 12. This property has a minimum value of 1.
Maximum concurrent virtual center power operations. This property has a default value of 50. This property has a minimum value of 1.
Maximum concurrent virtual center provisioning operations. This property has a default value of 20. This property has a minimum value of 1.
Information about connection to Virtual Center from Connection Server.
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": true
}
Unique ID of the Connection Server.
Connection server host name or IP address.
Status of the Virtual Center Connection with respect to this Connection Server.
- OK: The connection to Virtual Center server is working properly.
- DOWN: The connection to Virtual Center server is down.
- RECONNECTING: The connection to Virtual Center server was lost and is being reconnected to.
- UNKNOWN: Connection state to Virtual Center server is unknown.
- INVALID_CREDENTIALS: The supplied credentials cannot be used to authenticate to the Virtual Center server.
- CANNOT_LOGIN: The connection server cannot login to the Virtual Center server.
- NOT_YET_CONNECTED: Connection server has not yet connected to Virtual Center server.
Indicates if the thumbprints of the Virtual Center was accepted.
Information about connection to Virtual Center from Connection Server.
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": true
}
Unique ID of the Connection Server.
The timestamp in milliseconds when the last update was obtained. Measured as epoch time.
Connection server host name or IP address.
Status of the Virtual Center Connection with respect to this Connection Server.
- OK: The connection to Virtual Center server is working properly.
- DOWN: The connection to Virtual Center server is down.
- RECONNECTING: The connection to Virtual Center server was lost and is being reconnected to.
- UNKNOWN: Connection state to Virtual Center server is unknown.
- INVALID_CREDENTIALS: The supplied credentials cannot be used to authenticate to the Virtual Center server.
- CANNOT_LOGIN: The connection server cannot login to the Virtual Center server.
- NOT_YET_CONNECTED: Connection server has not yet connected to Virtual Center server.
Indicates if the thumbprints of the Virtual Center was accepted.
Information about the datastore of the host(s) connected to the given Virtual Center.
{
"capacity_mb": 12345,
"details": {
"name": "vsandatastore",
"path": "/datacenter1/vsandatastore",
"url": "ds:///vmfs/volumes/vsan:52654c2aa8e79416-8ea7a3309e82c7b7/"
},
"free_space_mb": 12345,
"status": "ACCESSIBLE",
"type": "VSAN"
}
The capacity of the datastore in megabytes.
The free space on the datastore in megabytes.
Status of the datastore.
- ACCESSIBLE: The datastore is accessible.
- NOT_ACCESSIBLE: The datastore is not accessible.
Type of the datastore.
- VMFS: VMFS datastore.
- VSAN: VSAN datastore.
- VVOL: VVOL datastore.
Details about the datastore.
{
"name": "vsandatastore",
"path": "/datacenter1/vsandatastore",
"url": "ds:///vmfs/volumes/vsan:52654c2aa8e79416-8ea7a3309e82c7b7/"
}
Datastore name.
Path to the datastore.
Unique locator for datastore.
Details about the Virtual Center.
{
"api_version": "6.5",
"build": "12345678.0.1",
"version": "6.5.0"
}
API Version of the Virtual Center.
Build number of the Virtual Center.
Version of the Virtual Center.
Information about the host connected to a Virtual Center.
{
"cpu_core_count": 16,
"cpu_mhz": 2194,
"details": {
"api_version": "6.5",
"cluster_name": "cluster-1",
"name": "host1.example.com",
"version": "6.5.0",
"vgpu_types": [
"string"
]
},
"memory_size_mb": 12345,
"status": "CONNECTED"
}
Number of physical CPU cores on the host.
CPU speed per core in Mhz. This might be an averaged value if the speed is not uniform across all cores.
The physical memory size in mega bytes.
Status of the host connection.
- CONNECTED: The host is successfully connected to Virtual Center server.
- DISCONNECTED: The host is disconnected from Virtual Center server.
- NOT_RESPONDING: The host is not responding.
Details of the ESX host of the Virtual Center.
{
"api_version": "6.5",
"cluster_name": "cluster-1",
"name": "host1.example.com",
"version": "6.5.0",
"vgpu_types": [
"string"
]
}
API Version of the ESX Host.
Name of the cluster of the ESX Host in the Virtual Center.
ESX Host name or IP address.
ESX Host version.
Types of vGPUs supported by this host.
Information about the host connected to a Virtual Center.
{
"cpu_core_count": 16,
"cpu_mhz": 2194,
"details": {
"api_version": "6.5",
"cluster_name": "cluster-1",
"name": "host1.example.com",
"version": "6.5.0",
"vgpu_types": [
"string"
]
},
"memory_size_mb": 12345,
"overall_cpu_usage_mhz": 1209,
"overall_memory_usage_mb": 66569,
"status": "CONNECTED"
}
Number of physical CPU cores on the host.
CPU speed per core in Mhz. This might be an averaged value if the speed is not uniform across all cores.
The physical memory size in mega bytes.
Aggregated CPU usage across all cores on the host, in MHz.
Physical memory usage on the host, in MBs.
Status of the host connection.
- CONNECTED: The host is successfully connected to Virtual Center server.
- DISCONNECTED: The host is disconnected from Virtual Center server.
- NOT_RESPONDING: The host is not responding.
Information related to VM folder.
{
"children": [],
"datacenter_id": "datacenter-1",
"id": "group-v1",
"incompatible_reasons": [
"string"
],
"name": "Discovered virtual machine",
"path": "/Datacenter/vm/Discovered virtual machine",
"type": "FOLDER",
"vcenter_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e"
}
Datacenter id for this VM folder.
Unique ID representing the VM folder.
Reasons that may preclude this VM folder from being used in desktop pool or farm.
VM folder name.
VM folder path.
VM folder type.
- DATACENTER: A datacenter that serves as a folder suitable for use in desktop pool/farm.
- FOLDER: A regular folder suitable for use in desktop pool/farm.
- OTHER: Other folder type that cannot be used in desktop pool/farm.
Virtual Center id for this VM folder.
Information related to VM template. Supported Filters : 'Equals'.
{
"datacenter_id": "datacenter-1",
"disk_size_in_bytes": 42949672960,
"id": "vm-1",
"incompatible_reasons": [
"string"
],
"memory_mb": 4096,
"name": "Win10Template",
"operating_system": "WINDOWS_10",
"operating_system_display_name": "Microsoft Windows 10 (64-bit)",
"path": "/Datacenter/vm/Templates/Win10Template",
"vcenter_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"vgpu_type": "string"
}
Datacenter id for this VM template. Supported Filters : 'Equals'.
Sum of capacities of all the virtual disks in the template, in bytes. Supported Filters : 'Equals','Between'.
Unique ID representing a VM template. Supported Filters : 'Equals'.
Reasons that may preclude this VM template from being used in full clone desktop pool creation. Supported Filters : 'Equals'.
Memory size of the VM template, in MB Supported Filters : 'Equals','Between'.
VM template name. Supported Filters : 'Equals','StartsWith','Contains'.
Operating system. Supported Filters : 'Equals'.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
Operating system display name from Virtual Center. Supported Filters : 'Equals'.
VM template path. Supported Filters : 'Equals','StartsWith','Contains'.
ID of the vCenter to which this VM template belongs to. Supported Filters : 'Equals'.
NVIDIA GRID vGPU type configured on this VM template. Supported Filters : 'Equals'.
Information about the View Composer connection from connection server.
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": "boolean"
}
Unique ID of the Connection Server.
Connection server host name or IP address.
Status of the View Composer with respect to this Connection Server.
- OK: The connection to View Composer server is working properly.
- MALFORMED_URL: The connection to View Composer server was not possible due to a malformed URL.
- ERROR: Error occurred when connecting to View Composer server.
- CERT_ERROR: Certificate validation error when connecting to the View Composer server.
Indicates if the thumbprint of the View Composer was accepted.
Information about the View Composer connection from connection server.
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": "boolean"
}
Unique ID of the Connection Server.
The timestamp in milliseconds when the last update was obtained. Measured as epoch time.
Connection server host name or IP address.
Status of the View Composer with respect to this Connection Server.
- OK: The connection to View Composer server is working properly.
- MALFORMED_URL: The connection to View Composer server was not possible due to a malformed URL.
- ERROR: Error occurred when connecting to View Composer server.
- CERT_ERROR: Certificate validation error when connecting to the View Composer server.
Indicates if the thumbprint of the View Composer was accepted.
Details of the View Composer.
{
"api_verion": "3.5",
"build": "1234567",
"min_esx_version": "5.5",
"min_vc_version": "5.5",
"referenced_vcs": [
"string"
],
"version": "7.9.0.12345"
}
The version of the View Composer API used to communicate with the View Composer server.
The build of the View Composer server.
The minimum ESX version required for compatibility with this View Composer server.
The minimum Virtual Center version required for compatibility with this View Composer server.
The Virtual Center servers referencing to this View Composer.
The version of the View Composer server.
Monitoring information related to View Composer.
{
"connection_servers": [
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": "boolean"
}
],
"details": {
"api_verion": "3.5",
"build": "1234567",
"min_esx_version": "5.5",
"min_vc_version": "5.5",
"referenced_vcs": [
"string"
],
"version": "7.9.0.12345"
},
"name": "composer1.example.com",
"port": 18443
}
Information about the View Composer connections from each of the connection servers.
View Composer server host name or IP address.
View Composer server port number.
Monitoring information related to View Composer.
{
"connection_servers": [
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": "boolean"
}
],
"details": {
"api_verion": "3.5",
"build": "1234567",
"min_esx_version": "5.5",
"min_vc_version": "5.5",
"referenced_vcs": [
"string"
],
"version": "7.9.0.12345"
},
"name": "composer1.example.com",
"port": 18443
}
Information about the View Composer connections from each of the connection servers.
View Composer server host name or IP address.
View Composer server port number.
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.
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
List of days for a given range of time.
Ending time for the blackout in 24-hour format.
Starting time for the blackout in 24-hour format.
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.
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
List of days for a given range of time.
Ending time for the blackout in 24-hour format.
Starting time for the blackout in 24-hour format.
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.
{
"days": [
"MONDAY",
"TUESDAY"
],
"end_time": "22:00",
"start_time": "10:00"
}
List of days for a given range of time.
Ending time for the blackout in 24-hour format.
Starting time for the blackout in 24-hour format.
Virtual Center object to be created.
{
"certificate_override": {
"certificate": "string",
"type": "PEM"
},
"deployment_type": "GENERAL",
"description": "Virtual Center Server",
"display_name": "vc1.example.com",
"limits": {
"instant_clone_engine_provisioning_limit": 20,
"instant_clone_maintenance_limit": 12,
"power_operations_limit": 50,
"provisioning_limit": 20
},
"password": [
"<password>"
],
"port": 443,
"se_sparse_reclamation_enabled": true,
"server_name": "vc1.example.com",
"storage_accelerator_data": {
"default_cache_size_mb": 1024,
"enabled": "boolean",
"host_overrides": [
{
"cache_size_mb": 2048,
"path": "/path/host"
}
]
},
"user_name": "[email protected]"
}
Indicates different environments that Horizon can be deployed into.
- GENERAL: Horizon is deployed on On-premises.
- AZURE: Horizon is deployed on Azure.
- AWS: Horizon is deployed on AWS.
- DELL_EMC: Horizon is deployed on Dell EMC.
- GOOGLE: Horizon is deployed on Google Cloud.
- ORACLE: Horizon is deployed on Oracle Cloud.
Human readable description of the Virtual Center instance.
Human readable display name of the virtual center instance.
Password to use for the connection
Port of the virtual center to connect to.
Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.
Virtual Center’s server name or IP address
User name to use for the connection.
Virtual Center object to be created.
{
"certificate_override": {
"certificate": "string",
"type": "PEM"
},
"deployment_type": "GENERAL",
"description": "Virtual Center Server",
"display_name": "vc1.example.com",
"instant_clone_debug_enabled": "boolean",
"limits": {
"instant_clone_engine_provisioning_limit": 20,
"instant_clone_maintenance_limit": 12,
"power_operations_limit": 50,
"provisioning_limit": 20
},
"password": [
"<password>"
],
"port": 443,
"se_sparse_reclamation_enabled": true,
"server_name": "vc1.example.com",
"storage_accelerator_data": {
"default_cache_size_mb": 1024,
"enabled": "boolean",
"host_overrides": [
{
"cache_size_mb": 2048,
"path": "/path/host"
}
]
},
"user_name": "[email protected]"
}
Indicates different environments that Horizon can be deployed into.
- GENERAL: Horizon is deployed on On-premises.
- AZURE: Horizon is deployed on Azure.
- AWS: Horizon is deployed on AWS.
- DELL_EMC: Horizon is deployed on Dell EMC.
- GOOGLE: Horizon is deployed on Google Cloud.
- ORACLE: Horizon is deployed on Oracle Cloud.
Human readable description of the Virtual Center instance.
Human readable display name of the virtual center instance.
Indicates if instant clone debug mode is enabled
Password to use for the connection
Port of the virtual center to connect to.
Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.
Virtual Center’s server name or IP address
User name to use for the connection.
Information related to Virtual Center.
{
"certificate_override": {
"certificate": "string",
"type": "PEM"
},
"description": "Virtual Center Server",
"display_name": "vc1.example.com",
"enabled": true,
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"instance_uuid": "6605d116-d1b5-4810-8e3a-b710b30993da",
"limits": {
"instant_clone_engine_provisioning_limit": 20,
"power_operations_limit": 50,
"provisioning_limit": 20
},
"port": 443,
"se_sparse_reclamation_enabled": true,
"server_name": "vc1.example.com",
"storage_accelerator_data": {
"default_cache_size_mb": 1024,
"enabled": "boolean",
"host_overrides": [
{
"cache_size_mb": 2048,
"path": "/path/host"
}
]
},
"use_ssl": true,
"user_name": "[email protected]",
"version": "6.5.0",
"vmc_deployment": "boolean"
}
Human readable description of the Virtual Center instance.
Human readable name of the Virtual Center instance.
Indicates if the virtual center is enabled.
Unique ID of the Virtual Center.
Virtual center's instanceUuid.
Port of the virtual center to connect to.
Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.
Virtual Center's server name or IP address.
Indicates if SSL should be used when connecting to the server.
User name to use for the connection.
Version of the Virtual Center.
Indicates if virtual center is deployed in VMC.
Information related to Virtual Center.
{
"certificate_override": {
"certificate": "string",
"type": "PEM"
},
"deployment_type": "string",
"description": "Virtual Center Server",
"display_name": "vc1.example.com",
"enabled": true,
"has_virtual_tpm_pools": "boolean",
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"instance_uuid": "6605d116-d1b5-4810-8e3a-b710b30993da",
"limits": {
"instant_clone_engine_provisioning_limit": 20,
"power_operations_limit": 50,
"provisioning_limit": 20
},
"maintenance_mode": "boolean",
"port": 443,
"se_sparse_reclamation_enabled": true,
"server_name": "vc1.example.com",
"storage_accelerator_data": {
"default_cache_size_mb": 1024,
"enabled": "boolean",
"host_overrides": [
{
"cache_size_mb": 2048,
"path": "/path/host"
}
]
},
"use_ssl": true,
"user_name": "[email protected]",
"version": "6.5.0",
"virtualTPMPools": "boolean"
}
Indicates different environments that Horizon can be deployed into.
- GENERAL: Horizon is deployed on On-premises.
- AZURE: Horizon is deployed on Azure.
- AWS: Horizon is deployed on AWS.
- DELL_EMC: Horizon is deployed on Dell EMC.
- GOOGLE: Horizon is deployed on Google Cloud.
- ORACLE: Horizon is deployed on Oracle Cloud.
Human readable description of the Virtual Center instance.
Human readable name of the Virtual Center instance.
Indicates if the virtual center is enabled.
Indicates if there is any instant clone Desktop pool associated with this Virtual Center which has addVirtualTPM set
Unique ID of the Virtual Center.
Virtual center's instanceUuid.
Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts
Port of the virtual center to connect to.
Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.
Virtual Center's server name or IP address.
Indicates if SSL should be used when connecting to the server.
User name to use for the connection.
Version of the Virtual Center.
virtualTPMPools
Information related to Virtual Center.
{
"certificate_override": {
"certificate": "string",
"type": "PEM"
},
"deployment_type": "string",
"description": "Virtual Center Server",
"display_name": "vc1.example.com",
"enabled": true,
"has_virtual_tpm_pools": "boolean",
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"instance_uuid": "6605d116-d1b5-4810-8e3a-b710b30993da",
"limits": {
"instant_clone_engine_provisioning_limit": 20,
"instant_clone_maintenance_limit": 12,
"power_operations_limit": 50,
"provisioning_limit": 20
},
"maintenance_mode": "boolean",
"port": 443,
"se_sparse_reclamation_enabled": true,
"server_name": "vc1.example.com",
"storage_accelerator_data": {
"default_cache_size_mb": 1024,
"enabled": "boolean",
"host_overrides": [
{
"cache_size_mb": 2048,
"path": "/path/host"
}
]
},
"use_ssl": true,
"user_name": "[email protected]",
"version": "6.5.0",
"virtualTPMPools": "boolean"
}
Indicates different environments that Horizon can be deployed into.
- GENERAL: Horizon is deployed on On-premises.
- AZURE: Horizon is deployed on Azure.
- AWS: Horizon is deployed on AWS.
- DELL_EMC: Horizon is deployed on Dell EMC.
- GOOGLE: Horizon is deployed on Google Cloud.
- ORACLE: Horizon is deployed on Oracle Cloud.
Human readable description of the Virtual Center instance.
Human readable name of the Virtual Center instance.
Indicates if the virtual center is enabled.
Indicates if there is any instant clone Desktop pool associated with this Virtual Center which has addVirtualTPM set
Unique ID of the Virtual Center.
Virtual center's instanceUuid.
Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts
Port of the virtual center to connect to.
Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.
Virtual Center's server name or IP address.
Indicates if SSL should be used when connecting to the server.
User name to use for the connection.
Version of the Virtual Center.
virtualTPMPools
Information related to Virtual Center.
{
"certificate_override": {
"certificate": "string",
"type": "PEM"
},
"deployment_type": "string",
"description": "Virtual Center Server",
"display_name": "vc1.example.com",
"enabled": true,
"has_virtual_tpm_pools": "boolean",
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"instance_uuid": "6605d116-d1b5-4810-8e3a-b710b30993da",
"instant_clone_debug_enabled": "boolean",
"limits": {
"instant_clone_engine_provisioning_limit": 20,
"instant_clone_maintenance_limit": 12,
"power_operations_limit": 50,
"provisioning_limit": 20
},
"maintenance_mode": "boolean",
"port": 443,
"se_sparse_reclamation_enabled": true,
"server_name": "vc1.example.com",
"storage_accelerator_data": {
"default_cache_size_mb": 1024,
"enabled": "boolean",
"host_overrides": [
{
"cache_size_mb": 2048,
"path": "/path/host"
}
]
},
"use_ssl": true,
"user_name": "[email protected]",
"version": "6.5.0",
"virtualTPMPools": "boolean"
}
Indicates different environments that Horizon can be deployed into.
- GENERAL: Horizon is deployed on On-premises.
- AZURE: Horizon is deployed on Azure.
- AWS: Horizon is deployed on AWS.
- DELL_EMC: Horizon is deployed on Dell EMC.
- GOOGLE: Horizon is deployed on Google Cloud.
- ORACLE: Horizon is deployed on Oracle Cloud.
Human readable description of the Virtual Center instance.
Human readable name of the Virtual Center instance.
Indicates if the virtual center is enabled.
Indicates if there is any instant clone Desktop pool associated with this Virtual Center which has addVirtualTPM set
Unique ID of the Virtual Center.
Virtual center's instanceUuid.
Indicates if instant clone debug mode is enabled
Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts
Port of the virtual center to connect to.
Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.
Virtual Center's server name or IP address.
Indicates if SSL should be used when connecting to the server.
User name to use for the connection.
Version of the Virtual Center.
virtualTPMPools
Information related to Virtual Center.
{
"certificate_override": {
"certificate": "string",
"type": "PEM"
},
"deployment_type": "string",
"description": "Virtual Center Server",
"display_name": "vc1.example.com",
"enabled": true,
"has_virtual_tpm_pools": "boolean",
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"instance_uuid": "6605d116-d1b5-4810-8e3a-b710b30993da",
"instant_clone_debug_enabled": "boolean",
"limits": {
"instant_clone_engine_provisioning_limit": 20,
"instant_clone_maintenance_limit": 12,
"power_operations_limit": 50,
"provisioning_limit": 20
},
"maintenance_mode": "boolean",
"port": 443,
"se_sparse_reclamation_enabled": true,
"server_name": "vc1.example.com",
"storage_accelerator_data": {
"default_cache_size_mb": 1024,
"enabled": "boolean",
"host_overrides": [
{
"cache_size_mb": 2048,
"path": "/path/host"
}
]
},
"use_ssl": true,
"user_name": "[email protected]",
"version": "6.5.0",
"virtualTPMPools": "boolean",
"vsan_validation_status": "false"
}
Indicates different environments that Horizon can be deployed into.
- GENERAL: Horizon is deployed on On-premises.
- AZURE: Horizon is deployed on Azure.
- AWS: Horizon is deployed on AWS.
- DELL_EMC: Horizon is deployed on Dell EMC.
- GOOGLE: Horizon is deployed on Google Cloud.
- ORACLE: Horizon is deployed on Oracle Cloud.
Human readable description of the Virtual Center instance.
Human readable name of the Virtual Center instance.
Indicates if the virtual center is enabled.
Indicates if there is any instant clone Desktop pool associated with this Virtual Center which has addVirtualTPM set
Unique ID of the Virtual Center.
Virtual center's instanceUuid.
Indicates if instant clone debug mode is enabled
Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts
Port of the virtual center to connect to.
Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.
Virtual Center's server name or IP address.
Indicates if SSL should be used when connecting to the server.
User name to use for the connection.
Version of the Virtual Center.
virtualTPMPools
Indicates if instant clone debug mode is enabled
- OK: vSAN is compatible with the virtual center.
- UNSUPPORTED_VC: vSAN is not supported on the virtual center.
- UNSUPPORTED_HOST_OR_CLUSTER: vSAN is not supported on the host or cluster.
- NOT_CONFIGURED: vSAN is not configured on the virtual center.
Monitoring information related to a Virtual Center
{
"connection_servers": [
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": true
}
],
"datastores": [
{
"capacity_mb": 12345,
"details": {
"name": "vsandatastore",
"path": "/datacenter1/vsandatastore",
"url": "ds:///vmfs/volumes/vsan:52654c2aa8e79416-8ea7a3309e82c7b7/"
},
"free_space_mb": 12345,
"status": "ACCESSIBLE",
"type": "VSAN"
}
],
"desktops_count": "integer",
"details": {
"api_version": "6.5",
"build": "12345678.0.1",
"version": "6.5.0"
},
"hosts": [
{
"cpu_core_count": 16,
"cpu_mhz": 2194,
"details": {
"api_version": "6.5",
"cluster_name": "cluster-1",
"name": "host1.example.com",
"version": "6.5.0",
"vgpu_types": [
"string"
]
},
"memory_size_mb": 12345,
"status": "CONNECTED"
}
],
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"name": "vc1.example.com"
}
Information about the Virtual Center connections from each of the connection servers.
Information about the datastores of the Virtual Center.
Number of Desktop Pools And Farms managed by the virtual center.
Unique ID of the Virtual Center.
Virtual Center server name or IP address.
Monitoring information related to a Virtual Center
{
"connection_servers": [
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": true
}
],
"datastores": [
{
"capacity_mb": 12345,
"details": {
"name": "vsandatastore",
"path": "/datacenter1/vsandatastore",
"url": "ds:///vmfs/volumes/vsan:52654c2aa8e79416-8ea7a3309e82c7b7/"
},
"free_space_mb": 12345,
"status": "ACCESSIBLE",
"type": "VSAN"
}
],
"desktop_pools_and_farms_count": "integer",
"details": {
"api_version": "6.5",
"build": "12345678.0.1",
"version": "6.5.0"
},
"hosts": [
{
"cpu_core_count": 16,
"cpu_mhz": 2194,
"details": {
"api_version": "6.5",
"cluster_name": "cluster-1",
"name": "host1.example.com",
"version": "6.5.0",
"vgpu_types": [
"string"
]
},
"memory_size_mb": 12345,
"status": "CONNECTED"
}
],
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"name": "vc1.example.com"
}
Information about the Virtual Center connections from each of the connection servers.
Information about the datastores of the Virtual Center.
Number of Desktop Pools And Farms managed by the virtual center
Unique ID of the Virtual Center.
Virtual Center server name or IP address.
Monitoring information related to a Virtual Center
{
"connection_servers": [
{
"certificate": {
"valid": true,
"valid_from": 1561939200000,
"valid_to": 1561939200000
},
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"last_updated_timestamp": 1582029025748,
"name": "cs1.example.com",
"status": "OK",
"thumbprint_accepted": true
}
],
"datastores": [
{
"capacity_mb": 12345,
"details": {
"name": "vsandatastore",
"path": "/datacenter1/vsandatastore",
"url": "ds:///vmfs/volumes/vsan:52654c2aa8e79416-8ea7a3309e82c7b7/"
},
"free_space_mb": 12345,
"status": "ACCESSIBLE",
"type": "VSAN"
}
],
"desktop_pools_and_farms_count": "integer",
"details": {
"api_version": "6.5",
"build": "12345678.0.1",
"version": "6.5.0"
},
"hosts_v2": [
{
"cpu_core_count": 16,
"cpu_mhz": 2194,
"details": {
"api_version": "6.5",
"cluster_name": "cluster-1",
"name": "host1.example.com",
"version": "6.5.0",
"vgpu_types": [
"string"
]
},
"memory_size_mb": 12345,
"overall_cpu_usage_mhz": 1209,
"overall_memory_usage_mb": 66569,
"status": "CONNECTED"
}
],
"id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
"name": "vc1.example.com"
}
Information about the Virtual Center connections from each of the connection servers.
Information about the datastores of the Virtual Center.
Number of Desktop Pools And Farms managed by the virtual center
Information about the ESX hosts added in the Virtual Center.
Unique ID of the Virtual Center.
Virtual Center server name or IP address.
Virtual Center object to be updated.
{
"certificate_override": {
"certificate": "string",
"type": "PEM"
},
"description": "Virtual Center Server",
"display_name": "vc1.example.com",
"enabled": true,
"limits": {
"instant_clone_engine_provisioning_limit": 20,
"instant_clone_maintenance_limit": 12,
"power_operations_limit": 50,
"provisioning_limit": 20
},
"maintenance_mode": "boolean",
"password": [
"<password>"
],
"port": 443,
"se_sparse_reclamation_enabled": true,
"server_name": "vc1.example.com",
"storage_accelerator_data": {
"default_cache_size_mb": 1024,
"enabled": "boolean",
"host_overrides": [
{
"cache_size_mb": 2048,
"path": "/path/host"
}
]
},
"user_name": "[email protected]"
}
Human readable description of the Virtual Center instance.
Human readable display name of the virtual center instance.
Indicates if the virtual center is enabled.
Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts
Password to use for the connection
Port of the virtual center to connect to.
Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.
Virtual Center’s server name or IP address
User name to use for the connection.
Virtual Center object to be updated.
{
"certificate_override": {
"certificate": "string",
"type": "PEM"
},
"description": "Virtual Center Server",
"display_name": "vc1.example.com",
"enabled": true,
"instant_clone_debug_enabled": "boolean",
"limits": {
"instant_clone_engine_provisioning_limit": 20,
"instant_clone_maintenance_limit": 12,
"power_operations_limit": 50,
"provisioning_limit": 20
},
"maintenance_mode": "boolean",
"password": [
"<password>"
],
"port": 443,
"se_sparse_reclamation_enabled": true,
"server_name": "vc1.example.com",
"storage_accelerator_data": {
"default_cache_size_mb": 1024,
"enabled": "boolean",
"host_overrides": [
{
"cache_size_mb": 2048,
"path": "/path/host"
}
]
},
"user_name": "[email protected]"
}
Human readable description of the Virtual Center instance.
Human readable display name of the virtual center instance.
Indicates if the virtual center is enabled.
Indicates if instant clone debug mode is enabled
Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts
Password to use for the connection
Port of the virtual center to connect to.
Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.
Virtual Center’s server name or IP address
User name to use for the connection.
Information related to a virtual disk.
{
"capacity_mb": 102400,
"datastore_path": "datastore1",
"path": "/path/host"
}
The disk capacity in MB.
The virtual disk's datastore.
The virtual disk path.
Information related to virtual disk.
{
"attached": "boolean",
"datastore_id": "datastore-29",
"id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"incompatible_reason": "string",
"name": "virtual-disk.vmdk",
"path": "[datastore] vm/virtual-disk.vmdk"
}
Indicates the virtual disk is attached to a VM.
Datastore id for this virtual disk.
Unique ID representing the virtual disk.
Incompatible reasons for the virtual disk.
- REPLICA_DISK: Replica Disks are not compatible to be used as Persistent disk.
- INTERNAL_DISK: Internal disk are not compatible to be used as Persistent disk.
- DISPOSABLE_DISK: Disposable disk are not compatible to be used as Persistent disk.
- DISK_ALREADY_IN_USE: Disk already imported as persistent disk.
- INSTANT_CLONE_INTERNAL_DISK: Instant clone internal disk is not compatible to be a Persistent disk.
Name of the virtual disk.
Full path of the virtual disk.
Information related to a Virtual Machine.
{
"getvGPUType": "datacenter-1",
"hardware_version": "integer",
"id": "vm-416",
"incompatible_reasons": [
"string"
],
"name": "Win10",
"operating_system": "WINDOWS_10",
"operating_system_display_name": "Microsoft Windows 10 (64-bit)",
"path": "/Datacenter/vm/VMs/Win10"
}
Virtual GPU type.
Hardware version for this VM.
Unique ID representing a VM.
Reasons that may preclude this Virtual Machine from having its snapshots used in linked or instant clone desktop or farm.
VM name.
Operating system.
- LINUX_CENTOS: Linux (CentOS)
- LINUX_OTHER: Linux (other)
- LINUX_RHEL: Linux (Red Hat Enterprise)
- LINUX_SERVER_OTHER: Linux server (other)
- LINUX_SUSE: Linux (Suse)
- LINUX_UBUNTU: Linux (Ubuntu)
- UNKNOWN: Unknown
- WINDOWS_10: Windows 10
- WINDOWS_11: Windows 11
- WINDOWS_7: Windows 7
- WINDOWS_8: Windows 8
- WINDOWS_SERVER_2003: Windows Server 2003
- WINDOWS_SERVER_2008: Windows Server 2008
- WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
- WINDOWS_SERVER_2012: Windows Server 2012
- WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
- WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
- WINDOWS_VISTA: Windows Vista
- WINDOWS_XP: Windows XP
Operating system display name from Virtual Center.
VM path.
Virtual SAN datastore cost Info.
{
"full_clone_factor": 1,
"os_factor": 1,
"replica_factor": 1,
"user_data_factor": 1
}
Multiplicative factor for full clone disk that is needed to account for the extra copies that are created for VSAN.
Multiplicative factor for OS disk that is needed to account for the extra copies that are created for VSAN.
Multiplicative factor for replica disk that is needed to account for the extra copies that are created for VSAN.
Multiplicative factor for user data disk that is needed to account for the extra copies that are created for VSAN.