ConnectCore Cloud Services allow you to access a device console and also execute one-shot commands using Remote Manager web service APIs.

To open a console session or execute commands, you must use SCI (Server Command Interface), a web service that allows users to access information and perform commands that relate to their device. See https://doc-remotemanager.digi.com/ for more information.

You can remotely execute commands on connected devices from:

See ConnectCore Cloud Services web services for more information on how to use web service APIs.

Console page

Remote Manager interface includes a device console for connected devices:

  1. Log in to your Remote Manager account (https://remotemanager.digi.com).

  2. Select Device Management > Devices on the left bar.

  3. Click the Device ID link of your device in the table. The device page loads.

  4. Go to the Console tab on the top menu.

    The tool starts a new command line interface session that requires an authentication step.

    Once logged in, you can operate a remote console in the target.

cli_session

For extended Remote Manager web interface use and reference information, see the Digi Remote Manager User Guide.

API Explorer

You can use API Explorer to execute a single command in a connected device:

  1. Log in to your Remote Manager account (https://remotemanager.digi.com).

  2. Get your device identifier.

    It follows the format 00000000-00000000-00XXXXXX-XXXXXXXX.

    1. Go to the Device Management > Devices tab.

    2. Copy the Device ID of your device from the table by using the Copy Device ID button that appears next to it when you hover over the item.

      If you have more than one device, you can filter using the MAC address of your device:

      1. Click on the filter text box and select MAC.

      2. Type the MAC address of your device and press Enter.

  3. Go to the System > API Explorer tab.

  4. Click the Examples combo.

  5. Select SCI > CLI > Send a single command.

    A request appears inside the Body text box.

  6. Modify the request to send your command:

    1. Replace the device id value with the copied one.

    2. Replace the device cli command value with the command to execute, for example ls /tmp.

    The request should be similar to the following:

    <sci_request version="1.0">
   <cli>
      <targets>
            <device id="00000000-00000000-00XXXXXX-XXXXXXXX"/>
      </targets>
      <execute timeout="10">ls -a /tmp</execute>
   </cli>
</sci_request>

    Where 00000000-00000000-00XXXXXX-XXXXXXXX is your device id.

  7. Click Send to send the request to your device.

    In the Response text box you can review the answer from the device:

    <sci_reply version="1.0">
  <cli>
    <device id="00000000-00000000-00XXXXXX-XXXXXXXX">
      <execute status="0" format="base64">nHNvY2tpbnN0Y3RybApzd3VwZGF0ZXByb2cKc3lzdGVtZC1wcml2YXRlLTA0YTlhMjVjZGVmMDQ3ZGE4M2Q0YjUyN2VkZWJlM2U3LU1vZGVtTWFuYWdlci5zZXJ2aWNlLUtZZWRSYgpzeXN0ZW1kLXByaXZhdGUtMDRhOWEyNWNkZWYwNDdkYTgzZDRiNTI3ZWRlYmUzZTctc3lzdGVtZC1sb2dpbmQuc2VydmljZS1TcXBTMzkKc3lzdGVtZC1wcml2YXRlLTA0YTlhMjVjZGVmMDQ3ZGE4M2Q0YjUyN2VkZWJlM2U3LXN5c3RlbWQtcmVzb2x2ZWQuc2VydmljZS00UnJtM2wKc3lzdGVtZC1wcml2YXRlLTA0YTlhMjVjZGVmMDQ3ZGE4M2Q0YjUyN2VkZWJlM2U3LXN5c3RlbWQtdGltZXN5bmNkLnNlcnZpY2Utek9HZE4yCg==</execute>
    </device>
  </cli>
</sci_reply>

    Where 00000000-00000000-00XXXXXX-XXXXXXXX is your device id.

You can use any third-party tool with Remote Manager web service APIs. See ConnectCore Cloud Services web services for more information.

python-devicecloud library

Python client library for Digi Remote Manager web service APIs, python-devicecloud, supports SCI feature to execute commands in one or several devices as well as the possibility of creating monitors to notify when a console session starts, terminates, or the devices sends data.

The Get Started with ConnectCore Cloud Services demo web application, used in the ConnectCore Cloud Services demo guide, includes the following support in the Console terminal of the Dashboard page:

  • SCI to initialize, start, stop, and send data to a console session. See methods initialize_cli_session(), start_cli_session(), stop_cli_session(), and send_cli_data() in drm_requests.py.

  • Monitors to be notified about CLI events. See method register_cli_monitor() in drm_requests.py.

You can use your preferred programming language to remotely execute commands. See ConnectCore Cloud Services web services for more information.