Digi Connect IT 4 User Manual page 603

Applications
Use Python to respond to Digi Remote Manager SCI requests
The device_request Python module allows you to interact with Digi Remote Manager by using
Remote Manager's Server Command Interface (SCI), a web service that allows users to access
information and perform commands that relate to their devices.
Use Remote Manager's SCI interface to create SCI requests that are sent to your Connect IT 4 device,
and use the device_request module to send responses to those requests to Remote Manager.
See the Digi Remote Manager Programmers Guide
Task one: Use the device_request module on your Connect IT 4 device to create a response
1. Select a device in Remote Manager that is configured to allow shell access to the admin user,
and click Actions > Open Console. Alternatively, log into the Connect IT 4 local command line
as a user with shell access.
Depending on your device configuration, you may be presented with an Access selection
menu. Type shell to access the device shell.
2. At the shell prompt, use the python command with no parameters to enter an interactive
Python session:
# python
Python 3.10.1 (main, Mar 30 2023, 23:47:13) [GCC 11.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>
3. Import the device_request module:
>>> from digidevice import device_request
>>>
4. Create a function to handle the request from Remote Manager:
>>> def handler(target, request):
print ("received request %s for target %s" % (request, target))
return "OK"
>>>
5. Register a callbackup function that will be called when the device receives a SCI request from
Remote Manager:
>>> device_request.register("myTarget", handler)
>>>
Note Leave the interactive Python session active while completing task two, below. Once you have
completed task two, exit the interactive session by using Ctrl-D. You can also exit the session using
exit() or quit().
Task two: Create and send an SCI request from Digi Remote Manager
The second step in using the device_request module is to create an SCI request that Remote
Manager will forward to the device. For example, you can create in SCI request a the Remote Manager
API explorer:
Digi Connect IT® 4 User Guide
Develop Python applications
for more information on SCI.
603