More classes, much better data model and vcenter and centreon connectors

.gitignore

@@ -1,8 +1,9 @@
 .idea
 *.pyc
-itop-cli.cfg
+python-itop-api.cfg
 MANIFEST
 dist
 build
 Makefile
-python_itop_api.egg-info
+python_itop_api.egg-info
+pylint.bat

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015, Guillaume Philippon
+Copyright (c) 2015-2016, Guillaume Philippon and Julien Nauroy
 
 Redistribution and use in source and binary forms, with or without modification, are permitted
 provided that the following conditions are met:

MANIFEST.in

@@ -1 +1 @@
-include itop-cli.cfg.example
+include python-itop-api.cfg.example

README.md

@@ -1,50 +1,72 @@
 # python-itop-api
-API python pour iTop via l'interface REST
+Python API to interface iTop to various other tools.
+Three command-line scripts are currently provided: itop-cli, vcenter2itop and itop2centreon
 
 ## itop-cli
-itop-cli is a CLI (command line interface) to iTop REST interface. We can use it to list the content
-of iTop classes with the command
+itop-cli is a generic CLI (command line interface) to the iTop REST interface.
+You can use it to list the contents of iTop classes with the command
 
     user@machine> itop-cli --classes server rack
 
 You can also search some specific instance with option --find
 
     user@machine> itop-cli --classes server --find host.domain.com
 
-You can have a look of more option with command --help
+You can have a look at the options with the --help command
 
     user@machine> itop-cli --help
 
-    usage: itop-cli [-h] [--hostname HOSTNAME] [--username USERNAME]
-                    [--password PASSWORD] [--config CONFIG_FILE]
-                    [--classes [ITOP-CLASS [ITOP-CLASS ...]]]
-                    [--find INSTANCE [INSTANCE ...]] [--delete INSTANCE INSTANCE]
-                    [--organization ORGANIZATION] [--import URI] [--format FORMAT]
-
-    python CLI for iTop REST api
-
-    optional arguments:
-      -h, --help            show this help message and exit
-
-    itop:
-      --hostname HOSTNAME   hostname of iTop server
-      --username USERNAME   username for iTop authentication
-      --password PASSWORD   password for iTop authentication
-
-    cli:
-      --config CONFIG_FILE  configuration file CLI must use (default = ./itop-
-                            cli.cfg)
-      --classes [ITOP-CLASS [ITOP-CLASS ...]]
-                            iTop classes to use
-      --find INSTANCE [INSTANCE ...]
-                            Find and display information about a given class
-                            instance givenits name or ID
-      --delete INSTANCE INSTANCE
-                            Delete an instance given its class name and instance
-                            ID
-      --organization ORGANIZATION
-                            iTop organization to use
-
-    import:
-      --import URI          URI of file to import
-      --format FORMAT       Format of file you want import
+	usage: itop-cli [-h] [--hostname HOSTNAME] [--username USERNAME]
+					[--password PASSWORD] [--organization ORGANIZATION-NAME]
+					[--virtualhost VIRTUAL-HOSTNAME] [--config CONFIG_FILE]
+					[--classes [ITOP-CLASS [ITOP-CLASS ...]]]
+					[--find INSTANCE [INSTANCE ...]] [--delete] [--import-uri URI]
+					[--import-stdin] [--format FORMAT] [--save]
+					[--prevent-duplicates]
+
+	python CLI for iTop REST api
+
+	optional arguments:
+	  -h, --help            show this help message and exit
+
+	itop:
+	  --hostname HOSTNAME   hostname of iTop server
+	  --username USERNAME   username for iTop authentication
+	  --password PASSWORD   password for iTop authentication
+	  --organization ORGANIZATION-NAME
+							iTop organization to use
+	  --virtualhost VIRTUAL-HOSTNAME
+							Itop's virtual host name for VMs
+
+	cli:
+	  --config CONFIG_FILE  configuration file CLI must use (default = ./itop-
+							cli.cfg)
+	  --classes [ITOP-CLASS [ITOP-CLASS ...]]
+							iTop classes to use
+	  --find INSTANCE [INSTANCE ...]
+							Find and display information about a given class
+							instance givenits name or ID
+	  --delete              Delete all instances previously loaded
+	  --save                Save the instances loaded through import
+	  --prevent-duplicates  Check if objects with the same name already exist
+							before savingand don't save in this case
+
+	import:
+	  --import-uri URI      URI of file to import
+	  --import-stdin        import data from STDIN
+	  --format FORMAT       Format of file you want import
+
+
+## vcenter2itop
+vcenter2itop focuses on extracting data from a VMWare VCenter cluster and importing it into iTop.
+It synchronises Farms, Servers, Hypervisors and VirtualMachines present in a VCenter as well as Brands, Models, OS Families and Versions.
+It has a dependency on the pyVmomi module.
+
+All parameters are set into the common python-itop-api.cfg script. vcenter2itop is then simply runs this way:
+
+    user@machine> vcenter2itop
+
+# itop2centreon
+itop2centreon is an attempt at synchronizing iTop with the Centreon monitoring system through its CLAPI (command-line API) interface.
+For now, it synchronizes the list of machines (Servers and VMs) and contacts.
+It can serve as a kickstart script for your own synchronization mechanism.

