Module Manager CLI

Module Manager CLI#

To interact with the Module Manager there are command line interfaces available. The commands are listed below.

Module commands#

  • pal module list: This command will list all the modules that are loaded in the robot.

  • pal module info <module-name>: This command will print information about the selected module. Pressing TAB will list the modules whose information can be seen.

  • pal module show <module-name>: This command will print the content of the selected module. Pressing TAB will list the modules whose content can be seen.

  • pal module start <module-name> [<module-2-name> ...] [--force]: This command will start a list of modules in the robot. It also supports the optional --force argument to ignore all the dependencies and start the modules directly. Pressing TAB will list the applications that can be started.

  • pal module stop <module-name> [<module-2-name> ...]: This command will stop a list of modules in the robot. Pressing TAB will list the applications that can be stopped.

  • pal module restart <module-name> [<module-2-name> ...] [--force]: This command will restart a list of modules in the robot. It also supports the optional --force argument to ignore all the dependencies and restart the modules directly. Pressing TAB will list the applications that can be restarted.

  • pal module log <module-name>: This command will print the name and path of the log file of the selected application. Pressing TAB will list the applications whose log can be seen. Using the command pal module log <module-name> cat, will directly print the log file.

  • pal module enable <module-name> [<module-2-name> ...] [--start]: This command will enable a list of modules in the robot, so they will be run in the next start of the module manager. By default, this does not immediately start the module, you can use the optional --start argument to start the module right away. Pressing TAB will list the applications that can be enabled.

  • pal module disable <module-name> [<module-2-name> ...] [--stop]: This command will disable a list of modules in the robot, so they will not be run in the next start of the module manager. By default, this does not immediately stop the module, you can use the optional --stop argument to stop the module right away. Pressing TAB will list the applications that can be disabled.

Module set commands#

  • pal module_set list: This command will list all the module sets that are loaded in the robot.

  • pal module_set info <module-set-name>:his command will show practical information about the selected module set. Pressing TAB will list the module sets whose information can be seen.

  • pal module_set show <module-set-name>: his command will show the content of the file that defines the selected module set. Pressing TAB will list the module sets whose content can be seen.

Virtual group commands#

  • pal virtual_group list: This command will list all loaded modules along with their current status in each virtual group.

  • pal virtual_group status <virtual-group-name>: This command will print all loaded modules along with their current status in a virtual group. Pressing TAB will list the virtual groups whose status can be seen.

  • pal virtual_group info <virtual-group-name>: This command will print information about a virtual group. Pressing TAB will list the virtual groups whose information can be seen.

  • pal virtual_group show <virtual-group-name>: This command is used to display the content of the file that defines a virtual group. Pressing TAB will list the virtual groups whose content can be seen.

  • pal virtual_group start <virtual-group-name>: This command will start all modules in a virtual group. Pressing TAB will list the virtual groups that can be started.

  • pal virtual_group stop <virtual-group-name>: This command will stop all modules in a virtual group. Pressing TAB will list the virtual groups that can be stopped.

  • pal virtual_group restart <virtual-group-name>: This command will restart all modules in a virtual group. Pressing TAB will list the virtual groups that can be restarted.

  • pal virtual_group enable <virtual-group-name>: This command will enable a virtual group, so all the modules in this virtual group will be started when the module manager starts. Pressing TAB will list the virtual groups that can be enabled.

  • pal virtual_group disable <virtual-group-name>: This command will disable a virtual group, so all the modules in this virtual group will not be started when the module manager starts. Pressing TAB will list the virtual groups that can be disabled.

Module Manager commands#

  • pal module_manager start: This command will start the module manager.

  • pal module_manager stop: This command will stop the module manager.

  • pal module_manager restart: This command will restart the module manager.

  • pal module_manager enable: This command will enable the module manager. It will be started on boot.

  • pal module_manager disable: This command will disable the module manager. It will not be started on boot.

!!! Warning Disabling the module manager will prevent the robot from starting the applications on boot. This is not recommended.

  • pal module_manager status: This command will show the current status of the service that manages module manager.

  • pal module_manager log: This command will show the logs of the module manager.

!!! Note
These module manager commands are convenience wrappers around systemctl and journalctl calls.

See Also#