ConsoleFlow for iOS User Guide¶

Lantronix ConsoleFlow mobile app is the travel-ready way to keep you connected to your Lantronix devices and managed devices:

• Lantronix console managers
• Lantronix gateways
• OEM devices

Getting Started¶

1. Create an account
2. Install the app
3. Use the app

Cloud and On-Premise Install Options¶

ConsoleFlow mobile app is available in cloud or on-premise installation for iOS mobile devices. You should choose cloud or on-premise setup according to the determination of your organization.

• Cloud setup connects you directly to the ConsoleFlow server URL, allowing you to access your devices through internet.
• On-premise setup connects you to ConsoleFlow through your organization's network. This means you need to be physically "on-premises" to access your organization's network via Wi-Fi, or may need to use a VPN connection. You may later view and update on-premise setup.

Create an Account¶

Create a ConsoleFlow login account in a web browser. You will need this to log into the ConsoleFlow mobile app.

1. Get an invitation email from your ConsoleFlow administrator.
2. Click the link in the invitation email to go to https://consoleflow.com.
3. The Create Account form displays your first and last name, email address and organization name pre-filled. Edit your first and last name, if required.
4. Select Use email address as username or enter a username.
5. Enter a strong password, and retype the password.
6. Click Create Account. An email is sent to your email address with your ConsoleFlow account information, which includes the login URL, the organization name and your user ID. Save this email for future reference.
7. Proceed to install the mobile app.

Install the Mobile App¶

After creating your ConsoleFlow account, you're ready to install the ConsoleFlow mobile app.

1. Find the ConsoleFlow mobile app at the App Store.
2. Download and open the app.
3. Choose to Allow or Don't allow ConsoleFlow to send you notifications.
4. Select either cloud or on-premise as decided by your organization.
   - Continue with cloud, your mobile device will automatically connect to the ConsoleFlow server and you will see a login screen.
   - Setup on-premise, get your organization's server or URL details from your system administrator (server or URL - this is the part without "https://" or "consoleflow").
5. Enter this into your mobile device and tap Next. The login page appears.
6. Sign in to the app. You will remain logged in to the ConsoleFlow app indefinitely unless auto logout is enabled.

Reset Password¶

You can reset the password of your ConsoleFlow account in case you forget it.

1. On the ConsoleFlow sign in page, enter the Organization name, Portal name, and Username.
2. Tap the Forgot Password? link. The Reset Password page appears.
3. Enter your user ID and tap Reset Password. An email is sent to your registered email account.
4. In the email, click the Reset password link. The page to reset your ConsoleFlow password appears on a web browser.
5. Enter the new password and then click Reset. Your ConsoleFlow password is reset, and you can use the updated password to sign in to the application through the ConsoleFlow app or web interface.

App Features¶

The figure below shows the app layout. The tab bar directs you to the devices listed in your ConsoleFlow portal. You can view and use the app functionalities as per the user group access control assigned to your user group.

Tab Bar Icons¶

Tab Bar Icon	Functionality
Devices	- Add devices - Reboot Lantronix devices - Shut down Lantronix Devices - View device ports of device - Manage power outlets (SLB) - View child devices - View telemetry
Device Ports	- View all device ports
Configure	- Configure devices over Bluetooth - View configuration logs
More	- Update your profile - Access this online help - View Lantronix agreements - Update on-premise settings - Update credentials - Log out of the app

Search¶

Search supports partial or full text terms, and wildcard (using an asterisk) search.

To search:

1. On the Devices tab, swipe down from the top of the list to display the search bar.
2. Start typing the text into the field. The results will be displayed as you type. Tap Search to complete the search. You can also tap the clear button to erase the text from the field or tap Cancel to immediately terminate the search.

Filter¶

The filter feature supports the following keywords:

Keywords	Value
Name	Device name (This is the default keyword.)
Serial number	Serial number. It is 12-characters long for most Lantronix devices.
Status	Connected, Disconnected, Up, Down
Firmware version	Firmware version installed on the device
Model	Device model name
Ports	Number of device ports provided by device
IP address	IP address
Device description	Device description

To filter the device list:

