metasploit-framework

https://github.com/rapid7/metasploit-framework

Ruby

Metasploit Framework

Msf::Simple::Auxiliary.run_simple

Wraps the auxiliary process in a simple single method.  The options
hash can have the following values passed in it:

Action

	The selected action name.

OptionStr

	A string of comma separated option values that should be imported into
	the datastore.

Options

	A hash of values to be imported directly into the datastore.

LocalInput

	The local input handle that data can be read in from.

LocalOutput

	The local output through which data can be displayed.

RunAsJob

	Whether or not the exploit should be run in the context of a background
	job.

Source | Google | Stack overflow

Edit

git clone [email protected]:rapid7/metasploit-framework.git

cd metasploit-framework

open lib/msf/base/simple/auxiliary.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Msf--Simple--Auxiliary-run_simple-for-pr

# Commit to git

git add lib/msf/base/simple/auxiliary.rbgit commit -m "better docs for Msf::Simple::Auxiliary.run_simple"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-Msf--Simple--Auxiliary-run_simple-for-pr

hub pull-request

# Celebrate!