Gateway Default Settings

Get

get

Retrieve the RAS Secure Gateway Default settings.

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve RAS Secure Gateway Default settings (optional)

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

HTTPcURLJavaScriptPython

GET /api/GatewayDefaultSettings HTTP/1.1
Host: 
Accept: */*

{
  "mode": [
    "0 = Normal",
    "1 = Forwarding"
  ],
  "normalModeForwarding": true,
  "forwardGatewayServers": "text",
  "preferredBrokerId": 1,
  "forwardHttpServers": "text",
  "enableGatewayPort": true,
  "gatewayPort": 1,
  "onlyAllowAcmeHttp": true,
  "enableRDP": true,
  "rdpPort": 1,
  "broadcast": true,
  "enableRDPUDP": true,
  "enableDeviceManagerPort": true,
  "dosPro": true,
  "enableSSL": true,
  "sslPort": 1,
  "minSSLVersion": [
    "2 = TLSv1",
    "3 = TLSv1_1",
    "4 = TLSv1_2",
    "5 = TLSv1_3"
  ],
  "cipherStrength": [
    "0 = Low",
    "1 = Medium",
    "2 = High",
    "3 = Custom"
  ],
  "cipher": "text",
  "cipherPreference": true,
  "certificateId": 1,
  "enableHSTS": true,
  "hstsMaxAge": 1,
  "hstsIncludeSubdomains": true,
  "hstsPreload": true,
  "enableUserPortal": true,
  "userPortalPort": 1,
  "launchMethod": [
    "0 = ParallelsClientAndWebClient",
    "1 = ParallelsClient",
    "2 = WebClient"
  ],
  "allowLaunchMethod": true,
  "allowAppsInNewTab": true,
  "usePreWin2000LoginFormat": true,
  "allowEmbed": true,
  "allowFileTransfer": true,
  "fileTransferMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "allowClipboard": true,
  "clipboardDirection": [
    "0 = None",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "allowCORS": true,
  "browserCacheTimeInMonths": 1,
  "allowedDomainsForCORS": [
    "text"
  ],
  "enableAlternateNLBHost": true,
  "alternateNLBHost": "text",
  "enableAlternateNLBPort": true,
  "alternateNLBPort": 1,
  "enableWyseSupport": true,
  "disableWyseCertWarn": true,
  "securityMode": [
    "0 = AllowAllExcept",
    "1 = AllowOnly"
  ],
  "macAllowExcept": [
    "text"
  ],
  "macAllowOnly": [
    "text"
  ],
  "webRequestsURL": "text",
  "webCookie": "text",
  "useSecureWebCookie": true,
  "siteId": 1
}

Update

put

Update the RAS Secure Gateway default settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

Query parameters

SiteIdinteger · int32Optional

Site ID for which to update the RAS Secure Gateway Default settings (optional)

Body

Update Gateway default settings

modestring · enumOptional

RAS Secure GateWay Mode

Possible values:

normalModeForwardingboolean | nullableOptional

Forward requests to HTTP server.

forwardGatewayServersstring | nullableOptional

One or multiple (separated by comma) Forwarding Gateway Servers. E.g. localhost:80, web1

autoPreferredBrokerbooleanOptional

Set preferred Broker Automatically.

Default: false

preferredBrokerIdinteger · int32 | nullableOptional

The preferred Connection Broker ID.

forwardHttpServersstring | nullableOptional

One or multiple (separated by comma) Forwarding HTTP Servers. E.g. localhost:81, web1

enableGatewayPortboolean | nullableOptional

Enable or disable a custom RAS Secure Gateway port. To specify a custom port, set this parameter to True and use the GatewayPort parameter to specify the port number.

gatewayPortinteger · int32 | nullableOptional

A custom Gateway port number. For this port to take effect, the EnableGatewayPort parameters must be set to $True.

onlyAllowAcmeHttpboolean | nullableOptional

Whether to ignore all incoming requests except for Acme ones received on 'GatewayPort'

enableRDPboolean | nullableOptional

Enable or disable a custom RDP port. To specify a custom port number, use the RDPPort parameter.

rdpPortinteger · int32 | nullableOptional

A custom RDP port number. For this port to take effect, the EnableRDPPort parameter must be set to True.

broadcastboolean | nullableOptional

Enable or disable the 'Broadcast RAS Secure Gateway Address' option.

enableRDPUDPboolean | nullableOptional

Enable or disable the 'RDP UDP Data Tunneling' option.

enableDeviceManagerPortboolean | nullableOptional

Enable or disable the 'Device Manager Port' option.

dosProboolean | nullableOptional

Enable or disable the 'RDP DOS Attack Filter' option.

enableSSLboolean | nullableOptional

Enable or disable SSL on the port specified in the SSLPort parameter.

sslPortinteger · int32 | nullableOptional

SSL port number. To enable the port, set the EnableSSL port parameter to True.

minSSLVersionstring · enumOptional

Accepted SSL Versions

Possible values:

cipherStrengthstring · enumOptional

Cipher Strength

Possible values:

cipherstring | nullableOptional

Cipher string.

cipherPreferenceboolean | nullableOptional

Enable or disable Use ciphers according to server preference.

autoCertificatebooleanOptional

Set Certificate Automatically.

Default: false

certificateIdinteger · int32 | nullableOptional

The Certificate ID.

enableHSTSboolean | nullableOptional

Enable or disable HSTS. To specify a custom HSTS Age, set this parameter to True and use the HSTSMaxAge parameter to specify the HSTS maximum age.

hstsMaxAgeinteger · int32 | nullableOptional

Specifies the HSTS maximum age.

hstsIncludeSubdomainsboolean | nullableOptional

Enable or disable the HSTS sub-domains.

hstsPreloadboolean | nullableOptional

Enable or disable the HSTS preload.

enableUserPortalboolean | nullableOptional

Enable or disable User Portal connectivity on the Gateway.

userPortalPortinteger · int32 | nullableOptional

A custom User Portal port number.

launchMethodstring · enumOptional

LaunchMethod

Possible values:

allowLaunchMethodboolean | nullableOptional

Allow users to select a resource launch method.

allowAppsInNewTabboolean | nullableOptional

Allow users to start applications in a new browser tab.

usePreWin2000LoginFormatboolean | nullableOptional

Enable or disable the 'Use Pre Windows 2000 Login Format' option.

allowEmbedboolean | nullableOptional

Allow embedding of Web Client into other web pages.

allowFileTransferboolean | nullableOptionalDeprecated

Deprecated: use FileTransferMode instead. Enable or disable the 'Allow file transfer' option.

fileTransferModestring · enumOptional

File Transfer Control modes.

Possible values:

allowClipboardboolean | nullableOptionalDeprecated

Enable or disable the 'Allow Clipboard' option.

clipboardDirectionstring[Flag] · enumOptional

Clipboard Direction Type.

Possible values:

allowCORSboolean | nullableOptional

Allow cross-origin resource sharing.

allowedDomainsForCORSstring[] | nullableOptional

Allowed domains for cross-origin resource sharing.

browserCacheTimeInMonthsinteger · int32 | nullableOptional

How long should the browser preserve the cache (in months).

enableAlternateNLBHostboolean | nullableOptional

Enable or disable Alternate NLB host name specified in the EnableAlternateNLBHost parameter.

alternateNLBHoststring | nullableOptional

Alternate NLB host name. To enable the host name, set the EnableAlternateNLBHost port parameter to True.

enableAlternateNLBPortboolean | nullableOptional

Enable or disable Alternate NLB on the port specified in the AlternateNLBPort parameter.

alternateNLBPortinteger · int32 | nullableOptional

Alternate NLB port number. To enable the port, set the EnableAlternateNLBPort port parameter to True.

enableWyseSupportboolean | nullableOptional

Enable or disable Wyse ThinOS support.

disableWyseCertWarnboolean | nullableOptional

Enable or disable the warning if server certificate is not verified.

securityModestring · enumOptional

Security Mode

Possible values:

macAllowExceptstring[] | nullableOptional

Specifies the Security 'MAC Allow Except' MAC addresses.

macAllowOnlystring[] | nullableOptional

Specifies the Security 'MAC Allow Only' MAC addresses.

webRequestsURLstring | nullableOptional

Set a URL for Web requests. This is the URL that will open when a user enters the IP address of the RAS Secure Gateway server in a web browser. For the URL to work, the gateway mode must be set to Normal.

webCookiestring | nullableOptional

Set the Web Cookie Name used by RAS.

useSecureWebCookieboolean | nullableOptional

Enable or disable the addition of the secure attribute to the cookie to the Web Cookie.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

HTTPcURLJavaScriptPython

PUT /api/GatewayDefaultSettings HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 1521

{
  "mode": [
    "0 = Normal",
    "1 = Forwarding"
  ],
  "normalModeForwarding": true,
  "forwardGatewayServers": "text",
  "autoPreferredBroker": false,
  "preferredBrokerId": 1,
  "forwardHttpServers": "text",
  "enableGatewayPort": true,
  "gatewayPort": 1,
  "onlyAllowAcmeHttp": true,
  "enableRDP": true,
  "rdpPort": 1,
  "broadcast": true,
  "enableRDPUDP": true,
  "enableDeviceManagerPort": true,
  "dosPro": true,
  "enableSSL": true,
  "sslPort": 1,
  "minSSLVersion": [
    "2 = TLSv1",
    "3 = TLSv1_1",
    "4 = TLSv1_2",
    "5 = TLSv1_3"
  ],
  "cipherStrength": [
    "0 = Low",
    "1 = Medium",
    "2 = High",
    "3 = Custom"
  ],
  "cipher": "text",
  "cipherPreference": true,
  "autoCertificate": false,
  "certificateId": 1,
  "enableHSTS": true,
  "hstsMaxAge": 1,
  "hstsIncludeSubdomains": true,
  "hstsPreload": true,
  "enableUserPortal": true,
  "userPortalPort": 1,
  "launchMethod": [
    "0 = ParallelsClientAndWebClient",
    "1 = ParallelsClient",
    "2 = WebClient"
  ],
  "allowLaunchMethod": true,
  "allowAppsInNewTab": true,
  "usePreWin2000LoginFormat": true,
  "allowEmbed": true,
  "fileTransferMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "clipboardDirection": [
    "0 = None",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "allowCORS": true,
  "allowedDomainsForCORS": [
    "text"
  ],
  "browserCacheTimeInMonths": 1,
  "enableAlternateNLBHost": true,
  "alternateNLBHost": "text",
  "enableAlternateNLBPort": true,
  "alternateNLBPort": 1,
  "enableWyseSupport": true,
  "disableWyseCertWarn": true,
  "securityMode": [
    "0 = AllowAllExcept",
    "1 = AllowOnly"
  ],
  "macAllowExcept": [
    "text"
  ],
  "macAllowOnly": [
    "text"
  ],
  "webRequestsURL": "text",
  "webCookie": "text",
  "useSecureWebCookie": true
}

No content