1. On the Devices tab, swipe down from the top of the list to display the search bar.
2. Tap the Filter icon .
3. Tap one of the filter options:
   • Add Filter. Select a keyword and then type a partial or full keyword value. To add another filter, tap Add Filter again and select from the available keywords.
   • Select smart group, and select a smart group.
   • Select device group, and select a device group or a subgroup. To allow devices in subgroups to be visible when the parent group is selected, enable the option "Show devices in child groups".
   • Select tags, and select a tag.
4. Tap Done.
5. If you want to select another filter option repeat steps 3 and 4 above.
6. Tap Done to complete the filter operation.

The filtered list is displayed, or the message "No devices found" is displayed. The search bar displays the searched keyword:value pairs. Tap the clear button to erase the text from the field.

Devices¶

The Devices option displays the Lantronix devices listed in your ConsoleFlow portal. The connectivity statuses of the devices are also displayed in Devices.

To view devices:

1. Tap Devices.
2. To search for devices or filter the device list, swipe down from the top of the list to display the search bar. Enter the search term or tap the Filter icon to refine the list using keywords.
3. The connectivity status of the devices are indicated by the following color codes:
   Connected = active status
   Disconnected = inactive status
   Caution = status update interval expired and device has not contacted ConsoleFlow
4. To view device details, tap the device. Device details, such as generic device information, Properties, Device Ports, Power Outlets-SLB devices only, Child Devices, and Telemetry are displayed.
5. To view the properties of a device in detail, tap Properties and then tap Device Info, Firmware, Status, or Network.

Add Devices¶

The Add Device option allows you to use your phone's camera app to scan the barcode on the box of the device. To use this option, your account must have permission to add devices (Admin role, assigned to Full Access user group). In addition, the ConsoleFlow app must have permission to use the phone's camera app.

Before scanning, be sure that you are in a well-lit area to enable the camera to capture the barcode.

1. Tap Devices.
2. Tap the + icon to add a device.

3. The scanner app opens. Point the camera at the serial number barcode and ensure that the barcode appears in the camera's viewfinder.
   

4. Alternatively, tap Manually enter serial number, type the serial number and tap Enter.

5. The app displays the serial number of the device and a confirmation prompt. Tap Confirm to continue.
   
   If successful, a notification is displayed. Tap Devices to view the device information.

6. If the device is not present in the project and you are connecting it to the Cloud ConsoleFlow server, the app will prompt you to enter Project Admin credentials. Tap Add Credentials, enter the Project Admin username and password, and then tap Save. The app will import the device into the project and then add it to your organization's portal.

View Device Ports of Device¶

The Device Ports option that you reach when you tap on the device displays the serial (RJ45 or USB) device ports of the Lantronix device.

1. Tap Devices.
2. Tap the device and then tap Device Ports. The list of device ports with their connectivity statuses appear. The connectivity status of the ports are indicated by the following color codes:
   Connected = active status
   Disconnected = inactive status
   Caution = status update interval expired and device has not contacted ConsoleFlow
3. Tap the port to view the name of the device port, status, port number, users, bytes in, and bytes out.

Manage Power Outlets¶

The Power Outlets option allows you to turn on or off the power outlets of an SLB branch office manager.

1. Tap Devices.
2. Tap an SLB.
3. Tap Power Outlets to view its power outlets and their statues.
4. Tap Select to turn on the select feature.
5. Select one or more power outlets or tap Select All to select all power outlets.
6. Tap On, Off, or Cycle Power.
7. Enter your ConsoleFlow login password to confirm and tap Power On, Power Off, Power Cycle or tap Cancel.
8. Tap OK.

View Child Devices¶

The Child Devices option allows you to view the devices that are connected to the serial ports of a Lantronix gateway.

1. Tap Devices.
2. Tap a gateway.
3. Tap Child Devices to view the devices that are connected to its serial port.
4. To view the details of a child device, tap the child device. Child device-related information, such as status, ID, and description appears.

View Telemetry¶

Telemetry displays the telemetry information that the Lantronix devices send to ConsoleFlow.

1. Tap Devices.
2. Tap a Lantronix device.
3. To view the telemetry information of the device, tap Telemetry. The telemetry information enabled for the device are displayed.

Reboot Lantronix Devices¶

You can reboot a single or multiple Lantronix devices.

