Code source wiki de Outil d’importation d'utilisateurs
Version 1.1 par jhurst le 2020/07/21 11:35
Afficher les derniers auteurs
author | version | line-number | content |
---|---|---|---|
1 | {{ddtoc/}} | ||
2 | |||
3 | ---- | ||
4 | |||
5 | = **{{id name="__RefHeading___Toc1848_2652393712"/}}**Description = | ||
6 | |||
7 | **importtools **est un outil pour gérer les utilisateurs dans le LDAP DigDash. Il est notamment utile dans le cas de gestion d’une grosse base d’utilisateurs. | ||
8 | |||
9 | L'importtools peut être lancé directement via le fichier de commande « importtools.bat » fourni, avec les arguments par défaut (modifiables en éditant le fichier .bat) | ||
10 | |||
11 | ou | ||
12 | |||
13 | Il peut être exécuté via l’outil Java « importtools.jar » fourni dans le dossier <digdash_install>\add-ons\tools\lib avec les arguments par défaut ou personnalisables (voir partie suivante). | ||
14 | |||
15 | java -jar importtools.jar [-conf configfile] [-users userfile] [-out outputfile] | ||
16 | |||
17 | Il permet de régenter la base LDAP DigDash via les opérations suivantes : | ||
18 | |||
19 | = {{id name="__RefHeading___Toc474_3721803795"/}}Importation d’utilisateurs = | ||
20 | |||
21 | Elle consiste principalement à avoir deux fichiers en entrée : | ||
22 | |||
23 | * le fichier de configuration au format XML : le fichier d’exemple conf.xml est livré dans <digdash_install>\add-ons\tools\importtools ; il permet de faire la correspondance entre une colonne du fichier utilisateurs (voir suite) et un attribut d’un utilisateur LDAP dans le fichier de sortie (voir suite). | ||
24 | * le fichier utilisateurs au format Excel ou CSV : le fichier d’exemple users.xls est livré dans <digdash_install>\add-ons\tools\importtools ; Il s’agit de la base utilisateurs (une ligne par utilisateur) à importer dans LDAP. Ses colonnes correspondent aux attributs du fichier de configuration XML. | ||
25 | |||
26 | Et un fichier en sortie : | ||
27 | |||
28 | * le fichier de sortie au format XML : nommé « out.xml » par défaut, il est généré au lancement de l’outil « importtools » avec les deux fichiers mentionnés précédemment en entrée ; il est généré de manière à se mapper sur la structure LDAP. | ||
29 | |||
30 | = {{id name="__RefHeading___Toc476_3721803795"/}}Suppression d’utilisateurs = | ||
31 | |||
32 | Il est possible de supprimer tout ou partie selon critères des utilisateurs de la base LDAP DigDash. | ||
33 | |||
34 | = {{id name="__RefHeading___Toc478_3721803795"/}}Exportation d’utilisateurs = | ||
35 | |||
36 | Il est possible d’exporter les utilisateurs de la base LDAP. | ||
37 | |||
38 | **Options :** | ||
39 | |||
40 | |=Tag|=Description | ||
41 | |(% colspan="2" %)**Importation** | ||
42 | |**-conf** <config file>|Chemin du fichier de configuration XML. Par défaut, conf.xml. | ||
43 | |**-users** <excel file / csvfile>|Chemin du fichier en entrée des utilisateurs à importer. Il s’agit d’un fichier Excel ou d’un fichier CSV. Par défaut, users.xls. | ||
44 | |**-out** <outputfile>|Chemin du fichier de sortie XML faisant le mapping avec LDAP. Par défaut, out.xml. | ||
45 | |**-help**|Commande d’aide d’usage. | ||
46 | |**-debug**|Affiche les traces dans les cas erreurs. | ||
47 | |**-import**|Envoie le fichier de sortie (par défaut out.xml) au serveur pour l’importer dans LDAP. | ||
48 | |**-importonly**|Utilise un fichier de sortie existant (par défaut, out.xml) et l’envoie au serveur pour l’importer dans LDAP. | ||
49 | |**-server**|L’adresse du serveur DigDash. | ||
50 | |**-user**|L’utilisateur superviseur. | ||
51 | |**-pass**|Le mot de passe de l’utilisateur superviseur. | ||
52 | |(% colspan="2" %)**Suppression** | ||
53 | |**-removeall**|Supprime TOUS les utilisateurs présents dans LDAP ET la licence. | ||
54 | |**-removeall** **-attr** "ldap attribut name" **-regexp** "regexp"|Supprime toutes les entrées dans LDAP ET la licence lorsque l’attribut spécifié de l’entrée LDAP correspond à l’expression régulière mentionnée. | ||
55 | |**-removeall** **-attr** "license_type" **-regexp** "extranet"|Cas spécial : supprime l’utilisateur dans LDAP ET le licence si le type de la licence de l’utilisateur est « extranet ». | ||
56 | |(% colspan="2" %)**Exportation** | ||
57 | |**-export**|Exporte tous les utilisateurs dans un fichier CSV. Par défaut, le fichier d’export se nomme users_export.csv. | ||
58 | |**-exportfile** "file.csv"|Exporte tous les utilisateurs dans le fichier CSV mentionné par son chemin absolu (précédé de **-export**). | ||
59 | |(% colspan="2" %)**Logs** | ||
60 | |**-log** "C:\temp"|Le fichier log sera créé dans le répertoire spécifié, nommé de la manière suivante : importtool-yyyy-mm-dd_hh-mm-ss.log. | ||
61 | |**-log** "C:\log.txt"|Le fichier log sera créé dans le répertoire et sous le nom spécifiés. | ||
62 | |(% colspan="2" %)**Autres** | ||
63 | |**-loginForm**|Force l’authentification LDAP dans le cas SSO. | ||
64 | |||
65 | (% id="HIV.Exemples" %) | ||
66 | = {{id name="__RefHeading___Toc1856_2652393712"/}}Exemples = | ||
67 | |||
68 | * **java -jar importtools.jar** | ||
69 | * **java -jar importtools.jar -conf conf.xml -users users.xls -out out.xml** | ||
70 | * **java -jar importtools.jar -conf conf.xml -users users.xls -out out.xml -import -server http:~/~/localhost:8080 -domain ddenterpriseapi -user admin -pass admin** | ||
71 | * **java -jar importtools.jar -export -server http:~/~/localhost:8080 -domain ddenterpriseapi -user admin -pass admin** | ||
72 | * **java -jar importtools.jar -export -exportfile "D:\my_users_export.csv" -server http:~/~/localhost:8080 -domain ddenterpriseapi -loginForm -user admin -pass admin** | ||
73 | * **java -jar importtools.jar -removeall -server http:~/~/localhost:8080 -domain ddenterpriseapi -user admin -pass admin** | ||
74 | * **java -jar importtools.jar -removeall -attr "license_type" -regexp "extranet" -server http:~/~/localhost:8080 -domain ddenterpriseapi -user admin -pass admin** | ||
75 | * **java -jar importtools.jar -removeall -attr "uid" -regexp "toto1[0-9]*" -server http:~/~/localhost:8080 -domain ddenterpriseapi -user admin -pass admin** | ||
76 | |||
77 |