Editing installation settings file (huliotsetup.ini)

By editing an installation settings file (huliotsetup.ini), you can omit parameters when you execute a setup command.

The installation settings file is deployed to a working directory for installation when you deploy installation modules.

If you replace the installation settings file with a file that was edited in advance, you can certainly specify the same parameters for each IoT equipment and unify the environment settings.

Note that if you specify any parameters when you execute the setup command, the parameters that are specified by the command is valid.

Contents of the installation settings file

If the line top is a hashtag (#), the line is to be a comment line.

#
# Required
#
activation_key = 
server_hostname = 

#
# Optional
#
install_path = 
start = 1
devicename = 
proxy = 
proxy_user = 
protocol = 0
first_conn_retry_interval = 3600
service_name = †
workfile_path = 
remarks_file = 
logfile_path =

†

:

You can specify the "service_name" only in Agent for Windows.
Parameters of the installation settings file

Table 3.1 Parameters of the huliotsetup.ini file
Parameter Description Value

Table 3.4 Setup command parameters

activation_key

Specify the activation key of Manager as a connection destination.

If you do not describe this parameter in the huliotsetup.ini file, you must specify it with a setup command.

 For details about how to confirm the activation key, see Acquiring the activation key. --key
server_hostname

Specify the server on which the connection-destination Manager is running.

If you do not describe this parameter in the huliotsetup.ini file, you must specify it with a setup command.

Specify the value by using the following format:

•　HOSTNAME:PORTNUMBER

•　IPADDRESS:PORTNUMBER

You can omit the port number. If you omit the port number, 8765 is used.

 --server
install_path

Specify the installation directory of Agent.

Specify a directory name by using an absolute path with ASCII characters (alphanumeric characters and symbols). 1

If you omit the value, the following directory is created.

•　in Windows

C:\HULFT Family\hulftiot

•　in Linux

/opt/hulftiot

 --path
start

Specify this parameter whether you want to start Agent just after installation.

Specify one of the following values:

•　0: Do not start

•　1: Start (default)

 --no-start　| --start
devicename

Specify a name of your choice for identifying the equipment on which Agent is installed.

 If you omit this parameter, the host name that is set in the Agent installation environment is used. --devicename
proxy

Specify the proxy server to be used for connections to Manager.

Specify the value by using the following format:

•　HOSTNAME:PORTNUMBER

•　IPADDRESS:PORTNUMBER

You can omit the port number. If you omit the port number, 80 is used.

 --proxy
proxy_user

Specify the user for the proxy server to be used for connections to Manager.

Specify the value by using the following format:

•　USERNAME:PASSWORD

 --proxy-user
protocol

Specify the method for communication to Manager.

Specify one of the following values:

•　0: HTTP (default)

•　1: HTTPS

If you use HULFT over TLS, you must specify 1.

 --no-ssl | --ssl
first_conn_retry_interval

Specify the interval at which Agent will retry to connect Manager when the first connection of Agent to Manager failed just after the start of Agent.

Specify the numeral value between 1 and 5097600. The unit of this value is in seconds.

The default value is 3600 (1 hour).

 --interval
service_name 2

Specify the name of the Agent service that is registered in Windows.

 Specify arbitrary characters within 256 bytes.

If you omit this parameter, " HULFT IoT Agent" is used.

 --service-name
workfile_path

Specify the output directory for the system files that Agent internally uses.

Specify a directory name by using an absolute path with a maximum of 216 ASCII characters (alphanumeric characters and symbols). 1

If you omit this parameter, the files are stored in the installation directory of Agent.

 --workfile-path
remarks_file

Specify the text file in which the contents that are displayed in the [Remarks] field on the Agent list screen and the Agent details screen are described.

Specify a file name by using an absolute path with a maximum of 256 ASCII characters (alphanumeric characters and symbols). 1

If you omit this parameter, the [Remarks] field will be blank.

 --remarks
logfile_path

Specify the temporary storage directory for the log files that Agent will send to Manager.

Specify a directory name by using an absolute path with a maximum of 226 ASCII characters (alphanumeric characters and symbols). 1

If you omit this parameter, the files are stored in the installation directory of Agent.

 --logfile-path

1

:

If space is included in the specified installation path, enclose the whole of the path by using double quotation marks (").

2

:

You can specify the "service_name" only in Agent for Windows.
Note

The size of the text file must be with a maximum of 512 bytes.

The contents of the file must be written by using ASCII characters (alphanumeric characters and symbols).

When the newline character is included in the text file, the [Remarks] on the Agent Details screen displays all lines, however the [Remarks] on the Agent List screen displays only the first line.