Use digidevice runtime to access the runtime database

Use the runt submodule to access and modify the device runtime database.

Read from the runtime database

Use the keys() and get() methods to read the device configuration:

  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 EX15 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 runt submodule:
    >>> from digidevice import runt
    >>>
  4. Use the start() method to open the runtime database:
    >>> runt.start()
    >>>
  5. Use the keys() method to display available keys in the runtime database, and use the get() method to print information from the runtime database:
    1. Print available keys:
      >>> print(runt.keys(""))

      This returns available keys:

      ['advanced', 'drm', 'firmware', 'location', 'manufacture', 'metrics', 'mm', 'network', 'pam', 'serial', 'system']
    2. Print available keys for the system key:
      >>> print(runt.keys("system"))

      This will return the following:

      ['boot_count', 'chassis', 'cpu_temp', 'cpu_usage', 'disk', 'load_avg', 'local_time', 'mac', 'mcu', 'model', 'ram', 'serial', 'uptime']
    3. Use the get() method to print the device's MAC address:
      >>> print(runt.get("system.mac"))

      This will return the MAC address of the device.

  6. Use the stop() method to close the runtime database:
  7. Use Ctrl-D to exit the Python session. You can also exit the session using exit() or quit().

Modify the runtime database

Use the set() method to modify the runtime database:

  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 EX15 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 runt submodule:
    >>> from digidevice import runt
    >>>
  4. Use start() method to open the runtime database:
    >>> runt.start()
    >>>
    
  5. Use the set() method to make changes to the runtime database:
    >>> runt.set("my-variable", "my-value")
    >>>
  6. Use the get() method to verify the change:
    >>> print(runt.get("my-variable"))
    my-variable
    >>>
  7. Close the runtime database:
    >>> runt.stop()
    >>>
  8. Use Ctrl-D to exit the Python session. You can also exit the session using exit() or quit().