dot4EventClient

Einleitung

Mit dem dot4EventClient ist es möglich, ausgewählte dot4-Funktionen über die Kommandozeile auszuführen.

Installation

Voraussetzung für den dot4EventClient ist .Net Core ab Version 3.1.0. Diese Version kann unter https://aka.ms/dotnet-download heruntergeladen werden.

Anweisungen

CI-Attribute setzen

Mit dem Kommando SetCIAttributes (1) können mehrere Attribute eines CIs geändert werden. Attribute mit folgenden Datentypen werden unterstützt:

SingleLineText
MultilineText
Boolean
LongInteger
Float
Decimal
Date
DateTime
Time
Lookup

Komandozeilenargumente

Argument	Beschreibung	notwendig
--command oder -c	SetCIAttributes oder 1	ja
--ciid	CI Id	ja
-v ... oder --values ...	Technischer Name und Werte Paare der CI-Attribute die gesetzt werden sollen	ja

Beispiele

Dot4EventClient.exe -c 1 --ciid 100 --values Description=Hello mainMemory_COM=2048
Dot4EventClient.exe -c SetCIAttributes --ciid 100 --values "Description=Hello World"

dotnet Dot4EventClient.dll -c 1 --ciid 100 --values Description=Hello

Ein CI suchen und mehrere Attribute setzen

Mit dem Kommando SearchCIAndSetAttributes (2) können mehrere CI-Attribute eines CIs geändert werden. Man gibt den CI-Typ den Technischen Namen und den Wert eines CI-Attributes an. Es wird ein CI mit den Kriterien gesucht. Wird ein CI mit den Kriterien gefunden dann werden die angegebenen CI-Attribute verändert. Werden mehrere CIs gefunden dann wird keine Änderungen durchgeführt. Attribute mit folgenden Datentypen werden unterstützt:

SingleLineText
MultilineText
Boolean
LongInteger
Float
Decimal
Date
DateTime
Time
Lookup

Komandozeilenargumente

Argument	Beschreibung	notwendig
--command oder -c	SearchCIAndSetAttributes oder 2	ja
--cit	CI Typ Id, UUID oder Alias	ja
--sa	Technischer Name des CI-Attribut das gesucht werden soll	ja
--sv	Der Wert des CI-Attribut das gesucht werden soll	ja
-v ... oder --values ...	Technischer Name und Werte Paare der CI-Attribute die gesetzt werden sollen	ja

Beispiele

Dot4EventClient.exe -c 2 --cit MSSR --sa hostname_COM --sv MyHost -v "name=New name" numberOfHardDisks_SRV=3

Ein CI erstellen

Mit dem Kommando CreateCI (3) kann ein neues CI erstellt werden. Attribute mit folgenden Datentypen werden unterstützt:

SingleLineText
MultilineText
Boolean
LongInteger
Float
Decimal
Date
DateTime
Time
Lookup

Komandozeilenargumente

Argument	Beschreibung	notwendig
--command oder -c	CreateCI oder 3	ja
--cit	CI Typ Id, UUID oder Alias	ja
-v ... oder --values ...	Technischer Name und Werte Paare der CI-Attribute die initial gesetzt werden	ja

Beispiel

Dot4EventClient.exe -c 3 --cit MSSR -v "Name=Windows Server Name" numberOfHardDisks_SRV=3 domainName_COM=DomainName 

Lebenszyklusstatus ändern

Der Lebenszyklusstatus eines CIs kann nur geändert werden wenn die Id des CIs und des Lebenszyklusstatus bekannt ist. Ids von CIs erfahren Sie über die URL in deren Detail-Ansicht.
Für die Ids der Lebenszyklusstatus gehen Sie bitte wie folgt vor:

