Installing a basic integration on a Ubuntu machine

Download and install the basic integration on a Ubuntu machine. 

Step 1: Prerequisites 

The user responsible for the basic integration deployment must have root privileges to install binary packages.

Important
To find out which version of Python must be installed, see GitHub: Getting started. In the code examples, the variable <N.N> is to be replaced with the version of Python that is to be installed.

 In LTS Ubuntu 18.04.4 and later, Python must be installed manually, as it does not come pre-installed. 

1. Update the package list and install essential packages:

sudo apt-get update
sudo apt-get install software-properties-common

2. Add the Deadsnakes PPA and install Python:

sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
sudo apt-get install python<N.N> python<N.N>-dev

3. Install distutils

sudo apt install python<N.N>-distutils

4. Install additional required packages for the LDAP integration

sudo apt-get install libsasl2-dev python<N.N>-dev libldap2-dev libssl-dev

5. Install virtualenv:

sudo apt-get install virtualenv

6. Install ODBC development headers and libraries:

sudo apt update
sudo apt install unixodbc-dev
pip install pyodbc

7. Install CFFI development headers and libraries:

sudo apt update
sudo apt install libffi-dev
pip install cffi

Step 2: Download and install the Oomnitza basic integration

After installing Python and its prerequisites, you can download and set up the basic integration.

1. Create a directory for the Oomnitza integration and set up the virtual environment:

mkdir oomnitza
cd oomnitza
virtualenv -p python<N.N> venv

2. Activate the virtual environment:

source venv/bin/activate

3. Clone the Oomnitza Connector Repository:

sudo apt install git
git clone https://github.com/Oomnitza/oomnitza-connector
cd oomnitza-connector

4. Install the Python dependencies.

pip install -r requirements.txt

Step 3: Prepare the Configuration File

With the Oomnitza basic integration set up, proceed to generate and configure the config.ini file:

1. Generate the config.ini file:

python<N.N> connector.py generate-ini

2. Edit the config.ini and enter the integration credentials. For more information refer to the Connector Configs section in the GitHub documentation.

Step 4: Map vendor fields to Oomnitza fields

Map the vendor fields to Oomnitza fields to get the information that you need. For the field mapping, it is recommended to follow these steps in your Oomnitza instance:

1. Click Configuration > Integrations and click Block view 
2. Choose your vendor integration from the Basic Integrations section.
3. Click Mappings.
4. Map the vendor fields to the Oomnitza fields.  
5. Select a sync key, such as a Serial Number or Email. The field must have unique values.
6. Click FINISH.

Note
If you are creating a user integration, both the Username and Email fields must be mapped, and a default Role set. You can select a suitable option from the Role dropdown on the Oomnitza mapping side.

Did you know? 
You can complete additional actions in the configuration file, such as filtering the values that are mapped   Filtering basic integrations

Step 5: Run the Oomnitza basic integration

Run the basic integration, and confirm it is working:

python<N.N> connector.py upload [connector]

Note
Replace [connector] with an enabled basic integration, e.g. meraki_network_devices

Step 6: Schedule the basic integration

To schedule the Oomnitza basic integration for regular synchronization, use the cron scheduler:

1. Open the crontab configuration:

crontab -e

2. Add a command to run the basic integration daily at 10 PM (or any other desired schedule):

0 22 * * * cd /opt/oomnitza-connector-master && python<N.N> connector.py upload [connector]