From 48e6a024b2becfb452d83ab2520f866c36fe4a66 Mon Sep 17 00:00:00 2001 From: Michael Overkamp Date: Wed, 24 Jan 2024 11:00:34 +0100 Subject: [PATCH] JDisc-fix-tables and archive objects --- .../de/daten-konsolidieren/jdisc-discovery.md | 120 ++++++++-------- docs/en/consolidate-data/jdisc-discovery.md | 132 +++++++++--------- 2 files changed, 124 insertions(+), 128 deletions(-) diff --git a/docs/de/daten-konsolidieren/jdisc-discovery.md b/docs/de/daten-konsolidieren/jdisc-discovery.md index 2316d726..ea77862e 100644 --- a/docs/de/daten-konsolidieren/jdisc-discovery.md +++ b/docs/de/daten-konsolidieren/jdisc-discovery.md @@ -35,37 +35,33 @@ Die Konfiguration der Schnittstelle befindet sich unter **Verwaltung → Import [![JDisc Konfiguration](../assets/images/de/daten-konsolidieren/jdisc/1-jdisc.png)](../assets/images/de/daten-konsolidieren/jdisc/1-jdisc.png) +!!! info "Archivieren von alten Objekten" + Um Objekte zu archivieren, die von JDisc für eine bestimmte Anzahl von Tagen nicht gesehen wurden, wird der Schwellenwert und die Schwellenwerteinheit in der Verwaltung eingestellt. **Verwaltung → [Mandanten-Name] Verwaltung → Einstellungen für [Mandanten-Name] → JDisc**. + ### Allgemeine Einstellungen -| Parameter | Anmerkung | -| --- | --- | -| **Standard Server** | Handelt es sich um diejenige Instanz, die bei einem manuellen Import vorgeschlagen werden soll? | -| **Host** | Hostname/FQDN oder IP-Adresse der JDisc-Instanz; diese muss von der i-doit-Instanz aus erreichbar sein | -| **Port** | Offener Port der PostgreSQL-Instanz, die im Hintergrund von JDisc Discovery läuft | -| **Datenbank** | JDisc Discovery verwendet standardmäßig die Datenbank **inventory**. | -| **Benutzername** | Hier wird einer der Accounts angegeben, die beim Setup abgefragt wurden. Es genügt der Account **postgresro** mit eingeschränkten Rechten, da i-doit lediglich lesend auf die Datenbank zugreift. | -| **Passwort** | Das beim Setup vergebene Passwort, das zum verwendeten Account gehört | -| **Import älterer JDisc Versionen erlauben?** | Abfrage, die nur für ältere Versionen von JDisc Discovery relevant ist | +| Parameter | Anmerkung | +| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Standard Server** | Handelt es sich um diejenige Instanz, die bei einem manuellen Import vorgeschlagen werden soll? | +| **Host** | Hostname/FQDN oder IP-Adresse der JDisc-Instanz; diese muss von der i-doit-Instanz aus erreichbar sein | +| **Port** | Offener Port der PostgreSQL-Instanz, die im Hintergrund von JDisc Discovery läuft | +| **Datenbank** | JDisc Discovery verwendet standardmäßig die Datenbank **inventory**. | +| **Benutzername** | Hier wird einer der Accounts angegeben, die beim Setup abgefragt wurden. Es genügt der Account **postgresro** mit eingeschränkten Rechten, da i-doit lediglich lesend auf die Datenbank zugreift. | +| **Passwort** | Das beim Setup vergebene Passwort, das zum verwendeten Account gehört | +| **Import älterer JDisc Versionen erlauben?** | Abfrage, die nur für ältere Versionen von JDisc Discovery relevant ist | Nach dem Speichern der Parameter kann die Verbindung zur JDisc-Datenbank über den Button **Verbindung prüfen** getestet werden. -Um Objekte zu archivieren, die von JDisc seit einer bestimmten Anzahl von z.B. X Tagen nicht mehr gesehen wurden, muss unter **Verwaltung → [Mandanten-Name] Verwaltung → Einstellungen für [Mandanten-Name] → JDisc** der Schwellwert und die Schwellwert Einheit gesetzt werden. - -| Parameter | Anmerkung | -| --- | --- | -| **Schwellwert** | Eine Zahl. Wenn die Einstellung definiert ist, werden die Objekte, die JDisc innerhalb dieses Zeitraums nicht gesehen hat, beim Import archiviert. | -| **Schwellwert Einheit** | Tage, Wochen oder Monate | - ### Discovery Einstellungen Über i-doit kann der Benutzer einen Scan bei der konfigurierten JDisc-Instanz auslösen. Dazu wird der [WebService](#installation) von JDisc Discovery verwendet, der installiert und aktiviert sein muss. -| Parameter | Anmerkung | -| --- | --- | +| Parameter | Anmerkung | +| ---------------- | ---------------------------------------------------- | | **Benutzername** | Account, der für den Web Service genutzt werden soll | -| **Passwort** | Zum Account passendes Passwort | -| **Port** | Standard: **9000** | -| **Protokoll** | Standard: **http** | +| **Passwort** | Zum Account passendes Passwort | +| **Port** | Standard: **9000** | +| **Protokoll** | Standard: **http** | Auch hier kann nach dem Speichern der Parameter über den Button **Verbindung prüfen** getestet werden, ob die Konfiguration erfolgreich ist. @@ -82,49 +78,49 @@ In der Standard-Installation von i-doit sind bereits vordefinierte Profile vorha ### Allgemeine Einstellungen -| Option | Beschreibung | -| --- | --- | +| Option | Beschreibung | +| ---------------- | ------------------------------------------------------------------------------------------------------------- | | **JDisc Server** | Welche Instanz von JDisc soll beim Import vor-selektiert werden? Siehe Abschnitt "Konfiguration" weiter oben. | -| **Titel** | Name des Profils | -| **Beschreibung** | Beschreibung des Profils | +| **Titel** | Name des Profils | +| **Beschreibung** | Beschreibung des Profils | ### Objekttyp Zuweisungen Für jeden Typ in JDisc kann ein äquivalenter Objekttyp in i-doit ausgewählt werden. Geschieht dies nicht, werden Devices diesen Typs nicht importiert. Die Reihenfolge der Zuweisungen wird beim Import beachtet. Dieser geht die Liste von oben nach unten durch, um eine Zuweisung zu identifizieren. Die Matrix ist pro Zeile folgendermaßen aufgebaut: -| JDisc-Typ | JDisc-Betriebssystem | Objektnamen modifizieren | FQDN Zusatz | Port Filter | Objekttyp | Standort | Aktionen | -| --- | --- | --- | --- | --- | --- | --- | --- | +| JDisc-Typ | JDisc-Betriebssystem | Objektnamen modifizieren | FQDN Zusatz | Port Filter | Objekttyp | Standort | Aktionen | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | Device Type aus JDisc, der beim Import berücksichtigt werden soll.