itop2centreon.py

@@ -0,0 +1,205 @@
+#!/usr/bin/env python
+# -*- coding: utf8 -*-fr
+# pylint: disable=invalid-name
+"""
+itop2centreon is a basic CLI interface to export itop data into centreon
+"""
+
+__version__ = '1.0'
+__authors__ = ['Julien Nauroy <julien.nauroy@u-psud.fr>']
+
+from itopapi import ItopapiController, ItopapiConfig, UnsupportedImportFormat
+from itopcli import load_configuration_cli, ItopcliConfig, NeedMoreArgs
+from itopapi.model import *
+import subprocess
+
+
+def csv_to_dict(csv):
+    lines = csv.splitlines()
+    headers = lines.pop(0).split(';')
+    dict = []
+    for line in lines:
+        dict_line = {}
+        for i, val in enumerate(line.split(';')):
+            dict_line[headers[i]] = val.decode('utf-8')
+        dict.append(dict_line)
+    return dict
+
+
+def run_clapi_list_command(object):
+    out, err = subprocess.Popen([ItopapiConfig.centreon_clapi_path,
+                          '-u', ItopapiConfig.centreon_username,
+                          '-p', ItopapiConfig.centreon_password,
+                          '-o', object,
+                          '-a', 'show'],
+                         stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()
+    return csv_to_dict(out)
+
+
+def run_clapi_action_command(obj, action, values):
+    out, err = subprocess.Popen([ItopapiConfig.centreon_clapi_path,
+                                 '-u', ItopapiConfig.centreon_username,
+                                 '-p', ItopapiConfig.centreon_password,
+                                 '-o', obj,
+                                 '-a', action,
+                                 '-v', ';'.join(str(x.encode('utf-8')) for x in values)],
+                                stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()
+    if out == "":
+        return True
+    else:
+        print "Error running action command:"
+        print out
+        exit(0)
+
+
+def main():
+    """
+    Main function
+    """
+
+    ######################################
+    # Load Itop & Centreon configuration #
+    ######################################
+    try:
+        load_configuration_cli()
+    except NeedMoreArgs as e:
+        print "Error: {}".format(e.message)
+        exit(1)
+
+
+    ####################
+    # Some value check #
+    ####################
+    if ItopapiConfig.username is None\
+            or ItopapiConfig.password is None:
+        print "Error: Itop Username/Password missing"
+        exit(1)
+    if ItopapiConfig.centreon_username is None\
+            or ItopapiConfig.centreon_password is None\
+            or ItopapiConfig.centreon_clapi_path is None:
+        print "Error: Centreon Username/Password/Path missing"
+        exit(1)
+
+    controller = ItopapiController()
+
+
+    #####################
+    # Synchronize Teams #
+    #####################
+    print "Synchronizing Itop teams / Centreon contact groups..."
+    centreon_contact_groups = run_clapi_list_command("CG")
+    itop_teams = ItopapiTeam.find_all()
+    for team in itop_teams:
+        group_exists = False
+        for contact_group in centreon_contact_groups:
+            if team.name == contact_group['name']: group_exists = True
+        if not group_exists:
+            print u"adding team {0} as a contact group".format(team.friendlyname.format('utf-8'))
+            run_clapi_action_command('CG', 'add', [team.name, team.name + ' (from Itop)'])
+
+    ###################################
+    # Cleanup Centreon Contact Groups #
+    ###################################
+    print "Cleaning up Centreon contact groups..."
+    all_contact_group_names = map(lambda s: s.name, itop_teams)
+    for contact_group in centreon_contact_groups:
+        if contact_group['name'] not in all_contact_group_names and contact_group['name'] != 'Supervisors':
+            print u"deleting contact group {0} as is is not defined in itop".format(contact_group['name'].format('utf-8'))
+            run_clapi_action_command('CG', 'DEL', [contact_group['name']])
+
+    #######################
+    # Synchronize Persons #
+    #######################
+    print "Synchronizing Itop persons / Centreon contacts..."
+    centreon_contacts = run_clapi_list_command("contact")
+    # Can't get persons from teams since their email is not listed in team.persons_list
+    itop_persons = ItopapiPerson.find_all()
+    for person in itop_persons:
+        # All persons should have an email
+        if person.email is None or '@' not in person.email:
+            continue
+
+        contact_alias = person.email.split('@')[0]
+        contact_exists = False
+        for contact in centreon_contacts:
+            if person.email == contact['email']: contact_exists = True
+        if not contact_exists:
+            print u"adding person {0} as a contact".format(person.friendlyname.format('utf-8'))
+            run_clapi_action_command('contact', 'add', [person.friendlyname, contact_alias, person.email, '', '0', '1', 'en_US', 'ldap'])
+        # In all cases, add the contact to the contacts list and set various parameters
+        for team in person.team_list:
+            run_clapi_action_command('CG', 'addcontact', [team.team_name, contact_alias])
+        run_clapi_action_command('contact', 'setParam', [contact_alias, 'enable_notifications', '1'])
+        run_clapi_action_command('contact', 'setParam', [contact_alias, 'hostnotifcmd', 'host-notify-by-email'])
+        run_clapi_action_command('contact', 'setParam', [contact_alias, 'hostnotifopt', 'd,u,r'])
+        run_clapi_action_command('contact', 'setParam', [contact_alias, 'svcnotifcmd', 'service-notify-by-email'])
+        run_clapi_action_command('contact', 'setParam', [contact_alias, 'servicenotifopt', 'w,u,c,r,f'])
+
+    #############################
+    # Cleanup Centreon Contacts #
+    #############################
+    print "Cleaning up Centreon contacts..."
+    all_contact_aliases = map(lambda s: '' if s.email is None else s.email.split('@')[0], itop_persons)
+    for contact in centreon_contacts:
+        if contact['alias'] not in all_contact_aliases and contact['alias'] != 'admin':
+            print u"deleting contact {0} as is is not defined in itop".format(contact['alias'].format('utf-8'))
+            run_clapi_action_command('contact', 'DEL', [contact['alias']])
+
+    def sync_servers(servers, centreon_hosts):
+        for server in servers:
+            if server.managementip is None or server.managementip == '':
+                continue
+            server_exists = False
+            for host in centreon_hosts:
+                if server.name == host['name']: server_exists = True
+            if server.status != 'production':
+                if server_exists:
+                    # Remove servers no longer in production
+                    print u"removing {0} as a host as its status is {1}".format(server.name.format('utf-8'), server.status)
+                    run_clapi_action_command('HOST', 'DEL', [server.name])
+                continue
+
+            if not server_exists:
+                print u"adding {0} as a host".format(server.name.format('utf-8'))
+                run_clapi_action_command('HOST', 'ADD', [server.name, server.description, server.managementip,
+                                                         'generic-host', 'central', ''])
+
+            # Set the server parameters
+            run_clapi_action_command('HOST', 'setParam', [server.name, 'check_period', '24x7'])
+            # Set the contacts
+            for contact in server.contacts_list:
+                if type(contact) is ItopapiTeam:
+                    run_clapi_action_command('HOST', 'addContactGroup', [server.name, contact.contact_name])
+                else:
+                    run_clapi_action_command('HOST', 'addContact', [server.name, contact.contact_id_friendlyname])
+
+    #######################
+    # Synchronize Servers #
+    #######################
+    print "Synchronizing Itop servers / Centreon hosts..."
+    centreon_hosts = run_clapi_list_command("HOST")
+    itop_servers = ItopapiServer.find_all()
+    sync_servers(itop_servers, centreon_hosts)
+
+    ###############################
+    # Synchronize VirtualMachines #
+    ###############################
+    print "Synchronizing Itop VMs / Centreon hosts..."
+    itop_vms = ItopapiVirtualMachine.find_all()
+    sync_servers(itop_vms, centreon_hosts)
+
+    ##########################
+    # Cleanup Centreon Hosts #
+    ##########################
+    print "Cleaning up Centreon hosts..."
+    all_servers_names = map(lambda s: s.name, itop_servers + itop_vms)
+    for host in centreon_hosts:
+        if host['name'] not in all_servers_names:
+            print u"deleting host {0} as is is not defined in itop".format(host['name'].format('utf-8'))
+            run_clapi_action_command('HOST', 'DEL', [host['name']])
+
+    return 0
+
+
+if __name__ == "__main__":
+    main()

itopapi/controller/ItopapiController.py

@@ -114,9 +114,9 @@ def load_one(self, itop_class, id_instance):
             if id_instance.isdigit():
                 instance = model.find(id_instance)
             else:
-                instance = model.find(model.find_by_name(id_instance))
+                instance = model.find_by_name(id_instance)
             if instance is not None:
-                self.data.extend(instance)
+                self.data.append(instance)
 
     def delete(self):
         """