Effiziente Administration Ihrer Netzwerkumgebung

Transkript

1 n ne atio n orm tione f n n ri tze onve nu Be nd K u Effiziente Administration Ihrer Netzwerkumgebung XML-WebService Schnittstelle

2 Inhaltsverzeichnis Allgemeines 3 Web Service 3 Starten und Kontrollieren von Anträgen ABSENDEN EINES OM ANTRAGS ABFRAGE DES ANTRAGSSTATUS ABFRAGE DES ANTRAG-PROTOKOLLS 6 Abfrage von Bestandsdaten AUSLESEN VON OBJEKTEN EINES FREMDSYSTEMS AUSLESEN VON OBJEKTEN MIT SPEZIELLEN ATTRIBUTEN 9 Berechtigungen 11 Aufruf mit.net 11

3 Allgemeines Mit der XML WebService-Schnittstelle kann direkt auf die Prozess-Ebene des Operations Manager zugegriffen werden. Neben der Bereitstellung von Daten der hierarchischen Datenbank HDB können Prozesse gestartet, überwacht und freigegeben werden. Der WebService kann sowohl über SOAP als auch http Get und Post aufgerufen werden. Das folgende Dokument beschreibt, wie auf Daten der HDB zugegriffen werden kann. Weiterhin wird gezeigt, wie ein Prozess gestartet und überwacht werden kann. Zur Anbindung an den Operations Manager WebService empfehlen wir den Einsatz eines integrierten SOAP-Toolkit, wie ihn beispielsweise MS Visual Studio zur Verfügung stellt. Es können nach Registrierung der Web-Reference dort z.b. die WebServices mit einem Objekt-Browser angezeigt und analysiert werden. Diese Schnittstelle ist lesbar und gut nachvollziehbar. Asu diesem Grund verzichten wir darauf, in diesem Dokument die Web-Services vollständig zu beschreiben. Wir zeigen vielmehr den prinzipiellen Einsatz einzelner Methoden auf. Die Vorgehensweise lässt sich problemlos auf andere Methoden anwenden. Web Service Der Operations Manager WebService ist auf einem Server verfügbar, wenn neben dem Base-Paket auch das WebService Paket installiert wurde (siehe Dokument Operations Manager_V27_Installationsanleitung.pdf ) Bei der Installation wird ein neues Verzeichnis omwebservice auf dem Web Server erzeugt. Mit der URL kann der Web-Server auf dem lokalen Server angesprochen und getstet werden: Stand: Seite 3 von 11

4 Hier werden die einzelnen Web-Service Methoden aufgelistet. Wird eine Methode ausgewählt, so erhält man das Interface und kann den Web-Service in einem Dialog testen: Auswahl der Methode GetHDBObject. Hier werden nun die Daten des Objekts der Klasse Host, Instanz S17 aus der Datenbank per WebService abgefragt: Das Ergebnis ist die Rückgabe eines Objekts mit den Daten des Host. Stand: Seite 4 von 11

5 Starten und Kontrollieren von Anträgen 1.1 Absenden eines OM Antrags Um einen OM Antrag zu starten und in die Warteschlange einzustellen, wird die Methode InQueueWithId verwendet: Als Parameter werden die folgenden Informationen angegeben: sserver: SDatabase: Dispatcher: WhenToDo: Antragsart: Vorlage: Params: Datenbankserver auf dem der Antrag eingestellt wird Datenbank in den der Antrag eingestellt wird Dispatcher-Server der den Antrag bearbeiten soll all bedeutet, der nächste mit freier Kapazität Datum und Uhrzeit, wann der Antrag gestartet werden darf Keine Angabe bedeutet sofort Name der Antragsart bzw. des Prozessablaufs Vorlage für den Antrag (i.d.r. standard) Liste von Parametern für den Antrag Notation: Param1=Wert1 Param2=Wert2 Alternativ: Param1={Wert1},Param2={Wert2}, Stand: Seite 5 von 11

