GVE_DevNet_FTD_SysLog_Monitoring_System

A back-end script created to monitor the Syslog of a FTD HA Pair.
The script is configured to monitor for a specific Syslog message that specifies an error may have occurred.
If the message is found, the Network Admin is notified to take action.

Contacts

  • Alexander Hoecht
  • Alex Hansen

Solution Components

  • Python 3 Download latest version
  • Cisco FMC
  • Cisco FTD (configured in an HA Pair)
  • Ubuntu Server (loaded with RSYSLOG)
  • Cisco Webex ChatBot (configured HERE)
    • NOTE: Retrieve Webex Person ID HERE

Install Requirements

Steps needed to install the dependencies for the project environment

# Create a Virtual Environment
python3 -m venv Virtual_Environment

# Activate Virtual Environment
source Virtual_Environment/bin/activate # (MacOS)
Virtual_Environment/Scripts/activate # (Windows)

# Install Dependencies
pip install -r requirements.txt

Configuration

Input the following information to configure application

# In mainapp.py 
# Set Syslog configuration
SYSLOG_HOSTNAME = ''
SYSLOG_USERNAME = ''
SYSLOG_PASSWORD = ''


# In bot.py
# WebEx API Bot Setup
BASE_URL = 'https://webexapis.com/v1'
BOT_NAME = ''
BOT_USERNAME = '@webex.bot'
BOT_ID = ''
BOT_ACCESS_TOKEN = ''
# Webex Person ID used for Direct reporting
PERSON_ID = ''

Running the Application

Once Dependencies are installed to Environment:

# Start the application
python3 mainapp.py

# Input FMC Connection Arguments
Input FMC hostname (FQDN or IP) []: AAA.BBB.CCC.DDD
Input FMC Username []: FMC_USERNAME
Input FMC Password []: FMC_PASSWORD

# On Successful FMC Connection
Input the ID of the HA pair to manage []: HA_PAIR_ID

High-Level Diagram

/IMAGES/hld.png

LICENSE

Provided under Cisco Sample Code License, for details see LICENSE

CODE_OF_CONDUCT

Our code of conduct is available here

CONTRIBUTING

See our contributing guidelines here

DISCLAIMER:

Please note: This script is meant for demo purposes only. All tools/ scripts in this repo are released for use "AS IS" without any warranties of any kind, including, but not limited to their installation, use, or performance. Any use of these scripts and tools is at your own risk. There is no guarantee that they have been through thorough testing in a comparable environment and we are not responsible for any damage or data loss incurred with their use.
You are responsible for reviewing and testing any scripts you run thoroughly before use in any non-testing environment.

View code on GitHub
Related code repos

    Code Exchange Community

    Get help, share code, and collaborate with other developers in the Code Exchange community.View Community
    Disclaimer:
    Cisco provides Code Exchange for convenience and informational purposes only, with no support of any kind. This page contains information and links from third-party websites that are governed by their own separate terms. Reference to a project or contributor on this page does not imply any affiliation with or endorsement by Cisco.