Install and provision an IIoT Gateway

Procedure

1. Download the LIT application package from Hitachi Vantara Lumada and Pentaho Support Portal.

   • For Linux: iiot-cli-linux-5.1.0.tar.gz
   • For Mac: iiot-cli-mac-5.1.0.tar.gz

2. Unarchive the tarball on the target device:

   Linux:

   cd <install_dir>/
   tar -zxf iiot-cli-linux-5.1.0.tar.gz

   Mac:

   cd <install_dir>/
   tar -zxf iiot-cli-mac-5.1.0.tar.gz

3. If your cluster's Fully Qualified Domain Name (FQDN) cannot be resolved by DNS, set your target cluster FQDN to /etc/hosts on the node where you are running this CLI.

4. Install LIT by running the installation script:

   cd <install dir>/cli-pkg-<os>/
   bash install.sh

Results

Parent Topic

• Manage LIT installation on Linux or Mac

  You can install, update, or uninstall the LIT application on Linux or Mac OS X. LIT provides all the commands needed to successfully register and provision an IIoT Gateway.

Procedure

1. Navigate to the directory where the update script resides:

   cd <install dir>/cli-pkg-<os>/

   where <os> is your operating system, either mac or linux.

2. Run the update script:

   sh update.sh

Results

Parent Topic

• Manage LIT installation on Linux or Mac

  You can install, update, or uninstall the LIT application on Linux or Mac OS X. LIT provides all the commands needed to successfully register and provision an IIoT Gateway.

Procedure

1. Verify that the application was installed to $HOME/.lit.

   Example:

   ```bash
   $ ls -l $HOME/.lit
   drwxr-xr-x 2 root root  17 Jan 15 03:31 bin
   drwxr-xr-x 2 root root 100 Jan 15 03:39 configs
   drwxr-xr-x 2 root root  21 Jan 15 03:34 logs

2. Verify that the configuration was moved to $HOME/.lit/configs.

   Example:

   ```bash
   $ ls -l $HOME/.lit/configs/
   -rwxrwxr-- 1 root root 144 Mar 26 20:12 lit_app_current.json
   -rwxrwxr-- 1 root root 190 Mar 26 20:12 lit_app.json
   -rwxrwxr-- 1 root root  65 Mar 26 20:12 lit_gw_current.json
   -rwxrwxr-- 1 root root  93 Mar 26 20:12 lit_gw.json

3. Verify that the binaries were moved and have execute permissions:

   ```bash
   $ ls -l $HOME/.lit/bin
   -rwxrwxr-- 1 root root 7698887 Mar 26 20:14 lit
   ```

4. Check that LIT is properly installed by running this command:

   lit version

Parent Topic

• Manage LIT installation on Linux or Mac

  You can install, update, or uninstall the LIT application on Linux or Mac OS X. LIT provides all the commands needed to successfully register and provision an IIoT Gateway.

Procedure

1. Navigate to the LIT application directory:

   cd <install dir>/cli-pkg-<os>/
   

   where <os> is your operating system, either mac or linux.

2. Run the LIT uninstall script:

   sh uninstall.sh

Results

Parent Topic

• Manage LIT installation on Linux or Mac

  You can install, update, or uninstall the LIT application on Linux or Mac OS X. LIT provides all the commands needed to successfully register and provision an IIoT Gateway.

Procedure

1. Download the LIT application package from Hitachi Vantara Lumada and Pentaho Support Portal:

   iiot-cli-windows-5.1.0.zip

2. Unarchive the ZIP file in the installation directory of the target device:

   cd <install_dir>/
   <your preferred unzip utility> iiot-cli-windows-5.1.0.zip

3. Install LIT by running the installation script or by double-clicking the file install.bat:

   cd <install dir>/cli-pkg-windows/
   install

   If you are running install.bat as a non-admin user, adding the binary path to the PATH environment value fails. In this case, take one of the following actions:
   • Use the LIT application in %HOMEPATH%/.lit/bin.
   • Manually add %HOMEPATH%/.lit/bin to the PATH environment value.
   • Retry the installation as an admin user.

Results

lit -help

Parent Topic

• Manage LIT installation on Windows

  You can install, update, or uninstall the LIT application on Windows. LIT provides all the commands needed to successfully register and provision an IIoT Gateway.

Procedure

1. Navigate to the directory where the update script resides:

   cd <install dir>/cli-pkg-windows/

2. Run the update script (update.bat):

   update

Results

Parent Topic

• Manage LIT installation on Windows

  You can install, update, or uninstall the LIT application on Windows. LIT provides all the commands needed to successfully register and provision an IIoT Gateway.

Procedure

1. Verify that the application was installed to %HOMEPATH%/.lit.

   Example:

   dir
   04/20/2021  02:32 PM    <DIR>          bin
   04/20/2021  02:32 PM    <DIR>          configs
   04/23/2021  01:55 PM    <DIR>          logs

2. Verify that the configuration was moved to %HOMEPATH%/.lit/configs.

   Example:

   cd %HOMEPATH%/.lit/configs
   dir
   04/06/2021  03:25 PM                 2 lit_app.json
   04/06/2021  03:25 PM                 2 lit_app_current.json
   04/06/2021  03:25 PM                 2 lit_gw.json
   04/06/2021  03:25 PM                 2 lit_gw_current.json

3. Verify that the binaries were moved and have execute permissions:

   cd %HOMEPATH%/.lit/bin
   dir /Q
   04/06/2021  03:25 PM         7,811,072 HDS\user_name           lit.exe

4. Check that LIT is properly installed by running this command:

   lit version

Parent Topic

• Manage LIT installation on Windows

  You can install, update, or uninstall the LIT application on Windows. LIT provides all the commands needed to successfully register and provision an IIoT Gateway.

