Skip to main content

Main

help

The help command is used to view available commands for the Listener menu. Tab completion can be used at any time to provide the user a list of commands that can be selected. Merlin is equipped with a tab completion system that can be used to see what commands are available at any given time. Hit double tab to get a list of all available commands for the current menu context.

back

The back command is used to move one level back. In this case the command will return the user to the main menu.

configure

The configure command is used to operate, or configure, a previously created listener.
Cycle through the available listeners using the tab key after the info command.

delete

The delete command is used to delete a listener by its name. The user will be prompted for confirmation to prevent accidentally deleting a listener.
Cycle through the available listeners using the tab key after the delete command.

info

The info command is used to display information about a previously created Listener. View the Listeners page for additional information on specific listener configurable options.
Cycle through the available listeners using the tab key after the info command.
  • Protocol: The communication protocol the listener will use
  • Name: The operator defined name for the listener
  • Port: The port that the listener will bind to
  • PSK: The Pre-Shared Key (PSK) that the listener will use for initial communication with an agent
  • URLS: The URLs that the listener will answer on for agent communications
  • X509Cert: The file path to the SSL/TLS x509 public certificate the listener will use
  • X509Key: The file path to the SSL/TLS x509 key file the listener will use
  • Description: The operator defined description of the listener
  • ID: A unique identifier for the instantiated listener
  • Interface: The network interface that the listener will bind to. Use 0.0.0.0 for ALL interfaces

interact

The 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.

list

The list command returns a list of all created listeners to include some configuration information and status.

main

The main command returns to the main menu.

sessions

The sessions command is used to quickly list information about established agents from the main menu to include their status. The sessions command is available from any menu in the CLI.
  • AGENT GUID - A unique identifier for every running instance
  • TRANSPORT - The protocol the agent is communicating over
  • PLATFORM - The operating system and architecture the agent is running on
  • HOST - The hostname where the agent is running
  • USER - The username that hte agent is running as
  • PROCESS - The Agent’s process name followed by its Process ID (PID) in parenthesis
  • STATUS - The Agent’s communication status of either active, delayed, or dead
  • LAST CHECKIN - The amount of time that has passed since the agent last checked in
  • NOTE - A free-form text area for operators to record notes about a specific agent; tracked server-side only

start

The start command is used to start a previously created and stopped Listener by its name.
Cycle through the available listeners using the tab key after the start command.

stop

The stop command is used to stop a previously created Listener by its name.
Cycle through the available listeners using the tab key after the stop command.

use

The use command is leveraged to create a new listener. The use command expects the listener type, by protocol, to follow. Press enter to select a template for the listener type.
Cycle through the available listener types using the tab key after the use command.
View the Listeners page for additional information on specific listener configurable options.

!

Any command that begins with a ! (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.

Instantiated

This menu is accessed by issuing the the interact command followed by the name of previously created (instantiated) Listener. The help command is used to view available commands for the instantiated Listener menu. Tab completion can be used at any time to provide the user a list of commands that can be selected.

back

The back command is used to move one level back. In this case the command will return the user to the root Listener menu.

delete

The delete command is used to delete the Listener you are currently interacting with, indicated in the square brackets in the Merlin prompt. The user will be prompted for confirmation to prevent accidentally deleting a listener.

info

The info command is used to display information about the Listener you are currently interacting with, indicated in the square brackets in the Merlin prompt. View the Listeners page for additional information on specific listener configurable options.

interact

See the interact section

main

The main command returns to the Main menu

restart

The restart command stops the current listener and then immediately starts it. This is useful to apply configuration changes made with the set command.

sessions

See the sessions section

set

The set command is used to set the value of a configurable option for the Listener you are currently interacting with. Use the show command to see a list of configurable options.
Cycle through the available configurable options for the current Listener using the tab key after the set command.
View the Listeners page for additional information on specific listener configurable options.

show

The show command is used to show a table of all configurable options. View the Listeners page for additional information on specific listener configurable options.

start

The start command is used to start the current Listener you are interacting with, indicated in the square brackets in the Merlin prompt.

status

The status command is used to quickly determine if the Listener’s server you are currently interacting with is running or stopped.

stop

The stop command is used to stop the current Listener you are interacting with, indicated in the square brackets in the Merlin prompt.

!

Any command that begins with a ! (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.

Template

The Listener Template menu is accessed by issuing the use command followed by a valid listener type from the Listener Main menu. The help command is used to view available commands for the Listener menu. Tab completion can be used at any time to provide the user a list of commands that can be selected. View the Listeners page for additional information on specific listener configurable options.

back

The back command is used to move one level back. In this case the command will return the user to the root Listener menu.

execute

The execute command is used to create and start the Listener from the configured template options. This is an alias for the start command.

info

The info command is used to display the Listener template configurable options and their current value. View the Listeners page for additional information on specific listener configurable options.

interact

See the interact section

main

The main command returns to the Main menu

run

The run command is used to create and start the Listener from the configured template options. This is an alias for the start command.

sessions

See the sessions section

set

The set command is used to set the value of a configurable option for the Listener you are currently interacting with. Use the show command to see a list of configurable options.
Cycle through the available configurable options for the current Listener using the tab key after the set command.
View the Listeners page for additional information on specific listener configurable options.

show

The show command is used to display the Listener template configurable options and their current value. View the Listeners page for additional information on specific listener configurable options.

start

The start command is used to create and start the Listener from the configured template options.

!

Any command that begins with a ! (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.