Die Liste wird aus der angegebenen JDisc-Instanz ausgelesen und zwischengespeichert. | Betriebssysteme, die JDisc bereits inventarisiert hat.

Oftmals reicht der Device Type für eine Zuweisung zu einem Objekttyp nicht aus, weswegen optional das Betriebssystem angegeben werden kann.

Das Feld kann mit Wildcards (*) versehen werden. | Wandelt den Objekttitel um.

**Unverändert**: Der Objektname wird nicht verändert

**Großbuchstaben**: Der komplette Objektname wird in Großbuchstaben geändert.

**Kleinbuchstaben**: Der komplette Objektname wird in Kleinbuchstaben geändert. | Hängt an den Objekttitel einen FQDN Zusatz an. | Welche Netzwerk-Ports sollen importiert werden?

**Normaler Import**: Alle physikalischen und logischen Ports werden importiert.

**Kein Import**: Im Textfeld können Port-Namen angegeben werden, die ignoriert werden sollen.
Das Feld kann mit Wildcards (*) genutzt werden. (Beispiel: Port-Name: Loopback → Ports mit dem Namen Loopback werden nicht importiert)

**Logischer Port**/**Physikalischer Port**/**FC-Port**: Es werden nur die Ports importiert, deren Name im Textfeld zu finden ist.

Die Kriterien können miteinander kombiniert werden, sodass nur bestimmte physikalische und nur bestimmte logische Ports berücksichtigt werden. | Diesem Objekttyp werden importierte Devices zugeordnet.

