You are currently viewing an older version of the documentation. You can find the latest documentation here.

Remote Gateway Files

Overview

The Active Console allows you to define Gateway connections from information on a file or source URL. This is configurable under Connection files in the Active Console connections settings.

These files or URLs must be in plaintext and in the following format:


<hostname>~<port>~<description>~<Secondary Host>~<Secondary Port>~<Logon Method>~<Connection Security>
<hostname>~<port>~<description>~<Secondary Host>~<Secondary Port>~<Logon Method>~<Connection Security>
<hostname>~<port>~<description>~<Secondary Host>~<Secondary Port>~<Logon Method>~<Connection Security>
<hostname>~<port>~<description>~<Secondary Host>~<Secondary Port>~<Logon Method>~<Connection Security>
…

Configure logon method in the workspace

The <Logon Method> can have the following values:

Value Description
LM_WORKSPACE Default logon method defined in the workspace. If you do not specify the logon type, this becomes the default option.
LM_USER_FIRSTTIME Requires you a username and password when logging into the Gateway.
LM_SSO Uses the SSO Agent.
   

Configure connection security

The <Connection Security> can have the following rules:

Value Description
INSECURE Connects to the Gateway’s insecure port. This is the default connection security setting.
SECURE Connects to the Gateway’s secure port.
   

You can skip the definition of the description, secondary host, secondary port, and logon methods by including an asterisk (*).

For example, if the Gateway does not have a secondary host, but you want to specify its logon type, then use the following:

itrsops~4533~myGateway~*~*~LM_USER_FIRSTTIME

You can also exclude elements from the end of the line.

For example, if you want to specify a host and port, then use the following:

itrsops~4533

In addition, you can provide blank lines and leave comments in the file.

The comments must be on their own line, and begin with "//". For example:

//my gateway
itrsops~4533~my gateway description
//Another gateway
itrsops~4534~another gateway description~*~*~ LM_SSO

Here is another example of a remote Gateway file:

itrsops~4564~maingateway
itrsops~2346~another gateway~itrsops~4564
itrsops~4533~*~*~*~LM_USER_FIRSTTIME~SECURE
hostname~3456~*~secondaryhost~1200~*~LM_WORKSPACE~INSECURE

Whenever the workspace is loaded, the Active Console looks for this file or URL. Then, it imports the defined Gateway connections. This function can be useful if there many workspaces share the same Gateways.

For more information on how to declare these imported files or URLs in the workspace, see Workspace Settings in Workspace Settings.

If the Gateway list is defined on a remote URL, it cannot be embedded in any HTML or XML files. It must remain in the specified format as shown in the examples.

Note: When adding remote connection files through the Connection settings, ensure that you set the connection type to URL before adding the file name.