Explanation of Each Field

CLI Information Settings

cli.apiKey

An API key to be used in CLI

Specify an API key that is issued on the API Key Management screen of Management Console.

This field is mandatory.

cli.agent.id

The ID that identifies CLI

This field is mandatory and case-sensitive.

Note

If you intend to connect to HULFT8 for IBMi, do not use lowercase characters for cli.agent.id for the following reasons:

• This setting value is used for Host Name in the Host Information on HULFT.

• In HULFT8 for IBMi, you cannot use lowercase characters in the management information settings.

cli.hostname

The host name that executes CLI

This field is mandatory.

Note

If you intend to connect to HULFT8 for IBMi, do not use lowercase characters for cli.hostname for the following reasons:

• This setting value is used for Host Name in the Host Information on HULFT.

• In HULFT8 for IBMi, you cannot use lowercase characters in the management information settings.

Connection Information Settings

connection.id

The ID to be used when connecting to HULFT-WebConnect

The ID must be unique within the HULFT-WebConnect service.

This field is mandatory.

Note

• Connection IDs must be registered on Management Console in advance.

• CAUTION When you use CLI of the version lower than 2.2.0, confirm whether or not IP Filter is set to the Connection ID defined in the CLI configuration file. If it is set to the Connection ID, you cannot perform file transfer using the Connection ID.

• If you intend to connect to HULFT8 for IBMi, do not use lowercase characters for connection.id for the following reasons:

• This setting value is used for Host Name in the Host Information on HULFT.

• In HULFT8 for IBMi, you cannot use lowercase characters in the management information settings.

connection.password

The password to be used when connecting to HULFT-WebConnect

This field is mandatory.

Note

Connection Passwords must be registered on Management Console in advance.

service.accesspoint

The access point to the HULFT-WebConnect service

Do not modify the value of this field.

Proxy Information Settings

proxy.host

The host name or domain name (IP address) of the proxy server

This field is considered as a comment and disabled upon installation.

To enable the field, delete the single byte number sign (#) at the beginning of the line, and then specify the value for the field.

The field is not case-sensitive.

proxy.port

The port number for the proxy server

This field is considered as a comment and disabled upon installation.

To enable the field, delete the single byte number sign (#) at the beginning of the line, and then specify the value for the field.

proxy.username

The user name for the proxy server that requires user authentication

This field is considered as a comment and disabled upon installation.

To enable the field, delete the single byte number sign (#) at the beginning of the line, and then specify the value for the field.

The field is case-sensitive.

proxy.password

The password for the proxy server that requires user authentication

This field is considered as a comment and disabled upon installation.

To enable the field, delete the single byte number sign (#) at the beginning of the line, and then specify the value for the field.

The field is case-sensitive.

CLI Update Settings

update.action

The settings for the update notification to be displayed when executing CLI

Specify 'update', 'alert' or 'none' for this field. The field is case-sensitive.

When 'update' or 'alert' is specified, CLI will notify you about whether or not there is an update. You must update CLI manually.

= Remarks =

'update' is deprecated. It will be obsolete in future versions.

Example: Update Available

I600029 - The update check succeeded. Message:[You can update to latest version X.X.X from Y.Y.Y.]

Example: No Available Update

I600029 - The update check succeeded. Message:[You do not have to update: latest version X.X.X.]

update.action.onError

The settings for whether the CLI execution process should continue or be aborted if the update fails

Only when 'update.action' is set to 'update' or 'alert', the setting value of this field is valid.

Specify 'continue' or 'abort' for this field. The field is case-sensitive.

When 'continue' is specified, the CLI execution process is continued even if the update fails.

When 'abort' is specified, the CLI execution process is aborted if the update fails.

System Operation Settings

directory.work

The work directory for CLI

The work directory is a directory that stores temporary files created during the file transfer.

io.file.overwrite

The specification of whether to overwrite the receive file that is used when the file is transferred by using the GET method

Specify 'true' when you want to overwrite the file.

When 'false' is specified, the file is not overwritten.

If nothing is specified, the default value is 'false'.

io.session.timeout

The non communication time-out setting

Specify the value from '0' to '60' (Unit: seconds).

When '0' is specified, the time-out processing is not performed.

If nothing is specified, the default value is '60'.

jvm.options

The startup options for Java to be used when executing CLI

To specify multiple options, separate the options by using half-width spaces.

The field is case-sensitive.

Example: Allocation of Memory

jvm.options=-Xms32M -Xmx32M

Example: Language Settings

# Set to English. 
jvm.options=-Duser.language=en 
# Set to Japanese. 
jvm.options=-Duser.language=ja

Note

The available format and values that can be specified might vary depending on the version of Java.

Configuration File Version Settings

configuration.version

The version of the CLI configuration file

Do not modify the value of this field.