Digi IX40 User Manual page 678

Applications
digidevice.location - digidevice.location - API for accessing location data
...
5. Use Ctrl-D to exit the Python session. You can also exit the session using exit() or quit().
Use Python to set the maintenance window
The maintenance Python module allows you to set the service state of a device. When the module
sets the device to out of service, this can be used as trigger to begin maintenance activity. See
Schedule system maintenance tasks
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 IX40 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 maintenance module:
>>> from digidevice import maintenance
>>>
4. To determine the current service state of the device:
>>> maintenance.state()
'IN_SERVICE'
>>>
5. To set the device to out of service:
>>> maintenance.out_of_service()
>>> maintenance.state()
'OUT_OF_SERVICE'
>>>
6. To set the device to in service:
>>> maintenance.in_service()
>>> maintenance.state()
'IN_SERVICE'
>>>
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().
IX40 User Guide
for more details.
Develop Python applications
678