Gateway Default Settings

PreviousStatus NextTests a URL that leads to a client IP detection service

Was this helpful?

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/GatewayDefaultSettings'

200

401

404

{
  "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
}

Success

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

Available options:

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

Available options:

cipherStrengthstring · enumoptional

Cipher Strength

Available options:

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

Available options:

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.

Available options:

allowClipboardboolean | nullableoptionalDeprecated

Enable or disable the 'Allow Clipboard' option.

clipboardDirectionstring[Flag] · enumoptional

Clipboard Direction Type.

Available options:

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

Available options:

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/GatewayDefaultSettings' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "mode": [
      "0 = Normal",
      "1 = Forwarding"
    ],
    "normalModeForwarding": true,
    "forwardGatewayServers": "text",
    "autoPreferredBroker": true,
    "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": 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,
    "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
  }'

204

401

404

No Content