7.18 Procedure for connecting a management relay server to an Internet gateway
Procedure for connecting a management relay server to an Internet gateway:
- Important
-
To connect a management relay server to an Internet gateway, the management relay server mut be fully set up. details about setting up a management relay server, see 1.2.5 Procedure for setting up a management relay server.
Perform the following steps in a management relay server.
-
Start JP1ITDM2 Utility Console.
For details on how to start JP1ITDM2 Utility Console, see 8.1 Executing commands.
-
In the window that appears, execute the following command:
rlyigwsetconf -o destination-internet-connection-settings-file
Immediately after setting up a management relay server, the template for an Internet connection settings file is output. If the management relay server has already been configured for an Internet gateway connection, an Internet connection settings file with the current settings is output.
For details about rlyigwsetconf command, see rlyigwsetconf (Setting a management relay server with Internet Connectivity) in the manual JP1/IT Desktop Management 2 Administration Guide.
-
Edit the Internet connection setting file output in step 2.
Set the information of an Internet gateway to connect to. For details about an Internet connection settings file, see Internet connection settings File:.
-
Start JP1ITDM2 Utility Console, execute the following command:
rlyigwsetconf -i internet-connection-settings-file-edited-in-step 3
For details about rlyigwsetconf command, see rlyigwsetconf (Setting a management relay server with Internet Connectivity) in the manual JP1/IT Desktop Management 2 Administration Guide.
-
Check the management relay server is connected to the Internet gateway.
Check the following log file:
JP1/IT Desktop Management 2 - Manager-installation-folder\mgr\log\USER_CLT_nnnn.log
Details on how to check the log files, see To perform a connection check: in 2.11.3 Building an agent for devices used outside the company.
Internet connection settings File:
The format of an Internet connection settings file is shown below.
[HTTPGW] UseInternetGateway=availability-of-connection-to-the-higher-level-server-via-the-Internet-gateway ConnectHost=hostname-or-IP-address-of-the-Internet-gateway HTTPSPort=port-number-for-connecting-to-the-Internet-gateway AcceptPort=port-number-used-internally-when-connecting-to-the-Internet-gateway AcceptPortRelay=port-number-used-internally-when-connecting-to-the-Internet-gateway SSLIgnoreWarning=availability-of-connection-to-an-Internet-gateway-when-the-server-certificate-expires [BasicAuthN] UseWWWAuth=user-authentication-enabled/disabled-when-connecting-to-the-Internet-gateway-server ChangeBasicAuth=availability-of-changing-user-ID-and-password-for-user-authentication Username=user-ID-for-user-authentication Password=password-for-user-authentication [Proxy] ProxyType=availability-of-proxy-server-when-connecting-to-the-Internet-gateway ProxyHost=hostname-or-IP-address-of-the-proxy-server ProxyPort=port-number-of-the-proxy-server ChangeProxyAuth=availability-of-changing-proxy-server-user-ID-and-password ProxyUser=user-ID-for-proxy-server ProxyPass=password-for-proxy-server RangeTransferSize=split-size-of-upload-file
The following table describes the setting items of an Internet connection setting file.
|
Section |
Item |
Description |
Value that can be entered |
Required? |
|---|---|---|---|---|
|
HTTPGW |
Specify the Internet gateway server to which management relay server connects. |
Required |
||
|
UseInternetGateway |
Specify whether to connect HTTPS to the higher-level server via the Internet gateway. |
Specify one of the following in single-byte alphabets. Alphabetic characters are not case sensitive. YES: Connect NO: Not connect |
Required |
|
|
ConnectHost |
Specify host name or IP address of the Internet gateway. |
For a host name, a maximum of 255 single-byte alphanumeric characters For an IP address, single-byte numbers in xxx.xxx.xxx.xxx format |
Required if UseInternetGateway is YES. Optional if UseInternetGateway is NO. |
|
|
HTTPSPort |
Specify the port number for connecting to the Internet gateway. |
Single-byte numeric value in the range 1 to 65535 |
Required |
|
|
AcceptPort |
Specify the port number used internally when connecting to the internet gateway. |
Single-byte numeric value in the range 1 to 65535 |
Required |
|
|
AcceptPortRelay |
Specify the port number used internally when connecting to the internet gateway. |
Single-byte numeric value in the range 1 to 65535 |
Required |
|
|
SSLIgnoreWarning |
Specify availability of connection to an Internet gateway when the server certificate expires. |
Specify one of the following as a single-byte numeric value: 0: Handle as an error 2: Do not handle as an error |
Required |
|
|
BasicAuthN |
Set the user authentication information of the Internet gateway server. |
Required |
||
|
UseWWWAuth |
Specify user-authentication enabled/disabled when connecting to the Internet gateway server. |
Specify one of the following as a single-byte numeric value: 1: Authenticate 0: Not authenticate |
Required |
|
|
ChangeBasicAuth |
Specify availability of changing user ID and password for user authentication. |
Specify one of the following in single-byte alphabets. Alphabetic characters are not case sensitive. YES: Change user ID and password NO: Do not change user ID and password |
Required if UseInternetGateway is YES and UseWWWAuth is 1. Otherwise, it can be omitted and assumed to be a NO. |
|
|
Username |
Specify user ID for user authentication. |
Up to 276 ASCII characters other than ASCII control |
Required if UseInternetGateway is YES and UseWWWAuth is 1 and ChangeBasicAuth is YES. Otherwise, it can be omitted, and the value is ignored by default. |
|
|
Password |
Specify the password for user authentication. |
Up to 48 ASCII characters other than ASCII control |
Required if UseInternetGateway is YES and UseWWWAuth is 1 and ChangeBasicAuth is YES. Otherwise, it can be omitted, and the value is ignored by default. |
|
|
Proxy |
Set the proxy server when management relay server connects to the Internet gateway server. |
Required |
||
|
ProxyType |
Specify availability of proxy servers when connecting to the Internet gateway. |
Specify one of the following as a single-byte numeric value: 1: Use proxy server 0: Do not use proxy server |
Required |
|
|
ProxyHost |
Specify host name or IP address of the proxy server when communicating with the Internet Gateway using a proxy server. |
For a host name, a maximum of 249 single-byte alphanumeric characters For an IP address, single-byte numbers in xxx.xxx.xxx.xxx format |
Required if UseInternetGateway is YES and ProxyType is 1. Otherwise, it can be omitted. |
|
|
ProxyPort |
Specify the port number of the proxy server. |
Single-byte numeric value in the range 5001 to 49151 |
Required |
|
|
ChangeProxyAuth |
Specify whether to change the user ID and password of the proxy server. |
Specify one of the following in single-byte alphabets. Alphabetic characters are not case sensitive. YES: Change user ID and password NO: Do not change user ID and password |
Required if UseInternetGateway is YES and ProxyType is 1. Otherwise, it can be omitted and assumed to be a NO. |
|
|
ProxyUser |
Specify the user ID for user authentication when connecting to the proxy server. |
Up to 276 ASCII characters other than ASCII control |
Optional if ChangeProxyAuth is YES. Disabled for NO. |
|
|
ProxyPass |
Specify the password for user authentication when connecting to the proxy server. |
Up to 48 ASCII characters other than ASCII control |
Optional if ChangeProxyAuth is YES. Disabled for NO. |
|
|
RangeTransferSize |
Specify the partition size of the upload file in bytes. If there is a limitation on the proxy server or Microsoft Internet Information Services, change this setting. |
Single-byte numeric value in the range 10240 to 104857600 |
Required |
|
The following notes apply to an Internet connection settings file:
-
Any leading or trailing single-byte spaces in the value are ignored, and the value with leading or trailing single-byte spaces removed is assumed as the specified value.
-
If the value is enclosed by " or ' at the beginning and end, the character string without the leading and trailing " or ' is read as the value.
-
If you want to specify a value surrounded by " or ', enclose the front and rear of the value with "".
For example, to specify "abc" as the value, specify ""abc"".
-
When outputting an Internet connection setting file by rlyigwsetconf command, if it is enclosed in ", ' or single-byte space, it is output by enclosing in "".