diff --git a/README.md b/README.md new file mode 100644 index 0000000..d6716b7 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# failed_login.py + +This tool will return all failed logins to the target search head for the past 7 days. + +## Installation + +**For safety, install to a python virtual environment** + +1. Clone the repository ```git clone ``` +2. Install the prerequisites ```pip install requirements.txt``` + +## Usage + +python failed_login.py [OPTIONS] + +Options: + --host TEXT Splunk hostname [required] + --port INTEGER Splunk REST API port [default: 8089] + --username TEXT Splunk username [required] + --password TEXT Splunk password [required] + --help Display help