Digi IX30 User Manual page 631

Applications
Help for using Python to execute IX30 CLI commands
Get help executing a CLI command from Python by accessing help for cli.execute:
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 IX30 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 (default, May
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>
3. Import the cli submodule:
>>> from digidevice import cli
>>>
4. Use the help command with cli.execute:
>>> help(cli.execute)
Help on function execute in module digidevice.cli:
execute(command, timeout=5)
Execute a CLI command with the timeout specified returning the results.
...
5. Use Ctrl-D to exit the Python session. You can also exit the session using exit() or quit().
Use digidevice.datapoint to upload custom datapoints to Digi Remote Manager
Use the datapoint Python module to upload custom datapoints to Digi Remote Manager.
The following characteristics can be defined for a datapoint:
Stream ID
n
Value
n
(Optional) Data type
n
integer
l
long
l
float
l
double
l
string
l
binary
l
Units (optional)
n
Timestamp (optional)
n
IX30 User Guide
9 2021, 22:49:59)
Develop Python applications
631