mikrotikaudit 0.0.1a2
Takes Mikrotik config and dumps to SmartSheet, you need a SS API Key and a Workspace ID
License: MIT License
Keywords: mtaudit,mikrotik,smartsheet

# `mikrotikaudit`

<p align="center">
    <a href="https://pypi.python.org/pypi/mikrotikaudit"><img alt="PyPI" src="https://img.shields.io/pypi/v/mikrotikaudit.svg"></a>
	<a href="https://pypi.python.org/pypi/mikrotikaudit"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/mikrotikaudit.svg"></a>
    <a href="https://pepy.tech/project/mikrotikaudit"><img alt="Downloads" src="https://pepy.tech/badge/mikrotikaudit"></a>
    <a href="#Contribution" title="Contributions are welcome"><img src="https://img.shields.io/badge/contributions-welcome-green.svg"></a>
    <a href="https://github.com/{self.Github_username}/mikrotikaudit/releases" title="mikrotikaudit"><img src="https://img.shields.io/github/release-date/{self.Github_username}/mikrotikaudit?color=green&label=updated"></a>
    <img alt="PyPI - License" src="https://img.shields.io/pypi/l/mikrotikaudit">
    <img alt="PyPI - Status" src="https://img.shields.io/pypi/status/mikrotikaudit">
    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/{self.Github_username}/mikrotikaudit">
    <a href="https://twitter.com/@{self.Github_username}" title="Follow us on Twitter"><img src="https://img.shields.io/twitter/follow/{self.Github_username}.svg?style=social&label=Follow"></a>
</p>


## CONTENTS

1. [OVERVIEW](#1.-OVERVIEW)
2. [INSTALLATION](#2.-INSTALLATION)
3. [BASIC USE](#3.-BASIC-USE)
4. [UNDER THE BONNET](#4.-UNDER-THE-BONNET)
5. [CONTRIBUTING](#5.-CONTRIBUTING)
6. [CREDITS](#6.-CREDITS)
7. [PAYING IT FORWARD](#7.-PAYING-IT-FORWARD)


## 1. OVERVIEW
Takes Mikrotik config and dumps to SmartSheet, you need a SS API Key and a Workspace ID

## 2. INSTALLATION

    pip install mikrotikaudit


## 3. BASIC USE

    >>> import mikrotikaudit

    Here is an example of a new firewall not in the workspace

```buildoutcfg
%mikrotik-audit audit --client CID<#> --firewall <FIREWALL IP/FQDN>
New Client; Creating folder.
no firewall folders for this client; creating new folder & sheets
No sheets found in folder; creating new sheets.
Dumping Interfaces and IP Addresses
Dumping Routes
Dumping Filter Rules
Dumping NAT Rules
Dumping Address lists
Dumping IPsec Phase 1
Dumping IPsec Phase 1 Profiles
Dumping IPsec phase 2
Dump has completed
----------
Client: CID<#>
Firwall Audited: <FIREWALL IP/FQDN>
Link: <LINK to SS SHEET>
Total run time: 0:01:02.888635
----------
```

The script also checks if the firewall was already audited and purges and creates a new one

```buildoutcfg
%mikrotik-audit audit --client CID<#> --firewall <FIREWALL IP/FQDN>
found old firewall folder
Old sheets found; purging and creating new ones.
Dumping Interfaces and IP Addresses
Dumping Routes
Dumping Filter Rules
Dumping NAT Rules
Dumping Address lists
Dumping IPsec Phase 1
Dumping IPsec Phase 1 Profiles
Dumping IPsec phase 2
Dump has completed
----------
Client: CID890
Firwall Audited: <FIREWALL IP/FQDN>
Link: <LINK To SS SHEET
Total run time: 0:01:04.766957
----------
```




## 4. UNDER THE BONNET

Once you have downloaded the package, you need to modify your .env file.
Included in the project is a  file called ```.env.example.``` Rename the file as ```.env```.

It should look similar to this

```buildoutcfg
SMARTSHEET_ACCESS_TOKEN = "{YOUR SMARTSHEET API TOKEN}"
MIKROTIK_USERNAME = "admin"
MIKROTIK_PASSWORD = "{MIKROTIK PASSWORD}"
WORKSPACE_ID = "XYZ"
TEMPLATE_ID = "XYZ"
```

## 5. CONTRIBUTING

Contact Angelo Poggi angelo.poggi@webair.com or feel free to raise Pull Requests / Issue in the normal Github way.

## 6. PAYING IT FORWARD

If `mikrotikaudit` helps you save time and focus on more important things, please feel free to to show your appreciation by starring the repository on Github.

I'd also be delighted if you wanted to:

<a href="https://www.buymeacoffee.com/{self.Github_username}" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/arial-yellow.png" alt="Buy Me A Coffee" width="217px" ></a>