Executing Agent installation

(1) In Windows

Note

If you have set the necessary installation parameters by editing the installation settings file (huliotsetup.ini), you can complete the Agent installation by double-clicking the huliotsetup.exe file in the working folder for installation of Agent.

If you have not set the necessary installation parameters by editing the huliotsetup.ini file yet, or if you want to change the parameters from the settings in the huliotsetup.ini file, execute a setup command as following procedure.

Install Agent on IoT equipment in a Windows environment by executing the following command in the working folder for installation of Agent.

Execute the command as a user who has administrative privileges.

Setup command

huliotsetup.exe [--key ACTIVATIONKEY] [--server SERVERNAME[:SERVERPORT]] [--path INSTALLPATH] 
                [--start | --no-start] [--devicename DEVICENAME]
                [--proxy PROXYNAME[:PROXYPORT]] [--proxy-user USERNAME:PASSWORD] [--ssl | --no-ssl]
                [--interval INTERVAL] [--service-name SERVICENAME] [--workfile-path WORKFILEPATH] 
                [--remarks REMARKSFILE] [--logfile-path LOGFILEPATH]

For each parameter, see (3) Setup command parameters.

Example execution of a setup command:

huliotsetup.exe --key 12345678-1234-1234-1234-123456789abc --server HOST01

In this example, parameters are omitted other than the activation key and the host name.

Activation key: 12345678-1234-1234-1234-123456789abc
Host name: HOST01

When installation is complete

When the installation is complete, the following message is displayed.

Succeeded to install.

After the installation is complete, delete the folder that you deployed at step 8 in (1) In Windows of Deploying Agent module.

When installation failed

When the installation failed, the following messages are displayed.

Here are error messages for each cause.
Failed to new installation.

If the installation failed, see Troubleshooting Agent installation.

(2) In Linux

Install Agent on IoT equipment in a Linux environment by executing the following command in the working directory for installation of Agent.

Execute the command as a user who has administrative privileges. Specify the command by using a full path or a relative path.

Setup command

huliotsetup     [--key ACTIVATIONKEY] [--server SERVERNAME[:SERVERPORT]] [--path INSTALLPATH] 
                [--start | --no-start] [--devicename DEVICENAME] 
                [--proxy PROXYNAME[:PROXYPORT]] [--proxy-user USERNAME:PASSWORD] [--ssl | --no-ssl]
                [--interval INTERVAL]　[--workfile-path WORKFILEPATH]
                [--remarks REMARKSFILE] [--logfile-path LOGFILEPATH]

For each parameter, see (3) Setup command parameters.

Example execution of a setup command:

./huliotsetup --key 12345678-1234-1234-1234-123456789abc --server HOST01

In this example, parameters are omitted other than the activation key and the host name.

Activation key: 12345678-1234-1234-1234-123456789abc
Host name: HOST01

When installation is complete

When the installation is complete, the following message is displayed.

Succeeded to install.

After the installation is complete, delete the /tmp/iot_agent directory.

When installation failed

When the installation failed, the following messages are displayed.

Here are error messages for each cause.
Failed to new installation.

If the installation failed, see Troubleshooting Agent installation.

(3) Setup command parameters

By specifying parameters to the setup command, you can install Agent by specifying the values that are different from those described in the installation settings file (huliotsetup.ini).

Table 3.4 Setup command parameters
Parameter	Description	Value	Table 3.1 Parameters of the huliotsetup.ini file
--key	Specify the activation key of Manager as a connection destination. If the value is not described in the huliotsetup.ini file, you must specify this parameter.	For details about how to confirm the activation key, see Acquiring the activation key.	activation_key
--server	Specify the server on which the connection-destination Manager is running. If the value is not described in the huliotsetup.ini file, you must specify this parameter.	Specify the value by using one of the following formats. You can omit the port number. •　host name:port number •　IP address:port number	server_hostname
--path	Specify the installation directory of Agent.	Specify a directory name by using an absolute path with ASCII characters (alphanumeric characters and symbols). ¹	install_path
--start	Agent starts just after installation.	²	start
--no-start	Agent does not start just after installation.	²	start
--devicename	Specify a name of your choice for identifying the equipment on which Agent is installed.		devicename
--proxy	Specify the proxy server to be used for connections to Manager.	Specify the value by using one of the following formats. You can omit the port number. •　host name:port number •　IP address:port number	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: •　user name:password	proxy_user
--ssl	An HTTPS protocol is used to communicate with Manager. If you use HULFT over TLS, you must specify --ssl.	²	protocol
--no-ssl	An HTTP protocol is used to communicate with Manager.	²	protocol
--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.	first_conn_retry_interval
--service-name ³	Specify the name of the Agent service that is registered in Windows.	Specify arbitrary characters within 256 bytes.	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, 2}	workfile_path
--remarks	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, 2}	remarks_file
--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, 2}	logfile_path

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

You can change the value after the installation by editing a settings file (agent.conf). For details about the settings file (agent.conf), see the "User's Guide".

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.

= Remarks =

If the "http_proxy" and "https_proxy" are registered in the system environment variables, Agent communicates with Manager via the proxy that is registered in the environment variables. If you specified "--proxy" when you installed Agent, Agent overrides the environment variables when Agent communicates with Manager. If "http_proxy" and "https_proxy" are registered in the system environment variables and if you have to bypass the proxy for the communication between Agent and Manager, register "no_proxy" in the system environment variables.