1. Tap Devices.
2. To reboot a device, swipe left on the device, and select Reboot.
3. To reboot multiple devices, tap the check box icon in the upper-left corner, select the check boxes corresponding to the devices that you want to reboot, and then tap Reboot.
4. To reboot all the devices on the page, tap the check box icon in the upper-left corner, tap Select All, and then tap Reboot. All the connected devices are rebooted.
5. Enter your ConsoleFlow password and tap Reboot. A message appears confirming the action.
6. Tap OK.

Shut Down Lantronix Devices¶

You can shut down a single or multiple Lantronix devices, if the device supports being shutdown from the software.

1. Tap Devices.
2. To shut down a device, swipe left on the device, and select Shutdown.
3. To shut down multiple devices, tap the check box icon in the upper-left corner, select the check boxes corresponding to the devices that you want to shut down, and then select Shutdown.
4. To shut down all the devices on the page, tap the check box icon in the upper-left corner, tap Select All, and then tap Shutdown. All the connected devices are shut down.
5. Enter your ConsoleFlow password and tap Shutdown. A message appears confirming the action.
6. Tap OK.

Connect Remotely via Web Terminal¶

ConsoleFlow allows you to make a secure, encrypted connection via SSL/TLS to Lantronix device CLIs and device ports. This connection opens a web terminal session in the web browser. The connection to the device or device port is terminated when you close the web browser, or after a period of inactivity.

1. Tap Devices or Device Ports.
2. Swipe right on the device or device port and select Connect.
3. The web terminal opens in a new browser window. Tap the screen to bring up a keyboard.
4. If this is a device connection, type 'help' or other CLI command at the prompt and then tap return.
5. If this is a device port connection, enter the username and password and then tap return to log into the device attached to the device port.
6. To end the session, close the browser window.

Device Ports¶

The Device Ports option displays all serial (USB and RJ45) device ports of the Lantronix devices registered in your ConsoleFlow portal.

To view all device ports:

1. Tap Device Ports. The device ports of all the Lantronix devices appears.
2. Tap a port. The details of the port appears.
3. Device Port Info displays the name of the device the port belongs to. Status displays the status of the port, Bytes displays the bytes in and out, and Sensorsoft displays the temperature.

Configure¶

The Configure option displays the configuration logs and allows you to provision SGX 5150 devices over Bluetooth using an available configuration template stored on the ConsoleFlow web application.

This feature is currently limited to SGX 5150 devices.

Configure Device¶

Before you begin, ensure that Bluetooth is enabled and the devices are discoverable.

1. Tap Configure. The configuration logs are displayed or the page is blank.
2. Tap + to create a new configuration.
3. Select a template file and tap Continue.
4. If prompted, allow the app usage permissions.
5. The phone discovers nearby devices and then displays them.
6. Select devices and tap Configure.
   The configuration is done serially. As each device is configured, a success or failure indicator is displayed.
7. The number of successful or failed device configurations is displayed. Tap OK to dismiss.

Configuration Logs¶

To view log details:

1. Tap Configure to display the logs.
2. Tap an item in the logs list.
3. View details. If the status is failed, a reason is displayed as sent by the device.

To delete logs:

1. Tap Configure.
2. Tap the select icon to enter the selection menu.
3. Select one or more devices or tap Select All.
4. Tap Delete.
5. Tap Delete to confirm.

Log In¶

To sign in to the ConsoleFlow mobile application, you must have a ConsoleFlow account and the ConsoleFlow app must be installed in your mobile phone.

1. Open the ConsoleFlow mobile app.
2. Enter Organization name and Portal name, and tap Next.
3. Enter User ID and Password, and tap Login. The list of devices registered in your ConsoleFlow portal appears. You will remain logged in to the ConsoleFlow app indefinitely unless auto logout is enabled.

Log Out¶

Logging out is useful if you wish to temporarily stop ConsoleFlow access of Lantronix devices, or to log in as a different user on your mobile device.

1. Tap More.
2. Tap Log out. A message appears to confirm the action.
3. Tap LOG OUT. You are logged out of the application and the ConsoleFlow login page appears.

Auto-Logout after Idle Timeout

You will be logged out of ConsoleFlow automatically once the idle timeout period has lapsed. The idle timeout can be configured or disabled on the ConsoleFlow web interface by the ConsoleFlow administrator.