Navigieren Sie dazu zu [Administration => Configuration Management => CI-Lebenszyklusmodelle.](../Administration/Configuration Management/index.html#CI-Lebenszyklusmodelle)
Wählen Sie den gewünschten Lebenszyklus aus und gehen Sie in die Detail-Ansicht
Öffnen Sie den Reiter Lebenszyklusphasen
wählen sie dort die Gewünschte Lebenszyklusphase aus und klicken sie auf das Auge Symbol
Nun werden die einzelnen Lebenszyklusstatus mit Id aufgelistet

Komandozeilenargumente

Argument	Beschreibung	notwendig
--command oder -c	CreateCI oder 3	ja
--ciid	CI Id	ja
-v ... oder --values ...	Technischer Name und Werte Paare der CI-Attribute die initial gesetzt werden	ja

Beispiel

dot4EventClient.exe -c SetCIAttributes --ciid 17035 --values lifecycleStatus=14

Ein Ticket erstellen

Mit dem Kommando CreateTicket (4) kann ein neues Ticket erstellt werden.

Attribute mit folgenden Datentypen werden unterstützt:

SingleLineText
MultilineText
Boolean
LongInteger
Float
Decimal
Date
DateTime
Time
Lookup

Komandozeilenargumente

Argument	Beschreibung	notwendig
--command oder -c	CreateTicket oder 4	ja
--cit	CI Typ Id, UUID oder Alias	ja
-v ... oder --values ...	Name und Werte Paare der Ticket-Attribute die initial gesetzt werden	ja

Spezielle Ticket Attribute

Name	Datentyp	Beschreibung
name oder subject	SingleLineText	Name des Tickets
description	SingleLineText	Ticket Beschreibung
user_email	SingleLineText	E-Mail des Anwenders
assigned_support_group	LongInteger	ID der zuständigen Personengruppe
impact	SingleLineText	Auswirkung
urgency	SingleLineText	Dringlichkeit
priority	SingleLineText	Priorität
category	LongInteger	ID der Kategorie
parent_incident_id	LongInteger	ID des verbundenen Tickets
sap_installation_number	SingleLineText	Nummer der SAP Installation
sap_sysid	SingleLineText	SAP System ID

Beispiele

Dot4EventClient.exe -c 4 --cit SINCI -v "name=SAP Ticket" "category=2" "netBIOSDomain_ROOT=SapDomain" "sap_installation_number=1" "sap_sysid=2"

Beispiele für Attributwerte

Attribut Typ	Beispiele	Kommentare
SingleLineText, MultilineText	Hello, "Hello World"	Bei MultilineText Attribute wird der Wert in einer Zeile ohne Zeilenvorschub gespeichert.
Boolean	True False 0 1
LongInteger	815
Float	3.1415926 -9.1e-3
Decimal	3.5
Date	2020-11-21	ISO 8601 Datumsformat
DateTime	2020-09-21T11:35:00 2020-09-21T11:35:00+01:00	ISO 8601 Datums- und Zeitformat
Time	10:11:12 ,11:30:00+01:00	ISO 8601 Zeitformat
Lookup	9
LifecycleStatus	-v lifecycleStatus=32 ...	Der Lifecycle Status eines CIs kann über die Name und Werte Paare der Attribute angegeben werden. Als Wert muss die numerische ID des Lifecycle Status verwendet werden. Diese ID findet man in der Administration der CI-Lebenszyklusmodelle.

Konfiguration

Einstellungen

Konfiguriert wird der dot4EventClient über eine Konfigurationsdatei im JSON Format. Die Konfigurationsdatei muss sich im Ausführungsverzeichnis befinden und den Dateinamen appsettings.json besitzen. Folgende Einstellungen können konfiguriert werden:

Name	Beschreibung	Standardwert	notwendig
dot4ApiUrl	dot4 API URL	"https://api.dot4.de"	nein
dot4Tenant	Name des dot4-Mandanten	"Default"	nein
dot4User	E-Mail des dot4-Benutzers, unter dem die Funktionen ausgeführt werden		ja
dot4ApiKey	dot4 API Key		ja
serilog	Logging-Einstellungen für die Protokollierung		nein

dot4 API Key

Ein dot4 API Key ist ein Schlüssel, der den Zugang zu dot4 ohne Authentifizierung über Benutzername/Kennwort ermöglicht. Ein dot4 API Key kann im dot4 Client erstellt werden.

Navigieren Sie dazu zu Administration => Rollen und Berechtigungen => API Authentifizierung.
Über den Schalter Erstellen erstellen Sie einen neuen Schlüssel.
Geben Sie hier einen aussagekräftigen Namen für den Schlüssel ein.
Der Typ des Schlüssels muss Dot4Cmdb sein.
Legen Sie das Ablaufdatum des Schlüssels fest.
- Ist dieses Datum überschritten, ist dieser Schlüssel nicht mehr gültig; der Zugriff auf dot4 wird verweigert.
- Bleibt das Feld leer, hat der Schlüssel kein Ablaufdatum.

Nach dem Erzeugen wird ein Dialogfeld mit dem generierten Schlüssel angezeigt.

Wichtig!

Notieren Sie sich den Schlüssel und bewahren Sie ihn sicher auf, da er nicht wieder abgerufen werden kann.

Beispiel für eine Konfigurationsdatei appsettings.json

{
  "dot4Tenant": "TenantName",
  "dot4User": "user@mail.de",
  "dot4ApiKey": "adfd0480-0f6b-48da-9aa9-ab262eeaf94f_W2zQx8FYpUlGUndpSAUWpzBMXUH9k63sfxtLPweR3mJOcBOteN2pQBvb1xvGAyTMVGwvqEMWAguEHuSlgFMaruxFuUQlBugvoQPw1bFY8rG6WmTP5mj3UPzoZkabuCX2",

  "Serilog": {
    "MinimumLevel": "Information",
    "WriteTo": [
      {
        "Name": "File",
        "Args": {
          "path": "Dot4EventClient.log",
          "fileSizeLimitBytes": "10000000",
          "retainedFileCountLimit": "10",
          "rollOnFileSizeLimit": "true",
          "shared": "true"
        }
      }
    ]
  }
}