modules command to enter the modules menu from any other menu.
Prefix any command with help (e.g., help run) to view the command’s help information.
Use any of the following flags after a command name to view the help information for that command:
help, -h, --help, ?, /?
While the help information below shows a number of commands, only the following commands are unique to just the
modules menu:
Help menu from the root modules menu:
!
USAGE:
! command [args]! (a.k.a bang or exclamation point) will be executed on host itself where the Merlin
server is running. This is useful when you want simple information, such as your interface address, without having to
open a new terminal.
There must be a space after the
! for the command to be executed.back
USAGE:
backback command is used to leave the Module menu and return back to the main menu.
banner
USAGE:
bannerbanner command is used too print the super cool ascii art banner along with the version and build numbers.
clear
USAGE:
clearclear command will cancel all jobs in the queue that have not been sent to the agent yet.
This command will only clear jobs for the current agent.
debug
USAGE:
debugdebug command is a switch used to enable or disable debug output to the console.
info
USAGE:
infoinfo command command is used to print all of the information about a module to the screen.
This information includes items such as module’s name, authors, credits, description, notes, and configurable options.
interact
USAGE:
interact {agentID|listenerID}interact command takes one argument, the agent ID, and is used to switch agents and interact with a different, specified agent.
Use the built-in tab completion to cycle through and select the agent to interact with.
listeners
USAGE:
listenerslisteners command moves to the Listeners menu.
main
USAGE:
mainmain command is used to leave the Agent menu and return back to the main menu. It is an alias for the back command.
reload
USAGE:
reloadreload command is used to clear out all of a module’s configurable options and return its settings to the default state.
run
USAGE:
runrun command is used to execute the module on the agent configured for the module’s Agent value.
sessions
USAGE:
sessionssessions command is used to quickly list information about established agents from the module menu to include their status.
The sessions command is available from any menu in the CLI.
set
Theset command is used to set the value for one of the module’s configurable options.
This command is used by specifying the name of the option that should be set followed by a value.
Tab completion is enabled and provides a list of all configurable options.
set Agent
TheAgent option for every module must be set in order for it have a target to execute on.
By default, the module is configured with a blank value of 00000000-0000-0000-0000-000000000000.
To set an agent, provide the agent’s ID (tab completion enabled).
all can be provided and instructs Merlin to execute the module on all agents.
When this value is provided, the module’s agent option is set to all F’s like: ffffffff-ffff-ffff-ffff-ffffffffffff
show
USAGE:
showshow command is used to show the module’s configurable options
verbose
USAGE:
verboseverbose command is a switch used to enable or disable verbose output to the console.