6 Wird der Antrag gestartet, erhält man die eindeutige Bearbeitungsnummer zurück: Mit dieser Bearbeitungsnummer ist eine Weiterverfolgung des Antrags möglich. Da der Operations Manager als Warteschlangensystem asynchron arbeitet, muss der Zustand des Antrags regelmäßig abgefragt werden, um ein Ergebnis zu erhalten. 1.2 Abfrage des Antragsstatus Mit der WebService Methode AntragsStatus kann der Zustand des Antrags in der Warteschlange ermittelt werden. Ergebnis ist neben anderen Informationen eine Feld Status, welches die folgenden Werte annehmen kann: Acknowledged Processing Confirm Step Async Failed Success Warten auf Abarbeitung durch einen freien Dispatcher In Bearbeitung durch einen Dispatcher Warten auf Bestätigung (4 Augen Prinzip) Warten auf nächsten Prozessschritt Warten auf Ereignis bevor wieder in Processing Prozess beendet und Fehlgeschlagen Prozess erfolgreich beendet Konnte der Antrag nicht erfolgreich abgeschlossen, kann das Antragsprotokoll eingesehen werden. 1.3 Abfrage des Antrag-Protokolls Mit der Web-Service Methode AntragsErgebnis kann das Ergebnis jedes einzelnen Prozessschritts mit Fehlermeldung ausgelesen werden. Es ist so möglich, festzustellen, warum der Prozess möglicherwiese fehlgeschlagen ist. Stand: Seite 6 von 11

7 Beispiel für einen fehlgeschlagenen Antrag. Die Fehlermeldung des jeweiligen Prozessschritts steht im Feld Error. Stand: Seite 7 von 11

8 Abfrage von Bestandsdaten Über den XML-WebService können Zustandsdaten der Fremdsysteme, die durch den Operations Manager verwaltet werden abgefragt werden. Über unterschiedliche Methoden kann dazu auf die hierarchische Datenbank des Operations Manager zugegriffen werden. Im folgenden sind Beispiele für das Auslesen aller Benutzerkonten und Gruppen eines durch den OM verwalteten Active-Directory gezeigt. 1.4 Auslesen von Objekten eines Fremdsystems Mit der Methode GetObjectList kann eine Menge von Objekten einer bestimmten Klasse mit allen Eigenschaften ermittelt und zurück geliefert werden: Im obigen Beispiel werden alle AD-Konten (Klasse Account) geliefert, die im Attribut Mandant den Wert 1 besitzen, also zu Mandant 1 gehören: Stand: Seite 8 von 11

9 Die HDB-Objekte werdne mit allen Attributen zurück geliefert. Um nur gewünschte Attribute zu erhalten und damit bei großen Datenmengen ein besseres Antwortzeitverhalten zu haben verwendet man die Methode GetHDBDataSet. 1.5 Auslesen von Objekten mit speziellen Attributen Mit der Methode GetHDBDataSet können Objekte mit speziellen gewünschten Attributen in einem.net DataSet zurück gegeben werden: Stand: Seite 9 von 11

10 Der folgende Aufruf liefert alle Gruppen des Mandanten 2 mit den Eigenschaften Name, AccountName, Beschreibung und Id zurück: Stand: Seite 10 von 11

11 Berechtigungen Um einen Antrag über den XML WebService starten zu könen, muss der Antragsteller neben RX (Read, execute) die Berechtigung M für Middleware für die Antragsart besitzen. Die Anmeldung an den Web-Service erfolgt mit integrierter Windows Sicherheit. Der Antragsteller muss einen gültigen Sicherheitskontext auf dem Web-Server besitzen. Aufruf mit.net Im folgenden ist ein Beispiel für einen WebService Aufruf mit.net (C#) gezeigt. Über die Methode InQueueWithId wird ein Antrag gestartet: s17.omwebsrv srv = new WebSrvTest.s17.OMWebSrv(); srv.credentials = System.Net.CredentialCache.DefaultCredentials; // System.Net.NetworkCredential ocred = new System.Net.NetworkCredential("user", "password", "AD"); // srv.credentials = ocred; WebSrvTest.s17.ReturnInfo ori = srv.inqueueserialwithid("s17", "ntadm2", "all", "", "OMHeartBeat", "standard", "StartTime= :00"); int iid = ori.requestid; Stand: Seite 11 von 11