Get Connection Server V2
At least one of the listed privileges is required -
| Privileges | Description |
|---|---|
| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to perform this operation. |
| INVENTORY_ADMINISTRATOR_VIEW | Caller should have permission to this privilege, to perform this operation. |
| POOL_VIEW | Caller should have permission to this privilege, to perform this operation. |
id
OK
{
"auxillary_external_pcoip_ipv4_address": "127.0.0.1:4172",
"bypass_app_blast_gateway": false,
"bypass_pcoip_gateway": true,
"bypass_tunnel": false,
"cluster_name": "Cluster-CS1",
"direct_htmlabsg": false,
"disclose_service_principal_name": false,
"enable_smart_card_user_name_hint": false,
"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": false,
"fqhn": "cs1.example.com",
"gss_apiinfo": {
"allow_receiving_ntlm": false,
"gss_apiauthenticator_id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"gss_apienabled": false
},
"has_blast_gateway_support": true,
"has_pcoip_gateway_support": true,
"host_redirection": false,
"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": false,
"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": 0
},
"load_balancer_hosts": [
"10.217.68.253",
"10.217.68.254"
],
"local_connection_server": true,
"logoff_when_remove_smart_card": false,
"message_security_enhanced_mode_supported": false,
"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": false,
"radius_name_mapping": false,
"radius_sso": false
},
"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": false,
"name_mapping": false,
"secure_id_enabled": false,
"security_file_uploaded": false
},
"saml_info": {
"saml_authenticator_ids": [
"42e47f15-aad0-221a-b231-ea4a3a134ec9",
"d0325b13-2bf1-4fa4-b027-e780004f2d1e"
],
"saml_support": "DISABLED",
"workspace_one_block_old_clients": false,
"workspace_one_host_name": "workspaceone.com",
"workspace_one_mode_enabled": false
},
"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": false,
"client_puzzle_difficulty": 21,
"default_unauth_user_id": "11bd230b-87ce-3306-a943-810affe7b68a",
"enabled": false,
"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.
User is not authenticated
Access to the resource is forbidden
Not Found