ConnectionServerUpdateSpecV2

ConnectionServerUpdateSpecV2
ConnectionServerUpdateSpecV2

Connection Server object whose settings need to be updated.

JSON Example
{
    "auxillary_external_pcoip_ipv4_address": "127.0.0.1:4172",
    "bypass_app_blast_gateway": false,
    "bypass_pcoip_gateway": true,
    "bypass_tunnel": false,
    "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",
    "gss_apiinfo": {
        "gss_apienabled": false
    },
    "host_redirection": false,
    "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": 0
    },
    "logoff_when_remove_smart_card": false,
    "radius_info": {
        "radius_authenticator_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
        "radius_enabled": false,
        "radius_name_mapping": false,
        "radius_sso": false
    },
    "rsa_secure_id_info": {
        "clear_node_secret": false,
        "name_mapping": false,
        "secure_id_enabled": false,
        "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": false,
        "workspace_one_host_name": "workspaceone.com",
        "workspace_one_mode_enabled": false
    },
    "smart_card_support": "OFF",
    "smart_card_support_for_admin": "OPTIONAL",
    "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
    }
}
string
auxillary_external_pcoip_ipv4_address
Optional

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.

boolean
bypass_app_blast_gateway
Required

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.

boolean
bypass_pcoip_gateway
Required

Indicates whether the PCoIP traffic bypasses the secure gateway.

boolean
bypass_tunnel
Required

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.

boolean
direct_htmlabsg
Optional

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.

boolean
disclose_service_principal_name
Required

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.

boolean
enable_smart_card_user_name_hint
Optional

Indicates whether username hints for smart card is enabled.

boolean
enabled
Required

Indicate whether the connection server is enabled. A disabled connection server will not accept connection requests from Horizon Clients.

string
external_appblast_url
Optional

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.

string
external_pcoip_url
Optional

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.

string
external_url
Optional

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.

gss_apiinfo
Required

gss_apiinfo

boolean
host_redirection
Required

Indicates whether connection server supports HTTP host redirection.

jwt_info
Required

jwt_info

ldap_backup_info
Required

ldap_backup_info

boolean
logoff_when_remove_smart_card
Optional

Indicates whether user is logged off on removal of Smart Card.

radius_info
Required

radius_info

rsa_secure_id_info
Required

rsa_secure_id_info

saml_info
Required

saml_info

string
smart_card_support
Required

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.
Possible values are : OPTIONAL, REQUIRED, OFF,
string
smart_card_support_for_admin
Required

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.
Possible values are : OPTIONAL, REQUIRED, OFF,
array of string
tags
Optional

Tags to restrict accessibility to desktop pools through this server.

unauthenticated_access_info
Required

unauthenticated_access_info