Procedure

1. Navigate to the LIT application directory:

   cd <install dir>/cli-pkg-windows/
   

2. Run the LIT uninstall script (uninstall.bat):

   uninstall

3. Remove %HOMEPATH%.lit\bin from the PATH environment value.

   This removal is necessary because the uninstall script does not delete the CLI path from the PATH environment variable.

Results

Parent Topic

• Manage LIT installation on Windows

  You can install, update, or uninstall the LIT application on Windows. LIT provides all the commands needed to successfully register and provision an IIoT Gateway.

Procedure

1. Add your IIoT Core Services configuration:

   lit cfg app add -name=<core_name> -desc=<core_description> 
   -domain=<cluster_fqdn> -ip=<core_ip/loadbalancer_ip> 
   -user=<core_admin_username> -pwd=<core_admin_password> 
   -keycloak_pwd=<core_keycloak_password>

   Use the following table to edit the LIT parameters as needed:

   Parameter	Description
   name	Unique name of IIoT Core Services.
   desc	Description of IIoT Core Services.
   domain	Core/load balancer Fully Qualified Domain Name (FQDN) of the cluster.
   ip	Core/load balancer IP address.
   user	Admin username created during installation of IIoT Core Services.
   pwd	Admin password created during installation of IIoT Core Services.
   keycloak_pwd	Keycloak password created during installation of IIoT Core Services.

   NoteThe added core connection information is saved in .lit/configs/lit_app.json. Multiple sets of core connection information can be created.

2. List the configurations available to LIT:

   lit cfg app list

   Sample command output:

   $ lit cfg app list
   Appliance Config Options:
       Name: <core_name>
       Desc: <description>
       IP Address: <cluster_ip_address>
       Cluster FQDN: <cluster_fqdn>

3. Select the Core configuration you want to connect to:

   lit cfg app select -name=<core_name>

   Note<core_name> has to be identical to <core_name> in the previous step.
   The selected core connection information is saved in the following location: .lit/configs/lit_current_app.jsonTo verify that LIT is connecting to the correct Core device, run the following command:

   lit cfg app current

4. Test the connection.

   Use the lit device list command to verify that LIT can access and talk to the IIoT Core Services platform by listing all currently connected devices. The command output should show at least the auto-created Core device.

   $ lit device list
       Device list:
       Device Info:
           AssetId:            <asset_id>
           Name:               <name>
           Hostname:           <hostname>
           InventoryId:        <inventory_id>
           Description:        Auto-created Appliance Device
           LocationDescription:
           ImageMimeType:
           DeviceType:         appliance
           DateCreated:        2020-04-16T23:48:41Z
           State:              ready

Parent Topic

• Configure and enroll an IIoT Gateway device using LIT

  To enroll an IIoT Gateway, you need to update the configuration, so LIT knows how to connect to Core and Gateway devices.

Procedure

1. Add your IIoT Gateway configuration:

   lit cfg gw add -name=<gw_name> -desc=<gw_description> -ip=<gw_ip_addr>

   NoteThe added IIoT Gateway connection information is saved in the following location: .lit/configs/lit_gw.json. LIT can be used to enroll multiple gateways by adding multiple IIoT Gateway configurations.

   Parameter	Description
   name	Unique name of the gateway device.
   desc	Description of the gateway device.
   ip	IP address of the gateway device.

2. List and select the configuration to be used:

   lit cfg gw list

   Sample command output:

   $ lit cfg gw list
   Gateway Config Options:
   Name: p2rhgw16
       Desc: p2rhgw16
       URL: <gw_ip_addr>

3. Select the IIoT Gateway configuration for the gateway you want to connect to:

   lit cfg gw select -name=<gw_name>

   The selected gateway connection information is saved in the following location: .lit/configs/lit_current_app.jsonTo verify that LIT is connecting to and enrolling the correct IIoT Gateway, use the following command:

   lit cfg app current

Parent Topic

• Configure and enroll an IIoT Gateway device using LIT

  To enroll an IIoT Gateway, you need to update the configuration, so LIT knows how to connect to Core and Gateway devices.

Procedure

1. Check which Core device the gateway will be created on to understand which one LIT will connect to:

   lit c a c

2. Create the IIoT Gateway:

   lit d c -name=<gateway_name> -inventory_id=<gateway_inventory_id> 
   -device_type=gateway

   For inventory_id, make sure to use the same unique inventory ID that was set on the gateway device during installation.Example:

   $ lit d c -name=p2rhgw16 -inventory_id=p2rhgw16 -device_type=gateway
   
   SUCCESSFULLY Created Device
   
   Device Info:
   	DeviceId: 		   <device_id>
   	Name: 			   <device_name>
   	Hostname:
   	InventoryId: 		<inventory_id>
   	Description:
   	LocationDescription:
   	ImageMimeType:
   	DeviceType: 		 gateway
   	DateCreated: 		2021-04-02T21:45:14Z
   	State: 			  inventory

3. Enroll the created device.

   After the device is created, LIT shows the newly created DeviceId. This id will be passed on to the enrollment command.

   lit g e -id=<gateway_device_id>

   If you do not know the DeviceId, use the following command to get all gateway device information from IIoT Core Services:

   lit d l

Results

Parent Topic

• Configure and enroll an IIoT Gateway device using LIT

  To enroll an IIoT Gateway, you need to update the configuration, so LIT knows how to connect to Core and Gateway devices.

Procedure

1. Log in to the gateway as a root user using SSH.

2. Delete the device with the relevant device ID.

   lit delete device -id=<gateway_device_id>

Results

Parent Topic

• Configure and enroll an IIoT Gateway device using LIT

  To enroll an IIoT Gateway, you need to update the configuration, so LIT knows how to connect to Core and Gateway devices.