Link utility commands

configure command

The configure command is required before using any other command. This command is used to specify the installation type, the OEM integration, and the user/group. You must specify the correct option for --integration at a minimum.

Table 1. Options
--type <native|docker>

Specify the installation type.

Default: native
--integration

This option is intended for customer use only. Do not use if you purchased HCL Link as a standalone product.
--user

The user to install HCL Link to. This determines which user has ownership of the processes and directories. This must be an already existing user.

Default: current user
--group

The group to install HCL Link as. This provides you with flexibility to share HCL Link directories with a group of admins.

Default: current group
Note: You cannot change the integration type after you run install. If you notice a mistake after installation, extract the HCL Link package into a new directory and begin again.

install, uninstall, start, and stop commands

The behavior of the install, uninstall, start, and stop commands is similar.

All commands will act upon the default components if none are specified as options. You can specify the scope of each action by listing individual components.
Note: Embedded installations generally require all default components running for proper functionality. Do not use these options if you do not understand them fully.
Table 2. Options
-r, --runtime Installs the Runtime REST API used for running maps and flows.
-d, --server Installs the Server and Client used to design, manage, and deploy maps and flows.

status command

The status command retrieves the status of each HCL Link component. The usage is similar between the native and docker installation types, though the possible states are different.

Table 3. Options
-r, --runtime Installs the Runtime REST API used for running maps and flows.
-d, --server Installs the Server and Client used to design, manage, and deploy maps and flows.

Possible states

Native

  • Not Installed
  • Stopped
  • Running
  • Unknown

Docker

  • Not Installed
  • Created
  • Dead
  • Exited
  • Paused
  • Running
  • Restarting

logs command

The logs command prints the primary log of the chosen component. Because the log files may grow to a large size, you should funnel the output of this command into a tool like less for better navigation.

Table 4. Options
-r, --runtime-app Prints the log of the Runtime REST API.
-d, --server-app Prints the log of the Server Web App.
-c, --client Prints the log of the Client.