Data Object - ConnectionServerGeneralData

Class
VMware.Hv.GeneralData
Property of
ConnectionServerInfo
Since
Horizon View 6.0

Data Object Description

The General Configuration for the Connection Server.

Data Object Properties

Properties

Name Type Description
namexsd:string

Name of the connection server
  • This property cannot be updated.
serverAddressxsd:string

General URL for the connection server.
  • This property cannot be updated.
enabledxsd:boolean

Indicate whether the connection server is enabled. A disabled connection server will not accept connection requests from View Clients.
tagsxsd:string[]

Tags to restrict accessibility to desktops through this server.
  • This property need not be set.
  • This property is an unordered array of unique values.
externalURLxsd:string

View 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 View Client.
The External URL must not be load balanced.
If bypassTunnel is set to true, this is ignored.
This should be in the form "<(DNS name)|(IPv4)|(IPv6)><:(port)>". IPv6 addresses must be enclosed in square brackets.
  • This property need not be set.
externalPCoIPURLxsd:string

View 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 bypassPCoIPGateway is set to true, this is ignored.
This should be in the form "<(DNS name)|(IPv4)|(IPv6)>[:(port encoding)]". The port encoding part may be omitted, may specify a single port to represent both the TCP and UDP ports, or may specify them individually in the form "(TCP port)?(UDP port)". Unspecified ports default to 4172. IPv6 addresses must be enclosed in square brackets.
  • This property need not be set.
auxillaryExternalPCoIPIPv4Addressxsd:string

This can only be set if externalPCoIPURL 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 bypassPCoIPGateway is set to true, this is ignored.

Since Horizon View 6.1
  • This property need not be set.
externalAppblastURLxsd:string

The Blast External URL enables browser access to View machines through this Connection Server instance or a paired security server.
To enable Blast, you must install HTML Access.
The Blast External URL must not be load balanced.
If bypassAppBlastGateway is set to true, this is ignored.
This should be in the form "<(DNS name)|(IPv4)|(IPv6)>[:(port)]". Unspecified ports default to 8443. IPv6 addresses must be enclosed in square brackets.
  • This property need not be set.
localConnectionServerxsd:boolean

Indicates whether this is the local connection server that handled the ConnectionServer service request.

Since Horizon 7.4
  • This property need not be set.
  • This property cannot be updated.
bypassTunnelxsd:boolean

Setting this to false enables a secure tunnel on this Connection Server instance and its paired security servers.
If this is set to false, View Clients connect to desktops through the secure tunnel, which carries RDP and other data over HTTPS. PCoIP and HTML Access connections use separate secure gateways.
bypassPCoIPGatewayxsd:boolean

Whether the PCoIP traffic bypasses the secure gateway.
bypassAppBlastGatewayxsd:boolean

Setting this to false enables clients that browse to View machines to use the Blast Secure Gateway to establish a secure tunnel to this Connection Server instance.
If this is set to true, web browsers make direct connections to View machines, bypassing Connection Server.

versionxsd:string

'Version number' attribute to indicate functionalities supported by current connection server.
  • This property cannot be updated.