Help Module

Alfred Botman

Compatibility:

Description

This module will display a list of loaded modules, and for each of them, the registered commands and their description.
If the Access module is loaded, it will also print the access level needed to use the command (command is hidden if your level is too low).
Nothing has to be done for a module to be detected by the Help module.
Your module only need to register its commands to the Gotham library for the Help module to see it.

Configuration

This module does not need any configuration to be done.

Commands

Alfred Botman

(16:24:13) guillaume.friloux@botnet.master.com: .help
(16:24:13) botman-bull - asp6400037: 
List of commands :
   Commands for module Version :
      .version (1) : [.version] - This command returns the version of some installed softwares. Software list and custom version commands can be specified in version.conf.

   Commands for module Install :
      .install (1) : [.install softwarelist] - Install softwarelist.
      .upgrade (1) : [.upgrade] - Performs an upgrade on all repositories.
      .jobs (1) : [.jobs] - List running install / upgrade jobs
      .kill (1) : [.jobs job_id] - Kill running install / upgrade job.

   Commands for module Module :
      .module (1) : [.module] - This command allows you to list loaded modules.
      .module load (1) : [.module load module_name] - This command allows you to load a module.
      .module unload (1) : [.module unload module_name] - This command allows you to unload a module.
      .module reload (1) : [.module reload module_name] - This command allows you to reload a module.

   Commands for module Ssh_Tunnel :
      .ssh (1) : [.ssh] - This command will show informations about the tunnel (opened or not, which port)
      .ssh on (1) : [.ssh on] - This command will try to open a tunnel and send back the port to use.
      .ssh off (1) : [.ssh off] - This command will shut down the tunnel if it's opened.

   Commands for module Sysinfo :
      .sysinfo (1) : [.sysinfo] - This command allows you to get some system informations (manufacturer, serial #, ...)
      .psax (1) : [.psax] - Run ps ax on server
      .reboot (1) : [.reboot] - Run reboot on server
      .uptime (1) : [.uptime] - Run uptime on server

   Commands for module Access :
      .access (10) : This command will list all user accesses.

   Commands for module GDB :
      .gdb list (1) : [.gdb list] - This command will list coredumps inside the coredumps directory.
      .gdb delete (1) : [.gdb delete <pattern>] - This command will delete coredumps matching given parttern.
      .gdb fetch (1) : [.gdb fetch <coredump>] - This command will retrieve the backtrace from a given coredump.

   Commands for module Help :
      .help (1) : [.help] - This command allows you to list all the commands registered by modules.

   Commands for module Save :
      .save (1) : [.save] - This command will show informations about the backup.
      .save set (1) : [.save set variable value] - This command allows you to set a variable. Possible variables : 'interval'.