Device recovery CLI

The recovery command-line interface (CLI) can be used to modify the network settings of the management interfaces, and to reboot the device.

The recovery CLI is available on IOTA 5.2.0 and later.

The recovery CLI credentials can be found in the CLI Credentials section of the IOTA Settings > Administration page of the GUI. The username is static and cannot be changed. The password cannot be edited directly, but it can be regenerated using the Regenerate Password button. Either field can be copied to the clipboard by using the buttons to the right of each field.

On IOTA EDGE and IOTA CORE, the CLI can be accessed via SSH. On IOTA CORE, the CLI can also be accessed by connecting a monitor and a keyboard to the device.

To connect to the device via SSH, perform the following command (where USERNAME is the recovery username and IOTA_IP is the IP address of the device), and submit the recovery password when prompted:

ssh USERNAME@IOTA_IP

For example:

On IOTA CORE, the other way of accessing the CLI is to connect a monitor to the device's VGA port and a keyboard to one of its USB ports, and then logging in using the recovery credentials in the appearing shell.

For example:

The first method will work if the IOTA device has correctly configured network settings. The second method will always work.

Once logged in with the appropriate credentials, the CLI prompt appears.

Useful commands to navigate the console:

  • ls or help to list available commands (or by hitting TAB from keyboards)
  • . returns to the initial branch
  • .. returns to the previous branch

The netconfig command branch is used to configure the network settings of the device’s management interfaces. In the netconfig command branch, the show and update commands are available.

The show command (or .netconfig.show) displays the current configuration of all of the device's management interfaces.

The update command (or .netconfig.update) is used to update the configuration of any of the interfaces. The accepted arguments for the update command can be displayed with the help command (or .netconfig.update.help). For instance, in order to configure the management interface with ID 3 to have a static IP, netmask and gateway, the following command can be executed:

The reboot command (or .reboot) reboots the device immediately after confirmation:

  • Last modified: August 22, 2024