Wird kein Objekttyp ausgewählt, werden Devices diesen Types ignoriert. | Beim Import werden Objekte, die den hier genannten Kriterien entsprechen, einem bestimmten Standort zugeordnet. Dies geschieht über die Kategorie **Standort**. | Neue Zuweisung hinzufügen, eine bestehende duplizieren oder löschen. | ### Zusätzliche Optionen -| Option | Beschreibung | -| --- | --- | -| **Kategorien auswählen** | Welche [Kategorien](../grundlagen/struktur-it-dokumentation.md) sollen beim Import befüllt werden? Es werden nur Kategorien gelistet, die der Import behandeln kann. | -| **Netzwerk Interfaces importieren als** | Inventarisierte Netzwerk-Schnittstellen können in unterschiedlichen Kategorien abgebildet werden. | -| **Software beim Import berücksichtigen** | Soll inventarisierte Software als Objekttyp **Anwendungen** importiert werden? | -| **Softwarelizenzen beim Import berücksichtigen** | Sollen inventarisierte Softwarelizenzen als Objekttyp **Lizenzen** importiert werden? | -| **Systemdienste importieren** | Sollen inventarisierte Systemdienste als Objekttyp **Systemdienst** importiert werden? | -| **Cloud Subscriptionen importieren** | Sollen Daten aus der JDisc Kategorie Cloud importiert werden?
Wird in die Kategorie **Zugewiesene Abonnente** importiert. Die Rückwärtige Kategorie **Zugewiesene Benutzer** ist bei Objekten vom Typ Lizenzen zu finden. | -| **Verbindungs Endpunkte importieren** | Die Verbindungen werden nicht in die Verkabelung Kategorie, sondern in die Kategorie "Verbindungs Endpunkte" importiert. Das ermöglicht zwischen der manuellen Verkabelung und der automatischen Verkabelung durch JDisc zu unterscheiden. | -| **Einfache Datenbank Modellierung verwenden?** | Soll die neue oder die alte [Datenbanklogik](../anwendungsfaelle/dokumentation-von-datenbanken.md) verwendet werden? | -| **Layer-3-Netze beim Import berücksichtigen** | Sollen inventarisierte IP-Netze als Objekttyp **Layer-3-Netze** importiert werden? | -| **IP Adressentypen beibehalten** | Sollen **IPv4 Adressen**, **IPv6 Adressen**, **Loopback Adressen**, **Virtuelle Adressen** importiert werden? | -| **Importtyp für DHCP IP Adressen** | Sollen per DHCP zugewiesen Adressen überschrieben werden? | -| **VLans beim Import berücksichtigen** | Sollen inventarisierte VLANs als Objekttyp **Layer-2-Netze** importiert werden? | -| **Cluster beim Import berücksichtigen** | Sollen (Virtualisierungs-)Umgebungen als Objekttyp **Cluster** importiert werden? | -| **Blade/Chassis Verbindungen beim Import berücksichtigen** | Sollen Objekte vom Typ **Blade Server** zu Objekten vom Typ **Blade Chassis** beim Import hinzugefügt werden? | -| **Objekttyp der zugewiesenen Module innerhalb eines Blade/Chassis Gerätes** | Ist ein Blade oder Switch Chassis inventarisiert worden, können die eingesteckten Module einem bestimmten Objekttyp beim Import zugeordnet werden. | -| **Objekttyp der zugewiesenen Module aktualisieren** | Sollen die Objekttypen der zugewiesenen Module eines Blade/Chassis Gerätes aktualisiert werden? | -| **Custom attributes importieren** | Wenn in JDisc Discovery benutzerdefinierte Attribute (**Custom Attributes**) gepflegt werden, können diese in i-doit importiert werden. Diese werden nach dem Import in der Kategorie **JDisc Custom Attributes** angezeigt. | -| **Standard Templates aus Objekttypen berücksichtigen (nur bei Neuanlage)** | Wird ein neues Objekt erstellt, kann automatisch ein [Template](../effizientes-dokumentieren/templates.md) berücksichtigt werden. Die Auswahl des Templates findet in der Objekttyp-Konfiguration statt. | -| **CMDB-Status der Objekte ändern auf** | Bereits vorhandene Objekte können beim Aktualisieren einen bestimmten **[CMDB-Status](../grundlagen/lebens-und-dokumentationszyklus.md)** erhalten. Soll der **CMDB-Status** nicht geändert werden, ist in der Auswahl **CMDB-Status beibehalten** zu wählen. | -| **Software Filter** | Entweder kann eine White- oder eine Blacklist an Software-Applikationen angegeben werden, welche importiert werden sollen (Whitelist) oder eben nicht (Blacklist). Es können Wildcards (\*) angegeben werden. Die Liste von Titeln wird durch Kommas separiert. | -| **Filter als regexp gebrauchen** | Den Software Filter mit Strings oder mit Regulären Ausdrücken verwenden? Da das regex direkt an die JDisc Datenbank weitergeleitet wird, sollten die passenden regex parameter verwendet werden.
Diese sind z.B. unter [h](https://www.postgresql.org/docs/9.3/functions-matching.html)[ttps://www.postgresql.org/docs/9.3/functions-matching.html](https://www.postgresql.org/docs/9.3/functions-matching.html) zu finden.

Hinweis eines Anwenders:

\s kann nicht verwendet werden. Hier wird mit Leerzeichen gearbeitet.
\d kann nicht verwendet werden. Hier muss mit [a-zA-Z] gearbeitet werden. | -| **Benutze OS-Familie (falls verfügbar) anstatt OS-Version als Objekttitel** | Für den Softwareimport anstatt der Softwareversion die Softwarefamilie als Objekttitel verwenden. Z.B. anstatt "Windows Server 2008 Standard" nur "Windows" mit "Server 2008 Standard" als Variante. | -| **Objekt-Matching Profil** | [Welche Strategie soll erfolgen](objekt-identifizieren-bei-importen.md), um bereits in i-doit dokumentierte Objekte durch einen Import zu aktualisieren?
Siehe auch [custom identifier](#custom-identifier)| -| **Objekttyp aktualisieren** | Ist das Device bereits als Objekt in i-doit vorhanden, kann hierüber bestimmt werden, ob der Objekttyp anhand der Zuweisung (siehe oben) aktualisiert werden soll oder nicht. | -| **Objekt-Titel aktualisieren** | Soll der Objekttitel durch den Import aktualisiert werden? | +| Option | Beschreibung | +| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| **Kategorien auswählen** | Welche [Kategorien](../grundlagen/struktur-it-dokumentation.md) sollen beim Import befüllt werden? Es werden nur Kategorien gelistet, die der Import behandeln kann. | +| **Netzwerk Interfaces importieren als** | Inventarisierte Netzwerk-Schnittstellen können in unterschiedlichen Kategorien abgebildet werden. | +| **Software beim Import berücksichtigen** | Soll inventarisierte Software als Objekttyp **Anwendungen** importiert werden? | +| **Softwarelizenzen beim Import berücksichtigen** | Sollen inventarisierte Softwarelizenzen als Objekttyp **Lizenzen** importiert werden? | +| **Systemdienste importieren** | Sollen inventarisierte Systemdienste als Objekttyp **Systemdienst** importiert werden? | +| **Cloud Subscriptionen importieren** | Sollen Daten aus der JDisc Kategorie Cloud importiert werden?
Wird in die Kategorie **Zugewiesene Abonnente** importiert. Die Rückwärtige Kategorie **Zugewiesene Benutzer** ist bei Objekten vom Typ Lizenzen zu finden. | +| **Verbindungs Endpunkte importieren** | Die Verbindungen werden nicht in die Verkabelung Kategorie, sondern in die Kategorie "Verbindungs Endpunkte" importiert. Das ermöglicht zwischen der manuellen Verkabelung und der automatischen Verkabelung durch JDisc zu unterscheiden. | +| **Einfache Datenbank Modellierung verwenden?** | Soll die neue oder die alte [Datenbanklogik](../anwendungsfaelle/dokumentation-von-datenbanken.md) verwendet werden? | +| **Layer-3-Netze beim Import berücksichtigen** | Sollen inventarisierte IP-Netze als Objekttyp **Layer-3-Netze** importiert werden? | +| **IP Adressentypen beibehalten** | Sollen **IPv4 Adressen**, **IPv6 Adressen**, **Loopback Adressen**, **Virtuelle Adressen** importiert werden? | +| **Importtyp für DHCP IP Adressen** | Sollen per DHCP zugewiesen Adressen überschrieben werden? | +| **VLans beim Import berücksichtigen** | Sollen inventarisierte VLANs als Objekttyp **Layer-2-Netze** importiert werden? | +| **Cluster beim Import berücksichtigen** | Sollen (Virtualisierungs-)Umgebungen als Objekttyp **Cluster** importiert werden? | +| **Blade/Chassis Verbindungen beim Import berücksichtigen** | Sollen Objekte vom Typ **Blade Server** zu Objekten vom Typ **Blade Chassis** beim Import hinzugefügt werden? | +| **Objekttyp der zugewiesenen Module innerhalb eines Blade/Chassis Gerätes** | Ist ein Blade oder Switch Chassis inventarisiert worden, können die eingesteckten Module einem bestimmten Objekttyp beim Import zugeordnet werden. | +| **Objekttyp der zugewiesenen Module aktualisieren** | Sollen die Objekttypen der zugewiesenen Module eines Blade/Chassis Gerätes aktualisiert werden? | +| **Custom attributes importieren** | Wenn in JDisc Discovery benutzerdefinierte Attribute (**Custom Attributes**) gepflegt werden, können diese in i-doit importiert werden. Diese werden nach dem Import in der Kategorie **JDisc Custom Attributes** angezeigt. | +| **Standard Templates aus Objekttypen berücksichtigen (nur bei Neuanlage)** | Wird ein neues Objekt erstellt, kann automatisch ein [Template](../effizientes-dokumentieren/templates.md) berücksichtigt werden. Die Auswahl des Templates findet in der Objekttyp-Konfiguration statt. | +| **CMDB-Status der Objekte ändern auf** | Bereits vorhandene Objekte können beim Aktualisieren einen bestimmten **[CMDB-Status](../grundlagen/lebens-und-dokumentationszyklus.md)** erhalten. Soll der **CMDB-Status** nicht geändert werden, ist in der Auswahl **CMDB-Status beibehalten** zu wählen. | +| **Software Filter** | Entweder kann eine White- oder eine Blacklist an Software-Applikationen angegeben werden, welche importiert werden sollen (Whitelist) oder eben nicht (Blacklist). Es können Wildcards (\*) angegeben werden. Die Liste von Titeln wird durch Kommas separiert. | +| **Filter als regexp gebrauchen** | Den Software Filter mit Strings oder mit Regulären Ausdrücken verwenden? Da das regex direkt an die JDisc Datenbank weitergeleitet wird, sollten die passenden regex parameter verwendet werden.
Diese sind z.B. unter [h](https://www.postgresql.org/docs/9.3/functions-matching.html)[ttps://www.postgresql.org/docs/9.3/functions-matching.html](https://www.postgresql.org/docs/9.3/functions-matching.html) zu finden.

Hinweis eines Anwenders:

\s kann nicht verwendet werden. Hier wird mit Leerzeichen gearbeitet.
\d kann nicht verwendet werden. Hier muss mit [a-zA-Z] gearbeitet werden. | +| **Benutze OS-Familie (falls verfügbar) anstatt OS-Version als Objekttitel** | Für den Softwareimport anstatt der Softwareversion die Softwarefamilie als Objekttitel verwenden. Z.B. anstatt "Windows Server 2008 Standard" nur "Windows" mit "Server 2008 Standard" als Variante. | +| **Objekt-Matching Profil** | [Welche Strategie soll erfolgen](objekt-identifizieren-bei-importen.md), um bereits in i-doit dokumentierte Objekte durch einen Import zu aktualisieren?
Siehe auch [custom identifier](#custom-identifier) | +| **Objekttyp aktualisieren** | Ist das Device bereits als Objekt in i-doit vorhanden, kann hierüber bestimmt werden, ob der Objekttyp anhand der Zuweisung (siehe oben) aktualisiert werden soll oder nicht. | +| **Objekt-Titel aktualisieren** | Soll der Objekttitel durch den Import aktualisiert werden? | Kategorien die für JDisc erstellt wurden sind: @@ -154,14 +150,14 @@ Der Import von Inhalten aus JDisc erfolgt über **Extras → CMDB → Import → Vor dem Ausführen des Imports müssen die Import-Parameter festlegt sein.
Da es möglich ist, dass mehr als ein JDisc-Server eingesetzt wird, muss im ersten Schritt der JDisc-Server ausgewählt werden. Das Profil, welches zuvor definiert wurde, kann ebenfalls gewählt werden um die importierten Inhalte und deren Handhabung zu beeinflussen. Zusätzlich kann der Modus des Imports angegeben werden. Der Import-Modus **Erstellen** wird alle gefundenen Objekte erstellen, ohne zu prüfen, ob diese bereits existieren. Der Import-Modus **Aktualisieren** wird nur Objekte erstellen, die im i-doit-Datenbestand nicht gefunden werden. Kategorien von bereits existierenden Objekten werden (wenn nötig) um neue Daten ergänzt. Der Import-Modus **Überschreiben** verhält sich im Prinzip wie der Modus **Aktualisieren** mit dem Unterschied, dass Listen-Kategorien erst geleert und dann neu angelegt werden. -| **Import Modus** | **Beschreibung** | -| --- | --- | -| **Erstellen** | Der Import-Modus **"Erstellen"** wird alle gefundenen Objekte erstellen, ohne zu prüfen, ob diese bereits existieren. | -| **Aktualisieren** | Der Import-Modus **"Aktualisieren"** wird nur Objekte erstellen, die in i-doit nicht gefunden werden konnten. Kategorien von bereits existierenden Objekten werden (wenn nötig) um neue Daten ergänzt. | -| **Aktualisieren (Neu inventarisiert)** | Mit dem Zusatz **"(Neu inventarisiert)"** wird die `Custom identifier` Kategorie gelöscht und feste i-doit-zu-jdisc-device Verknüpfungen verworfen und die Objektzugehörigkeiten neu errechnet. | -| **Erstelle nur neu gescannte Geräte** | Der Modus "**Erstelle nur neu gescannte Geräte**" erstellt nur Objekte die nicht in i-doit existieren. | -| **Überschreiben** | Der Import-Modus **"Überschreiben"** verhält sich genauso wie der Modus "Aktualisieren" mit dem Unterschied, das Listen-Kategorien erst geleert und dann neu angelegt werden. | -| **Überschreiben (Neu inventarisiert)** | Mit dem Zusatz **"(Neu inventarisiert)"** wird die `Custom identifier` Kategorie gelöscht und feste i-doit-zu-jdisc-device Verknüpfungen verworfen und die Objektzugehörigkeiten neu errechnet. | +| **Import Modus** | **Beschreibung** | +| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| **Erstellen** | Der Import-Modus **"Erstellen"** wird alle gefundenen Objekte erstellen, ohne zu prüfen, ob diese bereits existieren. | +| **Aktualisieren** | Der Import-Modus **"Aktualisieren"** wird nur Objekte erstellen, die in i-doit nicht gefunden werden konnten. Kategorien von bereits existierenden Objekten werden (wenn nötig) um neue Daten ergänzt. | +| **Aktualisieren (Neu inventarisiert)** | Mit dem Zusatz **"(Neu inventarisiert)"** wird die `Custom identifier` Kategorie gelöscht und feste i-doit-zu-jdisc-device Verknüpfungen verworfen und die Objektzugehörigkeiten neu errechnet. | +| **Erstelle nur neu gescannte Geräte** | Der Modus "**Erstelle nur neu gescannte Geräte**" erstellt nur Objekte die nicht in i-doit existieren. | +| **Überschreiben** | Der Import-Modus **"Überschreiben"** verhält sich genauso wie der Modus "Aktualisieren" mit dem Unterschied, das Listen-Kategorien erst geleert und dann neu angelegt werden. | +| **Überschreiben (Neu inventarisiert)** | Mit dem Zusatz **"(Neu inventarisiert)"** wird die `Custom identifier` Kategorie gelöscht und feste i-doit-zu-jdisc-device Verknüpfungen verworfen und die Objektzugehörigkeiten neu errechnet. | In der Protokollierung kann der Umfang der geschriebenen Logs beeinflusst werden. Ein umfangreicheres Logging erhöht die Dauer des Imports.
Wenn die Einstellungen vollständig vorgenommen wurden, kann der Import über **Importvorgang starten** angestoßen werden. Bitte beachte, dass die Dauer des Imports sowohl von der Größe der JDisc-Datenbank, als auch von der verwendeten Hardware abhängig ist.
diff --git a/docs/en/consolidate-data/jdisc-discovery.md b/docs/en/consolidate-data/jdisc-discovery.md index ec4dfa3e..9621165f 100644 --- a/docs/en/consolidate-data/jdisc-discovery.md +++ b/docs/en/consolidate-data/jdisc-discovery.md @@ -33,37 +33,40 @@ The configuration of the interface is under **Administration → Import and inte [![jdisc-discovery-interface](../assets/images/en/consolidate-data/jdisc-discovery/1-jd.png)](../assets/images/en/consolidate-data/jdisc-discovery/1-jd.png) +!!! info "Archive outdated objects" + To archive objects that have not been seen by JDisc for a certain number of days, the threshold value and the threshold value unit must be set at **Administration → [Tenant name] management → Settings for [Tenant name] → JDisc**. + ### Common Settings -| Parameter | Comment | -| --- | --- | -| **Default Server** | Is the instance involved which is to be suggested with a manual import? | -| **Host** | Host name / FQDN or IP address of the JDisc instance; this has to be accessible from the i-doit instance. | -| **Port** | Open port of the PostgreSQL instance which runs in the background of JDisc Discovery. | -| **Database** | JDisc Discovery uses the **inventory** database as a standard. | -| **Username** | Enter one of the accounts which were requested during setup. You can use the account **postgresro** with limited rights, because i-doit only needs reading access for the database. | -| **Password** | The password assigned during setup which belongs to the used account. | -| **Allow import of older JDisc version?** | This query is only relevant for older versions of JDisc Discovery. | +| Parameter | Comment | +| ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Default Server** | Is the instance involved which is to be suggested with a manual import? | +| **Host** | Host name / FQDN or IP address of the JDisc instance; this has to be accessible from the i-doit instance. | +| **Port** | Open port of the PostgreSQL instance which runs in the background of JDisc Discovery. | +| **Database** | JDisc Discovery uses the **inventory** database as a standard. | +| **Username** | Enter one of the accounts which were requested during setup. You can use the account **postgresro** with limited rights, because i-doit only needs reading access for the database. | +| **Password** | The password assigned during setup which belongs to the used account. | +| **Allow import of older JDisc version?** | This query is only relevant for older versions of JDisc Discovery. | After the parameters are saved, you can test the connection to the JDisc database with the **Check connection** button. To archive objects that have not been seen by JDisc for a certain number of e.g. X days, the threshold value and the threshold value unit must be set under **Administration → [Tenant name] management → Settings for [Tenant name] → JDisc**. -| Parameter | Anmerkung | -| --- | --- | -| **Threshold** | Eine Zahl einfügen. When the setting is defined, the objects have not been seen by JDisc within this time period will be archived on import. | -| **Threshold unit** | Days, Weeks oder Month | +| Parameter | Anmerkung | +| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | +| **Threshold** | Eine Zahl einfügen. When the setting is defined, the objects have not been seen by JDisc within this time period will be archived on import. | +| **Threshold unit** | Days, Weeks oder Month | ### Discovery Settings The user can activate a scan with the configured JDisc instance with i-doit. For this purpose, the JDisc Discovery web service is used, provided it is installed and activated. -| Parameter | Comment | -| --- | --- | +| Parameter | Comment | +| ------------ | ------------------------------------------- | | **Username** | The account to be used for the web service. | -| **Password** | Password for the account | -| **Port** | Default: **9000** | -| **Protocol** | Default: **http** | +| **Password** | Password for the account | +| **Port** | Default: **9000** | +| **Protocol** | Default: **http** | After saving the parameters, you can test whether the configuration was successful with the **Check connection** button. @@ -80,49 +83,49 @@ The i-doit default installation already provides predefined profiles. Among thes ### General Configuration -| Option | Description | -| --- | --- | +| Option | Description | +| ---------------- | --------------------------------------------------------------------------------------------------------- | | **JDisc Server** | Which JDisc instance do you want to preselect during import? See also "Configuration" as explained above. | -| **Title** | Name of the profile | -| **Description** | Description of the profile | +| **Title** | Name of the profile | +| **Description** | Description of the profile | ### Object-type Assignment For each type in JDisc you can select an equivalent object type in i-doit. If none is selected, devices of this type will not be imported. The order of allocations is observed during import. In order to identify an allocation, the list is processed from top to bottom. For each line the matrix has the following structure: -| JDisc type | JDisc operating system | Objekt title transform | FQDN Addition | Port filter | Object-type | Location | Actions | -| --- | --- | --- | --- | --- | --- | --- | --- | +| JDisc type | JDisc operating system | Objekt title transform | FQDN Addition | Port filter | Object-type | Location | Actions | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | Device type from JDisc which is to be considered during import

The list is read out from the specified JDisc instance and kept in the buffer. | Operating systems which already have been inventoried by JDisc.

Often the device type isn't sufficient for an assignment to an object type, therefore you can enter the operating system as an option.

You can enter wildcards (\*) in this field. | Converts the object title.

**"As is" Unchanged**: The object name is not changed

**"Uppercase" letters**: The complete object name is changed to upper case.

**"Lowercase" letters**: The entire object name is changed to lower case. | Appends an FQDN addition to the object title. | Which network ports do you want to import?

**Normal import**: All physical and logical ports are imported.

**No import**: In the text field you can enter port names which shall be ignored.
The field can be used with wildcards (\*). (Example: Port name: Loopback → Ports with the name Loopback are not imported)

**Logical port**/ **Physical port**/ **FC-port**: Only ports which are named in the text field are imported.

You can combine the criteria so that only certain physical and certain logical ports are considered. | Imported devices are assigned to this object type.

If you don't select an object type, devices of this type will be ignored. | Objects which meet the criteria mentioned here are allocated to a certain location during import. This is carried out with the **Location** category. | Add a new assignment, duplicate an existing assignment or delete an assignment. | ### Additional Options -| Option | Description | -| --- | --- | -| **Select categories** | Which [categories](../basics/structure-of-the-it-documentation.md) do you want to fill during import? Only supported categories are listed. | -| **Import network interfaces as** | You can map inventoried network interfaces in different categories. | -| **Include software** | Do you want to import inventoried software as object type **Applications**? | -| **Include software licences** | Do you want to import inventoried licenses as object type **Licenses**? | -| **Import system services** | Do you want to import inventoried Services as object type **System Services**? | -| **Import cloud subscriptions** | Do you want to import inventoried Cloud data?
Data is imported to the category **Assigned subscriptions**. The backward category **Subscriptions** is is assigned to License objects. | -| **Import connection endpoints** | The connections are not imported into the cabling category, but into the category "Connection endpoint". This allows to distinguish between manual cabling and automatic cabling by JDisc. | -| **Use simple database modelling?** | Should the new or the old database logic be used? | -| **Include layer 3 nets** | Do you want to import inventoried IP nets as object type **Layer 3 nets**? | -| **Keep IP address types** | Should IPv4 addresses, IPv6 addresses, loopback addresses, virtual addresses be imported? | -| **Import type for DHCP IP addresses** | Should addresses assigned via DHCP be overwritten? | -| **Include VLans** | Do you want to import inventoried VLans as object type **Layer 2 nets**? | -| **Include clusters** | Do you want to import (virtualization) environments as object type **Cluster**? | -| **Include Blade/Chassis connections during import
** | Do you want to include objects of the type **Blade Server** to objects of the type **Blade Chassis** during import? | -| **Object type of the assigned modules within a blade/chassis unit** | When a blade chassis or switch chassis was inventoried, you can allocate the modules to a certain object type during import. | -| **Update the object type of the assigned modules** | Should the object types of the assigned modules of a blade/chassis device be updated? | -| **Import custom attributes** | When you maintain customized attributes (**Custom Attributes**) in JDisc Discovery, you can import these in i-doit. After import, they are displayed in the **JDisc Custom Attributes** category. | -| **Consider default templates from object types (only for newly created objects)** | When a new object is created, it is possible to consider [templates](../efficient-documentation/templates.md) automatically. The template selection is carried out in the object type configuration. | -| **Change CMDB-status of objects to** | Already existing objects can receive a certain [CMDB status](../basics/life-and-documentation-cycle.md) during updating. If you don't want to change the CMDB-Status, select the option **Keep CMDB-Status**. | -| **Software filter** | You can either enter a white list or a black list of software applications which you want to import (Whitelist) or don't want to import (Blacklist). You can enter wildcards (\*) in this field. The list of titles is separated by comma. | -| **Use filter as regular expression** | Should the object types of the assigned modules of a blade/chassis device be updated? | -| **Use OS family (if available) instead of OS version as object title** | For software import, use the software family as object title instead of the software version. E.g. instead of "Windows Server 2008 Standard" only "Windows" with "Server 2008 Standard" as variant. | -| **Object matching profile** | [Which strategy do you want to use](object-identification-during-imports.md) to update objects which are already documented in i-doit with an import? | -| **Update object type** | When the device already exists as an object in i-doit, you can determine whether the object type is to be updated with help of the assignment (see above) or not. | -| **Update object title** | Should the object title be updated by the import? | +| Option | Description | +| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| **Select categories** | Which [categories](../basics/structure-of-the-it-documentation.md) do you want to fill during import? Only supported categories are listed. | +| **Import network interfaces as** | You can map inventoried network interfaces in different categories. | +| **Include software** | Do you want to import inventoried software as object type **Applications**? | +| **Include software licences** | Do you want to import inventoried licenses as object type **Licenses**? | +| **Import system services** | Do you want to import inventoried Services as object type **System Services**? | +| **Import cloud subscriptions** | Do you want to import inventoried Cloud data?
Data is imported to the category **Assigned subscriptions**. The backward category **Subscriptions** is is assigned to License objects. | +| **Import connection endpoints** | The connections are not imported into the cabling category, but into the category "Connection endpoint". This allows to distinguish between manual cabling and automatic cabling by JDisc. | +| **Use simple database modelling?** | Should the new or the old database logic be used? | +| **Include layer 3 nets** | Do you want to import inventoried IP nets as object type **Layer 3 nets**? | +| **Keep IP address types** | Should IPv4 addresses, IPv6 addresses, loopback addresses, virtual addresses be imported? | +| **Import type for DHCP IP addresses** | Should addresses assigned via DHCP be overwritten? | +| **Include VLans** | Do you want to import inventoried VLans as object type **Layer 2 nets**? | +| **Include clusters** | Do you want to import (virtualization) environments as object type **Cluster**? | +| **Include Blade/Chassis connections during import
** | Do you want to include objects of the type **Blade Server** to objects of the type **Blade Chassis** during import? | +| **Object type of the assigned modules within a blade/chassis unit** | When a blade chassis or switch chassis was inventoried, you can allocate the modules to a certain object type during import. | +| **Update the object type of the assigned modules** | Should the object types of the assigned modules of a blade/chassis device be updated? | +| **Import custom attributes** | When you maintain customized attributes (**Custom Attributes**) in JDisc Discovery, you can import these in i-doit. After import, they are displayed in the **JDisc Custom Attributes** category. | +| **Consider default templates from object types (only for newly created objects)** | When a new object is created, it is possible to consider [templates](../efficient-documentation/templates.md) automatically. The template selection is carried out in the object type configuration. | +| **Change CMDB-status of objects to** | Already existing objects can receive a certain [CMDB status](../basics/life-and-documentation-cycle.md) during updating. If you don't want to change the CMDB-Status, select the option **Keep CMDB-Status**. | +| **Software filter** | You can either enter a white list or a black list of software applications which you want to import (Whitelist) or don't want to import (Blacklist). You can enter wildcards (\*) in this field. The list of titles is separated by comma. | +| **Use filter as regular expression** | Should the object types of the assigned modules of a blade/chassis device be updated? | +| **Use OS family (if available) instead of OS version as object title** | For software import, use the software family as object title instead of the software version. E.g. instead of "Windows Server 2008 Standard" only "Windows" with "Server 2008 Standard" as variant. | +| **Object matching profile** | [Which strategy do you want to use](object-identification-during-imports.md) to update objects which are already documented in i-doit with an import? | +| **Update object type** | When the device already exists as an object in i-doit, you can determine whether the object type is to be updated with help of the assignment (see above) or not. | +| **Update object title** | Should the object title be updated by the import? | Categories which are JDisc specific or have related information: @@ -153,21 +156,18 @@ Before you execute the import process, you have to define the import parameters. Because it is possible to apply more than one JDisc server, you have to select the JDisc server in the first step. The profile which you defined beforehand can be also selected to influence the imported contents and their use. In addition, you can set the import mode. The **Append** import mode creates all found objects without checking whether these already exist. The **Update** import mode creates only objects which can't be found in the i-doit data pool. Categories of already existing objects are complemented (if necessary) with new data. The **Overwrite** import mode is, in principle, like the **Update** mode but with the difference that list categories are emptied first and are then recreated. -| **Import Mode** | **Description** | -| --- | --- | -| **Create** | The import mode **"Create"** will create all found objects without checking if they already exist. | -| **Update** | The import mode **"Update"** will only create objects that could not be found in i-doit. Categories of already existing objects will be supplemented with new data (if necessary). | -| **Update (New inventory)** | With the addition **"(New inventory)"** fixed i-doit-to-jdisc-device links are discarded and the object associations are recalculated. | -| **Only create newly scanned devices** | The "**Only create newly scanned devices"** Mode creates only objects that do not exist in i-doit. | -| **Overwrite** | The **"Overwrite"** import mode behaves exactly like the "Update" mode with the difference that list categories are first emptied and then newly created. | -| **Overwrite (New inventory)** To archive objects that have not been seen by JDisc for a certain number of days, the threshold value and the threshold value unit must be set under **Administration → Settings for [Tenant name ] → JDisc**.| With the addition **"(New inventory)"** fixed i-doit-to-jdisc-device links are discarded and the object associations are recalculated. | - -With the logging function you can influence the extent of the written log. A more extensive logging increases the import duration. - -When you carried out the settings completely, you can activate the import with **Start the import**. Please, consider that the duration of the import process depends both on the size of the JDisc database and the utilized hardware. - -When the import process is completed, a summary is displayed in the **Result** section. - +| **Import Mode** | **Description** | +| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Create** | The import mode **"Create"** will create all found objects without checking if they already exist. | +| **Update** | The import mode **"Update"** will only create objects that could not be found in i-doit. Categories of already existing objects will be supplemented with new data (if necessary). | +| **Update (New inventory)** | With the addition **"(New inventory)"** fixed i-doit-to-jdisc-device links are discarded and the object associations are recalculated. | +| **Only create newly scanned devices** | The "**Only create newly scanned devices"** Mode creates only objects that do not exist in i-doit. | +| **Overwrite** | The **"Overwrite"** import mode behaves exactly like the "Update" mode with the difference that list categories are first emptied and then newly created. | +| **Overwrite (New inventory)** | With the addition **"(New inventory)"** fixed i-doit-to-jdisc-device links are discarded and the object associations are recalculated. | + +With the logging function you can influence the extent of the written log. A more extensive logging increases the import duration.
+When you carried out the settings completely, you can activate the import with **Start the import**. Please, consider that the duration of the import process depends both on the size of the JDisc database and the utilized hardware.
+When the import process is completed, a summary is displayed in the **Result** section.
You can find the logs which are generated during import in the i-doit directory called `log/`. ## Import via JDisc Discovery category