Web GUIAdministrationAPI (WAAPI) Benutzerhandbuch · 2020. 12. 10. · Kapitel 1. Web GUI Administration API (WAAPI ... IBM Support Assistant (ISA) ist eine kostenlose lokale Arbeitsumgebung

Tivoli Netcool/OMNIbusVersion 8 Release 1

Web GUI Administration API (WAAPI)Benutzerhandbuch

SC43-2385-01

��

Tivoli Netcool/OMNIbusVersion 8 Release 1

Web GUI Administration API (WAAPI)Benutzerhandbuch

SC43-2385-01

��

HinweisVor Verwendung dieser Informationen und des darin beschriebenen Produkts sollten die Informationen unter Bemerkungengelesen werden.

Diese Veröffentlichung ist eine Übersetzung des HandbuchsIBM Tivoli Netcool/OMNIbus, Version 8 Release 1, Web GUI Administration API (WAAPI) User's Guide,IBM Form SC27-6506-01,herausgegeben von International Business Machines Corporation, USA

© Copyright International Business Machines Corporation 2013, 2015

Informationen, die nur für bestimmte Länder Gültigkeit haben und für Deutschland, Österreich und die Schweiznicht zutreffen, wurden in dieser Veröffentlichung im Originaltext übernommen.

Möglicherweise sind nicht alle in dieser Übersetzung aufgeführten Produkte in Deutschland angekündigt und ver-fügbar; vor Entscheidungen empfiehlt sich der Kontakt mit der zuständigen IBM Geschäftsstelle.

Änderung des Textes bleibt vorbehalten.

Herausgegeben von:TSC GermanyKst. 2877Februar 2015

© Copyright IBM Corporation 2011, 2015.

Inhaltsverzeichnis

Inhalt des Handbuchs. . . . . . . . . vZielgruppe . . . . . . . . . . . . . . . vVeröffentlichungen . . . . . . . . . . . . vBehindertengerechte Bedienung . . . . . . . viiTivoli-Schulungen . . . . . . . . . . . . viiInformationen zur Unterstützung . . . . . . . viiIn diesem Handbuch verwendete Konventionen viii

Kapitel 1. Web GUI Administration API(WAAPI) . . . . . . . . . . . . . . . 1Informationen zu WAAPI . . . . . . . . . . 1

Prozeduren zum Ändern der Web-GUI im Ver-gleich. . . . . . . . . . . . . . . . 3

Kommunikation zwischen dem WAAPI-Client unddem Web-GUI-Server . . . . . . . . . . . 3Sicherheit . . . . . . . . . . . . . . . 4

Kapitel 2. WAAPI verwenden . . . . . . 7WAAPI-Merkmaldatei einrichten . . . . . . . 7WAAPI-Anforderungen an den Server senden . . . 7

Kapitel 3. WAAPI-Anforderungen . . . . 9Struktur einer WAAPI-Anforderung . . . . . . 9

Merkmale von WAAPI-XML-Dokumenten . . . 11Beispielanforderungen . . . . . . . . . . 13

Benutzeranforderungen . . . . . . . . . . 13Benutzer verwalten . . . . . . . . . . . 13Benutzer ändern . . . . . . . . . . . . 13Liste von Benutzern abrufen. . . . . . . . 22

Sichtanforderungen . . . . . . . . . . . . 22Sicht erstellen. . . . . . . . . . . . . 22Sicht erstellen oder ersetzen . . . . . . . . 27Sicht ändern . . . . . . . . . . . . . 28Sicht löschen . . . . . . . . . . . . . 29Liste von Sichten abrufen. . . . . . . . . 29

Mapanforderungen . . . . . . . . . . . . 30Map erstellen . . . . . . . . . . . . . 30Map erstellen oder ersetzen . . . . . . . . 48Map löschen . . . . . . . . . . . . . 49Liste von Maps abrufen . . . . . . . . . 49Map ändern . . . . . . . . . . . . . 49Visuelles Mapelement hinzufügen . . . . . . 50Visuelles Mapelement hinzufügen oder ersetzen 50Visuelles Mapelement löschen . . . . . . . 51Visuelles Mapelement ändern . . . . . . . 51

Ressourcenanforderungen . . . . . . . . . 52Ressource hinzufügen . . . . . . . . . . 52Ressource erstellen oder ersetzen . . . . . . 53Ressource entfernen . . . . . . . . . . 53Liste von Ressourcen abrufen . . . . . . . 54

Dateianforderungen . . . . . . . . . . . 54Verzeichnis hinzufügen . . . . . . . . . 54Datei hinzufügen . . . . . . . . . . . 55Datei erstellen oder ersetzen. . . . . . . . 56Datei löschen . . . . . . . . . . . . . 56

Verzeichnis entfernen . . . . . . . . . . 56Verzeichnis rekursiv entfernen . . . . . . . 57

Menüanforderungen . . . . . . . . . . . 57Menü erstellen . . . . . . . . . . . . 57Menü erstellen oder ersetzen . . . . . . . 60Menü löschen . . . . . . . . . . . . 60Liste von Menüs abrufen . . . . . . . . . 61Menü ändern . . . . . . . . . . . . . 61

Toolanforderungen . . . . . . . . . . . . 62Tool erstellen . . . . . . . . . . . . . 62Tool erstellen oder ersetzen . . . . . . . . 69Tool löschen . . . . . . . . . . . . . 70Liste von Tools abrufen . . . . . . . . . 70Tool ändern . . . . . . . . . . . . . 70

Anforderungen für Eingabeaufforderungen . . . . 71Eingabeaufforderung erstellen oder ersetzen . . 72Eingabeaufforderung löschen . . . . . . . 79Liste von Eingabeaufforderungen abrufen . . . 79Eingabeaufforderung ändern . . . . . . . 80

CGI-Anforderungen . . . . . . . . . . . 80CGI-Script registrieren . . . . . . . . . . 81CGI-Script erstellen oder ersetzen . . . . . . 82CGI-Script ändern . . . . . . . . . . . 82Registrierung eines CGI-Scripts zurücknehmen 82

Filteranforderungen . . . . . . . . . . . 83Filter hinzufügen . . . . . . . . . . . 83Filter erstellen oder ersetzen . . . . . . . . 87Filter löschen . . . . . . . . . . . . . 88Liste von Filtern abrufen . . . . . . . . . 88Filter ändern . . . . . . . . . . . . . 89Standardsicht festlegen . . . . . . . . . 90

Filterobjektgruppenanforderungen . . . . . . . 90Filterobjektgruppe erstellen . . . . . . . . 90Filter einer Filterobjektgruppe hinzufügen . . . 91Filterobjektgruppe erstellen oder ersetzen . . . 92Filterobjektgruppe löschen . . . . . . . . 92Filter aus einer Filterobjektgruppe löschen . . . 93Liste von Filterobjektgruppen abrufen . . . . 93Filterobjektgruppe ändern . . . . . . . . 94Sicht für eine Filterobjektgruppe festlegen . . . 94

Messwertanforderungen . . . . . . . . . . 95Messwert erstellen . . . . . . . . . . . 95Messwert erstellen oder ersetzen . . . . . . 100Messwert löschen . . . . . . . . . . . 101Liste von Messwerten abrufen . . . . . . . 101Messwert ändern . . . . . . . . . . . 101

Beziehungsanforderungen . . . . . . . . . 102Beziehung erstellen . . . . . . . . . . 102Beziehung erstellen oder ersetzen . . . . . 105Beziehung löschen. . . . . . . . . . . 106Liste von Beziehungen abrufen . . . . . . 106Beziehung ändern . . . . . . . . . . . 106

Sonstige Anforderungen . . . . . . . . . . 107Systemstatusbericht generieren . . . . . . 107Filter und Sichten erneut laden . . . . . . 108

© Copyright IBM Corp. 2011, 2015 iii

Knoten aus einem Lastausgleichscluster entfer-nen. . . . . . . . . . . . . . . . 108Web-GUI-Cache mit der ObjectServer-Datenbankresynchronisieren . . . . . . . . . . . 108

Anhang A. WAAPI-Merkmale und Be-fehlszeilenoptionen . . . . . . . . . 109

Anhang B. WAAPI-Client auf einemfernen Host installieren . . . . . . . 113

Anhang C. WAAPI-Sicherheit . . . . . 115Sichere WAAPI-Verbindungen erstellen . . . . . 115

WAAPI-SSL-Verbindung erstellen (Nur-Server-Authentifizierung) . . . . . . . . . . . 116WAAPI-SSL-Verbindung erstellen (Client/Ser-ver-Authentifizierung) . . . . . . . . . 117WAAPI-SSL-Verbindung mit FIPS 140–2 erstel-len (Nur-Server-Authentifizierung) . . . . . 119

WAAPI-SSL-Verbindung mit FIPS 140–2 erstel-len (Client/Server-Authentifizierung) . . . . 120SP800-131a-Übergangsmodus auf dem WAAPI-Client festlegen . . . . . . . . . . . . 123Strikten SP800-131-Modus auf dem WAAPI-Cli-ent festlegen. . . . . . . . . . . . . 124

WAAPI-Kennwortverschlüsselung aktivieren . . . 125WAAPI-Kennwörter mit AES verschlüsseln . . 125WAAPI-Kennwörter mit dem FIPS 140–2-Modusverschlüsseln . . . . . . . . . . . . 126

Merkmaldatei 'waapi.init' schützen . . . . . . 127

Bemerkungen . . . . . . . . . . . 129Marken . . . . . . . . . . . . . . . 132

Index . . . . . . . . . . . . . . . 133

iv IBM Tivoli Netcool/OMNIbus: Web GUI Administration API (WAAPI) Benutzerhandbuch

Inhalt des Handbuchs

Die IBM Tivoli Netcool/OMNIbus-Web-GUI ist eine webbasierte Anwendung, dieNetzereignisse aus einer oder aus mehreren Datenquellen verarbeitet und Benut-zern die Ereignisdaten in unterschiedlichen grafischen Formaten präsentiert.

Das Dokument IBM Tivoli Netcool/OMNIbus Web GUI Administration API (WAAPI)Benutzerhandbuch enthält Informationen, die erläutern, wie die Tivoli Netcool/OM-NIbus-Web-GUI mithilfe einer XML-Anwendungsprogrammierschnittstelle (API)mit dem Namen WAAPI verwaltet wird.

ZielgruppeDieses Handbuch richtet sich an Administratoren der Tivoli Netcool/OMNIbus-Web-GUI. Das Handbuch enthält Informationen zur Verwaltung der Web-GUI mit-hilfe von WAAPI.

Diese Veröffentlichung geht davon aus, dass der Administrator über angemesseneXML-Kenntnisse verfügt. Insbesondere geht diese Veröffentlichung davon aus, dassder Administrator über die folgenden Kenntnisse verfügt:v In XML verwendete Regeln, Logik und Komponentenv Konzepte Elemente, Attribute und Markup

v Erstellung korrekt formatierter und gemäß einer XML-Dokumenttypdefinition(DTD) gültiger Dokumente

VeröffentlichungenIn diesem Abschnitt sind die Veröffentlichungen in der Tivoli Netcool/OMNIbus-Bibliothek sowie zugehörige Dokumente aufgelistet. Hier wird außerdem beschrie-ben, wie Sie online auf die verfügbaren Tivoli-Veröffentlichungen zugreifen undTivoli-Veröffentlichungen bestellen können.

Tivoli Netcool/OMNIbus-Bibliothek

In der Tivoli Netcool/OMNIbus-Bibliothek sind die folgenden Dokumente verfüg-bar:v IBM Tivoli Netcool/OMNIbus Installation and Deployment Guide,

Dieses Handbuch enthält Installations- und Upgradeprozeduren für TivoliNetcool/OMNIbus. Außerdem ist beschrieben, wie die Sicherheit und die Kom-ponentenkommunikation konfiguriert wird. Die Veröffentlichung enthält desWeiteren Beispiele von Tivoli Netcool/OMNIbus-Architekturen sowie Beschrei-bungen ihrer Implementierung.

v IBM Tivoli Netcool/OMNIbus Administration Guide,Dieses Handbuch beschreibt, wie Verwaltungstasks mit der Administrator-GUIvon Tivoli Netcool/OMNIbus, mit Befehlszeilentools und mit der Prozesssteue-rung ausgeführt werden. Die Veröffentlichung enthält außerdem Beschreibungenund Beispiele für die SQL-Syntax und Automatisierungen von ObjectServer.

v IBM Tivoli Netcool/OMNIbus Web-GUI Administrations- und Benutzerhandbuch,Beschreibt die Ausführung von Verwaltungsaufgaben und von Tasks zur Ereig-nisvisualisierung mithilfe der Tivoli Netcool/OMNIbus-Web-GUI.

© Copyright IBM Corp. 2011, 2015 v

v IBM Tivoli Netcool/OMNIbus User's Guide,Dieses Handbuch vermittelt einen Überblick über die Desktop-Tools. Außerdemsind die Operatortasks für das Ereignismanagement unter Verwendung dieserTools beschrieben.

v IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide,Dieses Handbuch enthält - neben einer entsprechenden Einführung - Referenzin-formationen zu Tests und Gateways (inklusive Angaben zur Syntax von Testre-geldateien und zu Gatewaybefehlen).

v IBM Tivoli Monitoring for Tivoli Netcool/OMNIbus Agent User's Guide,Beschreibt die Installation des Statusüberwachungsagenten für Tivoli Netcool/OMNIbus und enthält Referenzinformationen zum Agenten.

v IBM Tivoli Netcool/OMNIbus Event Integration Facility Reference,Beschreibt die Entwicklung von Ereignisadaptern, die speziell auf Ihre Netzum-gebung und die Anforderungen Ihres Unternehmens zugeschnitten sind. Außer-dem wird in dieser Veröffentlichung beschrieben, wie Ereignisse an der Quellegefiltert werden.

v IBM Tivoli Netcool/OMNIbus Error Messages Guide,Dieses Handbuch enthält eine Liste der Systemnachrichten in Tivoli Netcool/OMNIbus sowie die entsprechende Vorgehensweise bei Erhalt dieser Nachrich-ten.

v IBM Tivoli Netcool/OMNIbus Web GUI Administration API (WAAPI) Benutzerhand-buch,Beschreibt die Vorgehensweise zum Verwalten der Tivoli Netcool/OMNIbus-Web-GUI unter Verwendung der XML-Anwendungsprogrammierschnittstelle mitder Bezeichnung WAAPI.

v IBM Tivoli Netcool/OMNIbus ObjectServer HTTP Interface Reference Guide, Be-schreibt die URIs und das allgemeine Verhalten der API "ObjectServer HTTP In-terface". Beschreibt darüber hinaus, wie die API aktiviert werden kann, und lie-fert Beispiele zu JSON-Nutzdaten sowie HTTP-Anforderungen und -Antworten.

v IBM Tivoli Netcool/OMNIbus ObjectServer OSLC Interface Reference Guide, Be-schreibt die Services, Ressourcen und das allgemeine Verhalten der API "Object-Server OSLC Interface" (OSLC = Open Services for Lifecycle Collaboration). Be-schreibt darüber hinaus, wie die API aktiviert werden kann, und liefert Beispielezu Service-Provider-Definitionen, RDF/XML-Nutzdaten sowie HTTP-Anforde-rungen und -Antworten.Wenn Sie andere IBM Produkte zum Erweitern der Funktionalität von TivoliNetcool/OMNIbus verwenden, wie DB2, IBM Tivoli Monitoring oder TivoliCommon Reporting, erhalten Sie Informationen zu den relevanten Veröffentli-chungen im Information Center des betreffenden Produkts.

Online auf Terminologie zugreifen

Auf der Website für die IBM-Terminologie finden Sie eine Übersicht zur Terminolo-gie der IBM Produktbibliotheken, auf die Sie einfach und bequem zugreifen kön-nen. Sie können die Website für Terminologie unter der folgenden Webadresse auf-rufen:

http://www.ibm.com/software/globalization/terminology

vi IBM Tivoli Netcool/OMNIbus: Web GUI Administration API (WAAPI) Benutzerhandbuch

http://www.ibm.com/software/globalization/terminology

Online auf Veröffentlichungen zugreifen

IBM stellt Veröffentlichungen für das vorliegende und alle anderen Tivoli-Produkteauf der folgenden Website für Tivoli Downloads bereit, sobald diese verfügbar sindoder wenn sie aktualisiert wurden:

ftp://public.dhe.ibm.com/software/tivoli/Netcool/NetcoolOmnibus/library/

Anmerkung: Wenn Sie PDF-Dokumente nicht im Papierformat Letter druckenmöchten, verwenden Sie die Option im Fenster Datei > Drucken, um Adobe Rea-der anzuweisen, Seiten im Papierformat Letter auf dem von Ihnen verwendetenPapier zu drucken.

Behindertengerechte BedienungDie Funktionen zur behindertengerechten Bedienung (Accessibility Features) unter-stützen Benutzer mit körperlichen Behinderungen, wie etwa eingeschränkter Be-weglichkeit oder eingeschränktem Sehvermögen, bei der erfolgreichen Benutzungvon Softwareprodukten.

Das vorliegende Produkt unterstützt Technologien für die behindertengerechte Be-dienung, mit deren Hilfe die Elemente der Benutzerschnittstelle angesagt werdenkönnen und die Navigation in der Schnittstelle vereinfacht wird. Darüber hinauskönnen Sie die meisten Funktionen der grafischen Benutzerschnittstelle anstatt mitder Maus auch über die Tastatur ausführen.

Weitere Informationen finden Sie im Anhang zur behindertengerechten Bedienungin Funktionen zur behindertengerechten Bedienung für die Web-GUI.

Tivoli-Schulungen

Informationen zu Tivoli-Schulungen finden Sie auf der folgenden IBM Tivoli-Schu-lungswebsite:

http://www.ibm.com/software/tivoli/education

Informationen zur UnterstützungWenn bei der Verwendung Ihrer IBM Software Probleme auftreten, dann ist eswichtig, diese möglichst schnell zu beheben. IBM stellt Ihnen die folgenden Mög-lichkeiten zur Verfügung, um Unterstützung anzufordern:

OnlineRufen Sie die Website für IBM Software Support unter der Adresse http://www.ibm.com/software/support/probsub.html auf und befolgen Sie diesedort aufgeführten Anweisungen.

IBM Support AssistantIBM Support Assistant (ISA) ist eine kostenlose lokale Arbeitsumgebungzur Verbesserung der Servicefreundlichkeit, mit deren Hilfe Sie Fragen be-antworten und Probleme beheben können, die bei der Verwendung vonIBM Softwareprodukten aufgetreten sind. IBM Support Assistant ermög-licht Ihnen den raschen Zugriff auf unterstützungsrelevante Informationenund auf Tools für die Servicefreundlichkeit, mit denen Fehler ermittelt wer-

Inhalt des Handbuchs vii

ftp://public.dhe.ibm.com/software/tivoli/Netcool/NetcoolOmnibus/library/

http://www.ibm.com/software/tivoli/education

http://www.ibm.com/software/support/probsub.html

http://www.ibm.com/software/support/probsub.html

den können. Rufen Sie die Website http://www.ibm.com/software/support/isa auf, um die Software von IBM Support Assistant zu installie-ren.

DokumentationWenn Sie Vorschläge zur Verbesserung des Inhalts oder der Gliederungdieses Handbuchs machen möchten, senden Sie Ihre Vorschläge an dasTeam für Tivoli Netcool/OMNIbus Information Development unter der fol-genden Adresse:

mailto://[email protected]

In diesem Handbuch verwendete KonventionenIm vorliegenden Handbuch werden verschiedene Konventionen zur Darstellungbestimmter Termini und Aktionen sowie zur Angabe von betriebssystemabhängi-gen Befehlen und Pfaden benutzt.

Web-GUI-Ausgangsverzeichnis

WEBGUI_HOMEVerweist auf das Verzeichnis, in dem die Web-GUI installiert ist. DiesesVerzeichnis wird als Web-GUI-Ausgangsverzeichnis bezeichnet. Die Stan-dardwerte lauten wie folgt:

UNIX Linux /opt/IBM/tivoli/netcool/omnibus_webgui

Windows C:\IBM\tivoli\netcool\omnibus_webgui

Das Web-GUI-Ausgangsverzeichnis unterscheidet sich von den Jazz forService Management-Ausgangsverzeichnissen.

Jazz for Service Management-Ausgangsverzeichnisse

WAS_HOMEVerweist auf die Position, an der WebSphere Application Server installiertist. Diese Position kann im Verlauf der Installation angegeben werden. DieStandardwerte lauten wie folgt:

UNIX Linux /opt/IBM/WebSphere/AppServer

Windows C:\Program Files\IBM\WebSphere\AppServer

JazzSM_HOMEVerweist auf die Position, an der Jazz for Service Management installiertist. Diese Position kann im Verlauf der Installation angegeben werden. DieStandardwerte lauten wie folgt:

UNIX Linux /opt/IBM/JazzSM

Windows C:\Program Files\IBM\JazzSM

JazzSM_HOMEVerweist auf die Position des Anwendungsserverprofils, das für Jazz forService Management verwendet wird. Diese Position befindet sich im Un-terverzeichnis /profile des Jazz for Service Management-Ausgangsver-zeichnisses.

UNIX Linux JazzSM_HOME/profile

Windows JazzSM_HOME\profile

DASH_HOMEVerweist auf die Position, an der Dashboard Application Services Hub ins-

viii IBM Tivoli Netcool/OMNIbus: Web GUI Administration API (WAAPI) Benutzerhandbuch

http://www.ibm.com/software/support/isa

http://www.ibm.com/software/support/isa

mailto://[email protected]

talliert ist. Diese Position kann im Verlauf der Installation angegeben wer-den. Die Standardwerte lauten wie folgt:

UNIX Linux /opt/IBM/JazzSM/ui

Windows C:\Program Files\IBM\JazzSM\ui

Informationen zu anderen Jazz for Service Management-Installationsverzeichnissenfinden Sie im Information Center für Jazz for Service Management unter der Ad-resse http://www-01.ibm.com/support/knowledgecenter/SSEKCU/welcome.

Betriebssystemabhängige Variablen- und Pfadangaben

In diesem Handbuch werden zur Definition von Umgebungsvariablen und Ver-zeichnisangaben die UNIX-Konventionen verwendet.

Wenn Sie die Windows-Befehlszeile verwenden, müssen Sie bei Umgebungsvariab-len die Angabe $variable durch %variable% und in Verzeichnispfaden die Schrägstri-che ((/)) durch Backslashes ((\)) ersetzen. So gibt beispielsweise auf UNIX-Syste-men die Umgebungsvariable $NCHOME den Pfad zum Ausgangsverzeichnis vonNetcool an. Auf Windows-Systemen gibt die Umgebungsvariable %NCHOME%den Pfad zum Ausgangsverzeichnis von Netcool an. Die Namen von Umgebungs-variablen können unter Windows und UNIX variieren. So ist z. B. in Windows-Umgebungen die Umgebungsvariable %TEMP% gleichbedeutend mit der Umge-bungsvariablen $TMPDIR in UNIX-Umgebungen.

Wenn Sie auf einem Windows-System mit der Bash-Shell arbeiten, können Sie dieUNIX-Konventionen verwenden.

Netcool-Ausgangsposition

Die Netcool-Ausgangsposition ist das Basisverzeichnis, in dem Tivoli Netcool/OMNIbus installiert ist. Die Netcool-Ausgangsposition wird durch die Umge-bungsvariable NCHOME definiert. Der Wert von NCHOME lautet wie folgt:

v UNIX Linux $NCHOME-Standardwert: /opt/IBM/tivoli/netcool

v Windows %NCHOME%-Standardwert: C:\IBM\Tivoli\Netcool

Wenn ein Verzeichnis- oder Befehlspfad mit der Variable NCHOME beginnt, geltendie Informationen für alle unterstützten Betriebssysteme.

Andere Produkte, die die Umgebungsvariable NCHOME verwenden, z. B. IBM Ti-voli Network Manager IP Edition, können an der Netcool-Ausgangsposition instal-liert werden. Für jedes Produkt werden die jeweiligen Komponenten und Dateienin einem zugeordneten Produktunterverzeichnis der Netcool-Ausgangsposition ins-talliert. Dateien, die für alle Produkte gemeinsam vorhanden sind, werden in ge-meinsam genutzten Unterverzeichnissen der Netcool-Ausgangsposition installiert.

Konventionen für Hinweisgrafiken

Die Dokumentation für Tivoli Netcool/OMNIbus enthält Hinweisgrafiken, mit de-nen angegeben wird, dass Teile eines Abschnitts oder einer Anweisung nur unterbestimmten Bedingungen gelten. Die Bedeutung der einzelnen Grafiken wird inder folgenden Tabelle beschrieben.

Inhalt des Handbuchs ix

http://www-01.ibm.com/support/knowledgecenter/SSEKCU/welcome

Tabelle 1. Hinweisgrafiken für Tivoli Netcool/OMNIbus

Grafik Beschreibung

PureDataWeb GUI Der Text bzw. die Anweisung gilt nur für die Komponente Web-GUI.

UNIX Der Text bzw. die Anweisung gilt nur für UNIX-Betriebssysteme wie AIX undSolaris. Folgende Hinweisgrafiken werden bei Bedarf für AIX und Solaris ver-wendet:

AIX Solaris

Linux Der Text bzw. die Anweisung gilt nur für Linux-Betriebssysteme.

Windows Der Text bzw. die Anweisung gilt nur für Windows-Betriebssysteme.

32�bit Der Text bzw. die Anweisung gilt nur für 32-Bit-Betriebssysteme.

64�bit Der Text bzw. die Anweisung gilt nur für 64-Bit-Betriebssysteme.

FIPS 140-2 Der Text bzw. die Anweisung gilt nur für die Verwendung oder Konfigurationder FIPS 104-2-Verschlüsselung.

Default Der Text bzw. die Anweisung dient zur Beschreibung des Standardverhaltensoder gilt nur für Standardkonfigurationen.

Fix Pack 1 Der Text bzw. die Anweisung gilt nur für die Fixpacknummer, die in der Gra-fik angegeben wird. Features oder funktionale Erweiterungen, die im Text be-schrieben werden, sind erst nach der Installation des angegebenen Fixpacksverfügbar.

Anmerkung: Fixpacks für die Serverkomponente und die Komponente Web-GUI werden unabhängig voneinander freigegeben. Web-GUI-Fixpacks werdenwie folgt angegeben:

PureDataWeb GUI Fix Pack 1

Administrator Der Text bzw. die Anweisung gilt nur für Web-GUI-Administratoren. Diessind Benutzer, denen die Rollen "ncw_user" und "ncw_admin" zugeordnetsind.

C Der Text bzw. die Anweisung gilt nur für die Programmiersprache C.

Java Der Text bzw. die Anweisung gilt nur für die Programmiersprache Java™.

Schriftbildkonventionen

Im vorliegenden Handbuch werden folgende Schriftbildkonventionen verwendet:

Fettdruck

v Befehle in Kleinschreibung oder gemischter Groß-/Kleinschreibung, dieschwierig vom umliegenden Text zu unterscheiden sind.

v Steuerelemente der Schnittstelle (Markierungsfelder, Schaltflächen, Op-tions- und Drehfelder, Felder, Ordner, Symbole, Listenfenster und zuge-hörige Einträge, mehrspaltige Listen, Container, Menüoptionen und -na-men, Registerkarten sowie Merkmalseiten) und Hinweise (wie z. B.Tipp: und Hinweise zum Betriebssystem:).

v Schlüsselwörter und Parameter im Text.

Kursivdruck

v Zitate (z. B. Handbuchtitel, Bezeichnungen von CDs und anderen Daten-trägern).

x IBM Tivoli Netcool/OMNIbus: Web GUI Administration API (WAAPI) Benutzerhandbuch

v Im Text definierte Wörter (z. B. "... eine Standleitung wird auch alsPunkt-zu-Punkt-Leitung bezeichnet.").

v Hervorhebungen von Wörtern und Buchstaben (Wörter als Beispiele:"Verwenden Sie das Wort that, um eine restriktive Klausel einzuleiten.";Buchstaben als Beispiele: "Die LUN-Adresse muss mit dem Buchstaben Lbeginnen.").

v Im Text neu eingeführte Termini (außer in Definitionslisten): "Als Sichtwird ein Rahmen innerhalb des Arbeitsbereichs bezeichnet, der Datenenthält.".

v Variablen und Werte, die vom Benutzer angegeben werden müssen: "...hierbei steht mein_name für ....".

Monospaceschrift

v Codeelemente und andere Beispiele.v Dateinamen, Schlüsselwörter für die Programmierung und andere Ele-

mente, die schwierig vom umliegenden Text zu unterscheiden sind.v Texte von Nachrichten und Systemanfragen, die für den Benutzer be-

stimmt sind.v Vom Benutzer einzugebender Text.v Werte für Argumente oder Befehlsoptionen.

Inhalt des Handbuchs xi

xii IBM Tivoli Netcool/OMNIbus: Web GUI Administration API (WAAPI) Benutzerhandbuch

Kapitel 1. Web GUI Administration API (WAAPI)

Die folgende Einführung gibt einen Überblick über WAAPI und die Kommunikati-on von WAAPI mit dem Web-GUI-Server. Darüber hinaus finden Sie Informationenzu den von WAAPI bereitgestellten Sicherheitsmechanismen.

Informationen zu WAAPIWAAPI ist eine XML-basierte API (Anwendungsprogrammierschnittstelle), die eineferne oder lokale Verwaltung des Web-GUI-Servers ermöglicht.

WAAPI ermöglicht die Verwaltung des Servers, ohne die grafische Benutzerschnitt-stelle der Web-GUI selbst verwenden zu müssen. WAAPI ist insbesondere für dieAusführung von Massenaktualisierungen von Informationen nützlich, die bei Ver-wendung der interaktiven Funktionen viel Zeit beanspruchen würden. Das Hinzu-fügen von Filtern oder das Ändern einer Reihe von Filtern kann mit WAAPI bei-spielsweise effizienter als mit den interaktiven Funktionen der Web-GUIbewerkstelligt werden.

Die Schnittstelle wird mit dem Web-GUI-Server installiert und ermöglicht die Ver-waltung direkt vom Server aus. Sie können außerdem den WAAPI-Client auf ei-nem fernen Server installieren und die Web-GUI von dort aus verwalten.

Typen von Anforderungen

Ein Verwaltungsbefehl über WAAPI wird als Anforderung bezeichnet. WAAPI er-möglicht Ihnen die Verwaltung vieler der Funktionen, die über die interaktiveSchnittstelle zur Verfügung gestellt werden. Sie können zum Beispiel Filter hinzu-fügen, ändern und löschen.

Darüber hinaus gibt es einige Funktionen, die nur über WAAPI für spezialisierteVerwaltungstasks verfügbar sind. Sie können zum Beispiel alle Filter und Sichtendes Systems erneut laden.

WAAPI gruppiert alle verfügbaren Anforderungen in die folgenden Typen:v Benutzer

Mit Anforderungen dieses Typs können Sie die Merkmale einer beliebigen An-zahl von Benutzern ändern, eine Liste der Benutzer abrufen und die Konfigurati-onsdaten der Web-GUI von Benutzern entfernen, die keine aktiven Web-GUI-Rollen mehr haben.

v SichtenMit Anforderungen dieses Typs können Sie Sichten erstellen, ändern, löschenund auflisten.

v MapsMit Anforderungen dieses Typs können Sie Maps erstellen, ändern, löschen undauflisten. Darüber hinaus können Sie einer Map visuelle Elemente hinzufügensowie visuelle Elemente ändern und löschen.

v RessourcenRessourcen sind Grafikdateien, die Elemente enthalten, die auf einer Map ange-zeigt werden sollen. Ressourcen sind zum Beispiel Hintergrundbilder für Maps

© Copyright IBM Corp. 2011, 2015 1

und Grafiken, die als Mapobjekte verwendet werden sollen. Mit Anforderungendieses Typs können Sie Ressourcen hinzufügen, entfernen und auflisten.

v DateienMit Anforderungen dieses Typs können Sie Verzeichnisse und Dateien auf demWeb-GUI-Server hinzufügen und entfernen.

v MenüsMit Anforderungen dieses Typs können Sie Menüs für die Anzeige in Listen ak-tiver Ereignisse (LAE, engl. AEL - Active Event Lists) erstellen, ändern, löschenund auflisten.

v ToolsMit Anforderungen dieses Typs können Sie Ereignis-Management-Tools hinzufü-gen, ändern und löschen.

v EingabeaufforderungenDie Web-GUI stellt verschiedene Typen von Eingabeaufforderungen bereit, dievon Ereignis-Management-Tools zum Anfordern von Informationen vom Benut-zer verwendet werden können. Mit Anforderungen dieses Typs können Sie Ein-gabeaufforderungen hinzufügen, ändern, löschen und auflisten.

v CGI-ScriptsMit Anforderungen dieses Typs können Sie CGI-Scripts registrieren, ändern unddie Registrierung zurücknehmen.

v FilterMit Anforderungen dieses Typs können Sie Filter hinzufügen, ändern, löschenund auflisten. Darüber hinaus können Sie die Standardsicht für einen Filter fest-legen.

v FilterobjektgruppenMit Anforderungen dieses Typs können Sie Filterobjektgruppen hinzufügen, än-dern, löschen und auflisten. Darüber hinaus können Sie Filter einer Filterobjekt-gruppe hinzufügen und aus einer Filterobjektgruppe entfernen.

v Messwerte (Messanzeigen)Mit Anforderungen dieses Typs können Sie Messwerte erstellen, ändern, löschenund auflisten, die von der Web-GUI in Form von Messanzeigen dargestellt wer-den.

v BeziehungenMit Anforderungen dieses Typs können Sie Ereignisbeziehungen erstellen, än-dern, löschen und auflisten.

v SonstigeVerschiedene Anforderungen, die sich in keine andere Kategorie einordnen las-sen:– Web-GUI-Cache mit dem ObjectServer resynchronisieren– Knoten aus einem Lastausgleichscluster entfernen– Systemstatusbericht generieren– Alle Filter und Sichten erneut laden

2 IBM Tivoli Netcool/OMNIbus: Web GUI Administration API (WAAPI) Benutzerhandbuch

Prozeduren zum Ändern der Web-GUI im VergleichFür die meisten Web-GUI-Komponenten, die Sie in Dashboard Application ServicesHub ändern können, ist eine entsprechende XML-Konfigurationsanweisung in derDTD vorhanden.

In den folgenden Beispielen werden die vergleichenden Prozeduren zum Änderneiner Feldsicht in einer Liste aktiver Ereignisse (LAE) beschrieben.

Web-GUI-Prozedur

In der folgenden Beispielprozedur wird beschrieben, wie eine Feldsicht in einerLAE über die Web-GUI in Dashboard Application Services Hub geändert wird:1. Klicken Sie auf Administration > Ereignis-Management-Tools > Sichten.2. Wählen Sie in der Liste Sichten die Sicht aus, die geändert werden soll.3. Wählen Sie in der Liste Verfügbare Felder das Feld aus, das geändert werden

soll.4. Ändern Sie die Ausrichtungswerte für 'Titel' und 'Daten' in Links.5. Geben Sie für die Spaltenbreite 12 an.6. Klicken Sie auf Speichern.

Entsprechende WAAPI-Prozedur

In der folgenden Beispielprozedur wird beschrieben, wie eine Feldsicht in einerLAE über den WAAPI-Client geändert wird:1. Erstellen Sie eine mit den Regeln der WAAPI-DTD konforme XML-Befehlsdatei.

Beispiel:<methodCall>

<method methodName="view.modifyView"><view viewName="myview" acl="*"><columns><visualEntry fieldName="myfield"fieldTitle="myfieldtitle"dataJustify="left"titleJustify="left"columnWidth="12"/>

</columns></view></method>

</methodCall>

2. Starten Sie den WAAPI-Client und senden Sie die Befehlsdatei an den Web-GUI-Server.

Kommunikation zwischen dem WAAPI-Client und dem Web-GUI-ServerIm folgenden Abschnitt wird erläutert, wie der WAAPI-Client mit dem Web-GUI-Server kommuniziert.

Merkmale des Kommunikationsverfahrens

Die Kommunikation zwischen dem WAAPI-Client und dem Web-GUI-Server hatdie folgenden Merkmale:v Sie arbeitet mit einem Anforderung/Antwort-Modell (Request/Response).v Sie ist synchron.v Anforderungen werden im XML-Format gesendet.

Kapitel 1. Web GUI Administration API (WAAPI) 3

v Antworten werden im Textformat gesendet.v Sie verwendet eine HTTP- oder HTTPS-Verbindung zwischen dem Client und

dem Server.

Übersicht über die Kommunikation

Die Kommunikation des WAAPI-Clients mit dem Server erfolgt unabhängig davon,ob Sie den mit dem Web-GUI-Server installierten WAAPI-Client oder die ferne Ins-tallation des Clients verwenden, immer auf dieselbe Weise:1. Der Administrator erstellt eine oder mehrere Anforderungen in einer oder meh-

reren XML-Dateien.2. Der Administrator führt den WAAPI-Client aus und führt ihm die XML-Datei-

en zu.3. WAAPI sendet die Dateien über eine HTTP-Verbindung an den Server.

Diese Verbindung kann SSL verwenden und kann eine Verschlüsselung nutzen,um die Sicherheit der Daten besser zu schützen.

4. Der Server empfängt die Anforderungen und führt sie aus.5. Der Server gibt alle durch die Anforderungen erstellten Ausgaben über dieselbe

HTTP-Verbindung an den Client zurück.6. Der WAAPI-Client empfängt die Ausgaben. Wie er die Ausgaben verarbeitet,

hängt davon ab, ob der Administrator eine zu verwendende Ausgabedatei beimSenden der Anforderungen angegeben hat.Wenn der Administrator eine Ausgabedatei angegeben hat, sendet WAAPI dieAusgabe in diese Datei, wobei diese bei Bedarf erstellt wird. Andernfalls sendetWAAPI die Ausgabe an die Anzeige, in der der Administrator den Client aus-geführt hat.

SicherheitDer WAAPI-Client verfügt über eine Reihe von Sicherheitsfunktionen, die dazubeitragen, die Integrität der Daten zu schützen, die er mit dem Web-GUI-Clientaustauscht.

WAAPI bietet drei Möglichkeiten für den Schutz der Daten, die WAAPI mit demServer austauscht:v Schützen der Verbindung zum Serverv Kennwortverschlüsselungv Schützen der WAAPI-Merkmaldatei

Verbindungen zum Web-GUI-Server schützen

Anstelle einer ungeschützten HTTP-Verbindung können Sie eine sichere Verbin-dung mit dem Web-GUI-Server unter Verwendung von SSL einrichten. Sie könnendiese Verbindung auf eine beliebige der folgenden Arten einrichten:v Nur-Server-Authentifizierung ohne FIPS 140-2v Client/Server-Authentifizierung ohne FIPS 140-2v Nur-Server-Authentifizierung mit FIPS 140-2v Client/Server-Authentifizierung mit FIPS 140-2


NIST-Verschlüsselung SP800-131a aktivieren

Sie können die Web-GUI so konfigurieren, dass sie den NIST-SicherheitsstandardSP800-131a (NIST, National Institute of Standards and Technology) unterstützt. DerStandard SP800-131a erfordert längere Schlüssellängen und stärkere Verschlüsse-lungsverfahren als andere Standards wie zum Beispiel FIPS 140-2. SP800-131a er-fordert Transport Layer Security (TLS) V1.2.

Sie können SP800-131a in zwei Modi ausführen: Übergangsmodus (Transition) undstrikter Modus (Strict). Verwenden Sie den Übergangsmodus für einen stufenwei-sen Übergang zur strikten Durchsetzung des Standards SP800-131a. Der Über-gangsmodus lässt die Verwendung schwächerer Schlüssel und Algorithmen als derModus der strikten Durchsetzung zu. Der Übergangsmodus ermöglicht außerdemdie Verwendung von TLS V1.0 und V1.1. Daher ist der Übergangsmodus gut fürein Upgrade der Sicherheitseinstellungen von FIPS 140-2 geeignet, da Sie vorhan-dene, mit FIPS 140-2 konforme Zertifikate weiter verwenden können.

Kennwortverschlüsselung

Unabhängig von einer sichereren Verbindung, die Sie vielleicht verwenden, stelltWAAPI die Mittel zur Verschlüsselung der von WAAPI verwendeten Kennwörterbereit. Eine ungeschützte HTTP-Verbindung kann die AES-Kennwortverschlüsse-lung nutzen. Bei Verwendung einer sicheren Verbindung können Sie die AES-Ver-schlüsselung oder die FIPS 140-2-Verschlüsselung angeben. Wenn die Verbindungmit FIPS 140-2 arbeitet, ist nur die FIPS 140-2-Kennwortverschlüsselung verfügbar.

Schützen der WAAPI-Merkmaldatei

Die WAAPI-Merkmaldatei (waapi.init) enthält eine Reihe sensibler Datenelemente.Sie enthält zum Beispiel den Benutzernamen und das Kennwort des Benutzers mitAdministratorrechten auf dem Server, der WAAPI-Anforderungen ausführt. Es istwichtig, dass diese Daten vor nicht berechtigten Benutzern ferngehalten werdenund nur Administratoren zugänglich sind. Sie können daher die Zugriffssteue-rungsmechanismen des Betriebssystems verwenden, um den Zugriff auf die Dateizu beschränken.Zugehörige Verweise:Anhang C, „WAAPI-Sicherheit”, auf Seite 115WAAPI verfügt über eine Reihe von Sicherheitsfunktionen, die helfen, eine sichereKommunikation mit dem Web-GUI-Server zu gewährleisten.

Kapitel 1. Web GUI Administration API (WAAPI) 5


Kapitel 2. WAAPI verwenden

Im Folgenden wird erläutert, wie die WAAPI-Merkmaldatei für Ihre Umgebungeingerichtet und der WAAPI-Client zum Senden von Anforderungen an den Web-GUI-Server verwendet wird.

WAAPI-Merkmaldatei einrichtenVerwenden Sie die WAAPI-Merkmaldatei (waapi.init) zur Anpassung an IhreUmgebung.

Vorgehensweise

Legen Sie die Merkmale in der WAAPI-Initialisierungsdatei für Ihre Umgebung ge-eignet fest. Legen Sie Werte für die Merkmale fest, deren Wert sich nur selten än-dert, wie zum Beispiel:v waapi.host

v waapi.port

v waapi.user

v waapi.password

v Merkmale der sicheren Verbindung und der Verschlüsselung

Dadurch verringert sich die Anzahl der Optionen, die Sie in die Befehlszeile einge-ben müssen.

Anmerkung: Wenn Sie die Merkmale waapi.user und waapi.password festlegen,stellen Sie sicher, dass die Merkmaldatei vor Zugriff durch andere Personen als be-rechtigte Administratoren geschützt wird.Wenn Sie mehrere Web-GUI-Server von einer Position aus verwalten, können Siemehrere Merkmaldateien, d. h. eine pro Server, haben. Dadurch können Sie dieMerkmale für jeden Server individuell anpassen.Sie können die Merkmaldatei auch zum Speichern von Standardwerten für Merk-male verwenden. In diesem Fall können Sie jede Merkmaleinstellung durch eineBefehlszeilenoption überschreiben.Zugehörige Verweise:Anhang A, „WAAPI-Merkmale und Befehlszeilenoptionen”, auf Seite 109Dieser Abschnitt enthält Informationen zu den Merkmalen und Befehlszeilenoptio-nen des WAAPI-Clients.

WAAPI-Anforderungen an den Server sendenZum Senden von Anforderungen an den Web-GUI-Server bereiten Sie die WAAPI-Befehlsdatei vor, die die Anforderungen enthält, und führen den WAAPI-Clientaus, um sie an den Server zu senden.

Vorgehensweise1. Gehen Sie wie folgt vor, um die WAAPI-Befehlsdatei vorzubereiten:

a. Erstellen Sie eine UTF-8-Textdatei (UTF, Unicode Transformation Format)mit dem Suffix .xml.

b. Fügen Sie die Anforderungen in die Datei ein.


Tipp: Verwenden Sie die WAAPI-Beispieldateien, die mit dem Client bereit-gestellt werden, als Schablonen für Ihre Befehlsdatei.

c. Speichern Sie die Datei im UTF-8-Format in einem geeigneten Verzeichnis.2. Gehen Sie wie folgt vor, um den Client auszuführen und Ihre Datei an den Ser-

ver zu senden:a. Geben Sie abhängig vom verwendeten Betriebssystem den folgenden Befehl

ein:

v UNIX Linux WEBGUI_HOME/waapi/bin/runwaapi Optionen -fileWAAPI-Befehlsdatei

v Windows WEBGUI_HOME\waapi\bin\runwaapi.cmd Optionen -fileWAAPI-Befehlsdatei

Ersetzen Sie die folgenden Angaben:

WEBGUI_HOMEDurch das Installationsverzeichnis der Web-GUI. Wenn Sie den Clientauf einem fernen System ausführen, geben Sie die Position an, an derder Client installiert ist.

OptionenDurch alle weiteren Befehlszeilenoptionen, die Sie benötigen. Häufigverwendete Optionen werden in der folgenden Tabelle beschrieben.

Tabelle 2. Häufig verwendete WAAPI-Befehlszeilenoptionen

Funktion Option

Ausgabe in eine Datei umleiten -outfile Dateipfad

Ersetzen Sie Dateipfad durch den Pfad derDatei, in der die Ausgabe aus der WAAPI-Befehlsdatei empfangen werden soll.

Benutzernamen und Kennwort zum Ausfüh-ren der Befehlsdatei angeben

-user Benutzername -password Kennwort

Ersetzen Sie Benutzername durch den Namendes zu verwendenden Accounts und Kenn-wort durch das Kennwort für diesen Ac-count.Anmerkung: Wenn Sie diese Optionen ver-wenden, löschen Sie die Anzeige und dasBefehlsprotokoll, um die Sicherheit derBerechtigungsnachweise zu schützen.

Alternative Merkmaldatei verwenden -props Merkmaldatei

Ersetzen Sie Merkmaldatei durch denPfadnamen der zu verwendenden WAAPI-Merkmaldatei.

WAAPI-BefehlsdateiVerwenden Sie den Namen Ihrer WAAPI-Befehlsdatei.

Beispiel für ein Windows-System:c:\ibm\netcool\omnibus_webgui\waapi\bin\runwaapi.cmd-file newFilters.xml


Kapitel 3. WAAPI-Anforderungen

Eine WAAPI-Anforderung ist ein XML-Dokument, das Anweisungen zur Verwal-tung des Web-GUI-Servers enthält.

Sie können die folgenden Elemente mithilfe von WAAPI-Anforderungen verwalten:v „Benutzeranforderungen” auf Seite 13v „Sichtanforderungen” auf Seite 22v „Mapanforderungen” auf Seite 30v „Ressourcenanforderungen” auf Seite 52v „Dateianforderungen” auf Seite 54v „Menüanforderungen” auf Seite 57v „Toolanforderungen” auf Seite 62v „Anforderungen für Eingabeaufforderungen” auf Seite 71v „CGI-Anforderungen” auf Seite 80v „Filteranforderungen” auf Seite 83v „Filterobjektgruppenanforderungen” auf Seite 90v „Messwertanforderungen” auf Seite 95v „Beziehungsanforderungen” auf Seite 102v „Sonstige Anforderungen” auf Seite 107

Anmerkung: Die Namen einiger Attribute sind lang. In den nachfolgenden Syn-taxbeschreibungen werden diese langen Namen auf zwei oder mehr Zeilen verteilt.Geben Sie jedoch in dem XML, die Sie erstellen, jeden Attributnamen jeweils in ei-ner fortlaufenden Zeichenfolge ohne Zeilenumbrüche ein.

Struktur einer WAAPI-AnforderungEine WAAPI-Anforderung ist ein XML-Dokument, das eine optionale XML-Dekla-ration, gefolgt vom Stammelement <methodCall> enthält. Eine Anforderung besitzteine Reihe weiterer Merkmale, die Sie berücksichtigen müssen.v „XML-Deklaration”v „Stammelement <methodCall>” auf Seite 10v „Grundform des Stammelements” auf Seite 10v „Stammelement für Tool-, Eingabeaufforderungs-, Messwert- und

Beziehungsanforderungen” auf Seite 10v „Inhalt des Stammelements” auf Seite 10

XML-Deklaration

Sie haben die Option, eine WAAPI-Anforderung mit einer XML-Deklaration zu be-ginnen. Für dieses Release der Web-GUI sieht die Deklaration wie folgt aus:<?xml version="1.0" encoding="UTF-8" ?>


Stammelement <methodCall>

Das Stammelement enthält den Inhalt der Anforderung. Für Tool-, Eingabeauffor-derungs- und Messwertanforderungen definiert das Stammelement außerdem ei-nen Namespace (Namensbereich).

Grundform des Stammelements

Die Grundform des Stammelements sieht wie folgt aus:<methodCall>

</methodCall>

Stammelement für Tool-, Eingabeaufforderungs-, Messwert- undBeziehungsanforderungen

Für Tool-, Eingabeaufforderungs-, Messwert- und Beziehungsanforderungen hatdas Stammelement die folgende Form:<methodCall xmlns:Typ=Namespace-URL>

</methodCall>

Dabei ist Typ der Typ der Anforderung ('tool', 'prompt', 'metric' oder 'relationship')und Namespace-URL ist die vollständig qualifizierte URL für den Namespace. Nurdie Anforderungen für Tool ('tool'), Eingabeaufforderung ('prompt') Messwert('metric') und Beziehung ('relationship') erfordern eine Namespace-URL.

Die Namespace-URLs für die Typen Tool, Eingabeaufforderung, Messwert und Be-ziehung sind in der folgenden Tabelle aufgeführt.

Tabelle 3. Namespace-URLs

Anforderungstyp Namespace-URL

Tool "http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"

Eingabeaufforderung "http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2"

Messwert "http://www.ibm.com/tivoli/netcool/webtop/metrics/7.3.1"

Beziehung "http://www.ibm.com/tivoli/netcool/webtop/relationships/7.4"

Inhalt des Stammelements

Das Stammelement enthält unabhängig von seiner Form ein oder mehrere Elemen-te <method>. Jedes dieser Elemente enthält eine Anforderung zur Bearbeitung einesElements von Web-GUI-Daten. In späteren Abschnitten werden das Format undder Inhalt des Elements <method> für jeden Typ von Daten erläutert, mit denenWAAPI arbeiten kann. Das Element <method> enthält ein Attribut methodName, dasden Typ von Datenelement und die an diesen Daten auszuführende Operation de-finiert. Das Element <method> enthält untergeordnete Elemente, die das Datenele-ment definieren.

Beispiel: Wenn das Attribut methodCall den Wert view.createView hat, enthält dasElement <method> ein oder mehrere Elemente <view>, die jeweils die Merkmale ei-ner Sicht definieren, die der Objektgruppe von Web-GUI-Sichten hinzugefügt wer-den soll.


Das Stammelement kann Methodenaufrufe für eine beliebige Kombination vonWeb-GUI-Datenelementen enthalten. Wenn das Element eine Kombination ausTool-, Eingabeaufforderungs-, Messwert- und Beziehungsanforderungen enthält,schließen Sie jedes der entsprechenden xmlns-Attribute in das Element<methodCall> ein.

Beispiel: Wenn ein Element <methodCall> Elemente <method> für Sichten, Tools undEingabeaufforderungen enthält, geben Sie das Element <methodCall> wie folgt an:<methodCall xmlns="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"xmlns="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2" >



</methodCall>

Merkmale von WAAPI-XML-DokumentenXML-Dokumente, die WAAPI-Anforderungen enthalten, besitzen eine Reihe vonMerkmalen, die zu beachten sind:v „Dokumenttypdefinition (DTD)”v „Reihenfolge von XML-Elementen”v „Groß-/Kleinschreibung” auf Seite 12v „Inhalts- und Werteinschränkungen” auf Seite 12v „Kommentare” auf Seite 12

Dokumenttypdefinition (DTD)

Jede WAAPI-Anforderung muss korrekt formatiert sein und wird vom WAAPI-Client mithilfe der Dokumenttypdefinition (DTD) validiert. Die DTD definiert ei-nen Satz von Regeln für die Elemente, die in die Anforderung eingefügt werden.

Die DTD definiert die Anweisungen, die Sie in die XML-Anforderung einfügenkönnen, und legt zum Beispiel fest, in welcher Reihenfolge die Elemente angege-ben werden müssen, welche Elemente verschachtelt werden können und welcheElemente Attribute besitzen. Die WAAPI-DTD befindet sich an der folgenden Posi-tion:

WEBGUI_HOME/waapi/etc/waapi.dtd

Reihenfolge von XML-Elementen

Im Allgemeinen ist die WAAPI-DTD in Bezug auf die Reihenfolge tolerant. Voraus-gesetzt, dass die Anforderungsdateien korrekt formatiert sind, ermöglicht Ihnen dieDTD, die meisten untergeordneten Anweisungen auszuwerten. Bei einigen Elemen-ten müssen untergeordnete Elemente jedoch in einer bestimmten Reihenfolge ange-ordnet werden.

Das Element <supermenu> ist beispielsweise ein Element, das keine feste Reihenfol-ge erfordert. Das Element <supermenu> kann drei Typen von untergeordneten Ele-menten enthalten: <tool>, <separator> und <menu>. Diese Elemente können in derElementhierarchie von <supermenu> in beliebiger Reihenfolge angeordnet sein. DieReihenfolge, in der diese Elemente angeordnet werden, wird in der Darstellungdes LAE-Toolmenüs wiedergegeben, das durch diese Anweisungen erstellt wird.

Die untergeordneten Elemente der Elemente <method> und <view> müssen im Un-terschied dazu jedoch in der richtigen Reihenfolge angegeben werden. In der fol-

Kapitel 3. WAAPI-Anforderungen 11

genden Tabelle wird die Reihenfolge definiert, in der untergeordnete Elemente fürdie Elemente <method> und <view> angegeben werden müssen.

Tabelle 4. Reihenfolge der untergeordneten Elemente

Element Reihenfolge der untergeordneten Elemente

method 1. user

2. view

3. filter

4. map

5. resources

6. supermenu

7. tools

8. cgi

9. file

10. tool:tool

11. prompt:prompt

12. filterCollection

13. metric:metric

14. relationship:relationship

view 1. columns

2. sorting

Groß-/Kleinschreibung

In XML-Dokumenten wird bei Element- und Attributnamen die Groß-/Kleinschreibung unterschieden. Verwenden Sie dieselbe Schreibweise wie in denMethodendefinitionen. Darüber hinaus wird beim Inhalt einiger Elemente sowiebeim Wert einiger Attribute ebenfalls die Groß-/Kleinschreibung unterschieden.Die Beschreibungen von Elementinhalten und Attributwerten in den Methodende-finitionen enthalten Informationen zur Groß-/Kleinschreibung. Achten Sie insbe-sondere darauf, dass Sie Aufzählungswerte genau wie in der Methodendefinitionangeben.

Inhalts- und Werteinschränkungen

Der Inhalt einiger Elemente und die Werte einiger Attribute unterliegen Einschrän-kungen. Es kann zum Beispiel die Anzahl der Zeichen begrenzt sein, die ein Attri-butwert haben kann. Die Beschreibung der Elemente und Attribute in jeder Metho-dendefinition gibt die gültigen Inhaltseinschränkungen an.

Kommentare

Sie können Kommentare in die WAAPI-Anforderung in der XML-Standardsyntaxeinfügen. Beginnen Sie einen Kommentar mit der Syntax  ab. Geben Sie den Kommentar zwischen derAnfangs- und der Endsyntax an. Ein Kommentar kann eine einzelne Zeile odermehrere Zeilen umfassen.

Beispiel:






BeispielanforderungenMit der Web-GUI wird eine breite Auswahl an Beispielanforderungen bereitgestellt.

Die Installation des Web-GUI-Servers umfasst einen Satz von Beispielanforderun-gen. Diese können Sie als Modelle für Ihre Anforderungen verwenden. Die Beispie-le befinden sich im folgenden Verzeichnis:

WEBGUI_HOME/waapi/etc/samples

Hierbei ist WEBGUI_HOME das Installationsverzeichnis der Web-GUI. Beispiel:ibm/tivoli/netcool/omnibus_webgui.

BenutzeranforderungenBenutzeranforderungen dienen zur Bearbeitung von Web-GUI-Benutzern. Es gibtFunktionen zum Ändern eines Benutzers, zum Abrufen einer Liste von Benutzernund zum Entfernen von Konfigurationsinformationen für Benutzer, die keine Be-nutzerberechtigungen für die Web-GUI mehr haben. WAAPI stellt drei Methodenfür die Arbeit mit Benutzern bereit, die im System definiert sind: Benutzer verwal-ten, Benutzer ändern und Liste von Benutzern abrufen.

Benutzer verwaltenDas Element <method> zum Verwalten von Benutzern hat das folgende Format:<method methodName="user.maintainUsers" />

Mit dieser Methode können Sie Konfigurationsdaten der Web-GUI von allen Benut-zern entfernen, die keine Rolle 'ncw_user' oder 'ncw_admin' mehr haben. Zu denKonfigurationsdaten gehören die folgenden Daten:v Benutzervorgabenv Filterdefinitionenv Sichtdefinitionen

Beispiel<methodCall>

<method methodName="user.maintainUsers" /></methodCall>

Benutzer ändernDas Element <method> zum Ändern eines Benutzers hat das folgende Format:<method methodName="user.modifyUser">

Mit diesem Methodenaufruf können Sie eine beliebige Anzahl der folgenden Merk-male eines Benutzers ändern:v Standardfilterv Homepagev Merkmale der Liste aktiver Ereignisse (LAE):


– Zugriff auf die LAE– Standard- und Mindestaktualisierungszeit– In der LAE anzuzeigende Elemente

Das Element <method> enthält ein oder mehrere Elemente <user>, die jeweils einenBenutzer und die zu ändernden Merkmale des Benutzers angeben. Geben Sie nurdie Attribute des Elements <user> an, die den Merkmalen entsprechen, die Sie än-dern wollen. Wenn Sie ein Attribut nicht angeben, wird das entsprechende Merk-mal nicht geändert.

<user>

Das Element <user> definiert die Merkmale eines Benutzers und hat die folgendenAttribute:

Tabelle 5. Attribute des Elements <user>

AttributnameErforderlichoder optional Beschreibung

name Erforderlich Gibt den zu ändernden Benutzer an.

Wert: Der Benutzername eines Web-GUI-Benutzers.

Standardwert: Keiner

filter Optional Definiert die Ereigniswertigkeitsstufen,die in der Liste aktiver Ereignisse (LAE)des Benutzers angezeigt werden.

Wert: Zeichenfolge


homepage Optional Die URL der Homepage des Benutzersrelativ zum Kontextstammverzeichnisder Web-GUI.

Wert: Der Name und die Position derHomepage.

Standardwert: /index.html

ael_user Optional Gibt an, ob der Benutzer auf die Listeaktiver Ereignisse (LAE) zugreifenkann.

Wert: true oder false

Standardwert: true

ael_user_properties_acknowledge_font_color

Optional Definiert die Schriftfarbe für bestätigteEreignisse.

Wert: Zeichenfolge

Standardwert: White (Weiß)

ael_user_properties_allow_select

Optional Gibt an, ob der Benutzer seine eigenenBenutzervorgaben in derZugriffssteuerungsliste (ACL) festlegenkann.


Standardwert: true


Tabelle 5. Attribute des Elements <user> (Forts.)


ael_user_properties_allow_custom_refresh

Optional Gibt an, ob der Benutzer die LAE-An-zeige aktualisieren kann. Das Attributhat einen der folgenden Werte:


Standardwert: false

ael_user_properties_refresh_time

Optional Gibt die Aktualisierungszeit (in Sekun-den) der LAE für diesen Benutzer an.

Wert: Integer

Standardwert: 60

ael_user_properties_minimum_refresh_time

Optional Gibt die minimale Aktualisierungszeit(in Sekunden) an, die der Benutzer an-geben kann. Der Wert dieses Attributsmuss kleiner-gleich dem Wert vonael_user_properties_refresh_time sein.

Wert: Integer

Standardwert: 30

ael_user_properties_show_colors

Optional Gibt an, ob Farben in der Liste aktiverEreignisse (LAE) des Benutzers verwen-det werden.


Standardwert: true

ael_user_properties_show_info Optional Gibt an, ob das Menü Alerts der LAEdie Option zum Anzeigen des FenstersInformationen einschließt.


Standardwert: true

ael_user_properties_show_journal

Optional Gibt an, ob das Fenster Informationenfür einen Alert die Registerkarte Jour-nal enthält.


Standardwert: true

ael_user_properties_show_details

Optional Gibt an, ob das Fenster Informationenfür einen Alert die Registerkarte Detailsenthält.


Standardwert: true

ael_user_properties_show_menubar

Optional Gibt an, ob das LAE-Widget eine Menü-leiste enthält.


Standardwert: false

ael_user_properties_showgraphicconversions

Optional Gibt an, ob in der LAEWertigkeitssymbole angezeigt werden.


Standardwert: false




ael_user_properties_show_preferences

Optional Gibt an, ob der Benutzer auf das Fens-ter 'Benutzervorgaben' über das LAE-Menü Bearbeiten oder das Symbol'Benutzervorgaben' in der Symbolleistezugreifen kann.


Standardwert: true

ael_user_properties_monitor_show_number

Optional Gibt an, ob die Gesamtzahl von Ereig-nissen in Monitorfeldern in der LAEangezeigt wird.


Standardwert: true

ael_user-properties_monitor_show_highest

Optional Gibt an, ob die höchste Wertigkeitsstufein Monitorfeldern in der LAE angezeigtwird.


Standardwert: true

ael_user_properties_monitor_show_highest_color

Optional Gibt an, ob die Farbe der höchstenWertigkeitsstufe in Monitorfeldern inder LAE angezeigt wird.


Standardwert: true

ael_user_properties_monitor_show_lowest

Optional Gibt an, ob die niedrigsteWertigkeitsstufe in Monitorfeldern inder LAE angezeigt wird.


Standardwert: true

ael_user_properties_monitor_show_lowest_color

Optional Gibt an, ob die Farbe der niedrigstenWertigkeitsstufe in Monitorfeldern inder LAE angezeigt wird.


Standardwert: false

ael_user_properties_monitor_show_border

Optional Gibt an, ob die Umrandung umMonitorfelder im Ereignis-Dashboardoder in einer LAE, die mit SmartPage-Befehlen in der Art eines Monitorfeldsangezeigt wird, dieselbe Farbe wie diehöchste Wertigkeitsstufe erhält, die imFeld oder in der LAE angezeigt wird.


Standardwert: true

ael_user_properties_monitor_show_metric

Optional Gibt an, ob der Messwert inMonitorfeldern in der LAE angezeigtwird.


Standardwert: true




ael_user_properties_monitor_distribution_meter

Optional Gibt den Typ von Verteilungsmessungan, die zur Darstellung von Alerts inMonitorfeldern der LAE des Benutzersverwendet werden soll.

Wert: histogram, lavalamp oder none.

Standardwert: histogram

ael_user_properties_flash_time

Optional Gibt die Blinkzeit in Millisekunden fürAlerts in der LAE an. Dieses Attribut istnur wirksam, wenn das Attribut'ael_user_properties_flash_enabled' denWert true hat.

Wert: Integer

Standardwert: 400

ael_user_properties_flash_brightness

Optional Gibt die Blinkhelligkeit von Alerts inder LAE an. Dieses Attribut ist nurwirksam, wenn das Attribut'ael_user_properties_flash_enabled' denWert true hat.

Wert: Integer

Standardwert: 0

ael_user_properties_flash_enabled

Optional Gibt an, ob nicht bestätigte Ereignisse inder LAE blinken.


Standardwert: false

ael_user_properties_show_summarybar

Optional Gibt an, ob die Zusammenfassungsleisteam Fuß der LAE angezeigt wird.


Standardwert: true

ael_user_properties_show_toolbar

Optional Gibt an, ob die Symbolleiste über derLAE angezeigt wird.


Standardwert: true

ael_user_properties_monitor_font_name

Optional Gibt den Namen für die Schriftart an,die für den Text in Monitorfeldern inder LAE verwendet werden soll.

Wert: Zeichenfolge

Standardwert: Dialog

ael_user_properties_monitor_font_size

Optional Gibt die Größe der Schriftart an, die inMonitorfeldern in der LAE verwendetwird.

Wert: Integer

Standardwert: 12




ael_user_properties_timeformat Optional Gibt das Format für das Datum und dieUhrzeit an, die in der LAE angezeigtwerden.

Wert: short, long oder ein Datums- undZeitformat.

Standardwert: short

ael_user_properties_eventlist_font_name

Optional Gibt den Namen für die Schriftart an,die in der LAE verwendet werden soll.

Wert: Zeichenfolge

Standardwert: Dialog

ael_user_properties_eventlist_font_size

Optional Gibt die Größe der Schriftart an, die inder LAE verwendet werden soll.

Wert: Integer

Standardwert: 12

ael_user_properties_eventlist_width

Optional Gibt die Gesamtbreite der LAE in Pi-xeln an.

Wert: Integer

Standardwert: 600

ael_user_properties_eventlist_height

Optional Gibt die Gesamthöhe der LAE in Pixelnan.

Wert: Integer

Standardwert: 450

ael_user_properties_notify_enabled

Optional Gibt an, ob Benachrichtigungen (z. B.Tonsignale) erfolgen, wenn Ereignisseder LAE hinzugefügt oder in der LAEgeändert werden.


Standardwert: false

ael_user_properties_notify_when_iconized

Optional Wenn der Benutzer die LAE aufSymbolgröße verkleinert hat, gibt diesesAttribut an, ob die LAE wieder ange-zeigt werden soll, wenn ein neues Er-eignis eintrifft.


Standardwert: true

ael_user_properties_notify_always

Optional Gibt an, ob der Benutzer eine Benach-richtigung über das Eintreffen eines Er-eignisses unabhängig davon empfängt,ob die LAE geöffnet, geschlossen oderauf Symbolgröße verkleinert ist.


Standardwert: true




ael_user_properties_notify_insert

Optional Gibt an, ob der Benutzer eine Benach-richtigung empfängt, wenn ein Ereignisder LAE hinzugefügt wird.


Standardwert: false

ael_user_properties_notify_delete

Optional Gibt an, ob der Benutzer eine Benach-richtigung empfängt, wenn ein Ereignisaus der LAE entfernt wird.


Standardwert: true

ael_user_properties_notify_update

Optional Gibt an, ob der Benutzer eine Benach-richtigung empfängt, wenn ein Ereignisin der LAE aktualisiert wird.


Standardwert: false

ael_user_properties_notify_play_sound

Optional Gibt an, ob eine zu verwendende Be-nachrichtigung mit der Wiedergabe ei-nes Tonsignals verbunden ist.


Standardwert: true

ael_user_properties_notify_sound_url

Optional Gibt die URL eines Tonsignals an, dasals Benachrichtigung wiedergegebenwerden soll.

Wert: Zeichenfolge


ael_user_properties_notify_flash_icon

Optional Gibt an, ob das LAE-Symbol bei einerBenachrichtigung blinkt.


Standardwert: true

ael_user_properties_notify_open_window

Optional Gibt an, ob ein Fenster bei einer Be-nachrichtigung geöffnet wird.


Standardwert: false

ael_user_properties_notify_open_url

Optional Gibt an, ob eine URL bei einer Benach-richtigung geöffnet werden soll.


Standardwert: false

ael_user_properties_notify_url Optional Gibt die URL an, die geöffnet werdensoll, wenn das Attribut'ael_user_properties_notify_open_url'den Wert true hat.

Wert: Zeichenfolge





ael_user_properties_notify_url_target

Optional Gibt das Ziel im Browser an, in demdie im Attribut 'ael_user_notify_url' an-gegebene URL geöffnet wird. WennFrames im HTML definiert wurden,können Sie das Ziel als Namen einesFrames (z. B. UpperFrame) angeben.

Wert: _blank, der Name eines Frames


ael_user_properties_monitor_num_cols

Optional Gibt die Anzahl von Spalten vonMonitorfeldapplets an, die in der LAEangezeigt werden sollen.

Wert: Integer

Standardwert: 4

ael_user_properties_allow_journal_edit

Optional Gibt an, ob der Benutzer die Journalebearbeiten kann, die der LAE zugeord-net sind.


Standardwert: true

ael_user_properties_allow_filter_builder_access

Optional Gibt an, ob der Benutzer über die LAEauf das Filtererstellungsprogramm zu-greifen kann.


Standardwert: false

ale_user_properties_allow_view_builder_access

Optional Gibt an, ob der Benutzer über die LAEauf das Sichterstellungsprogramm zu-greifen kann.


Standardwert: true

ael_user_properties_allow_views_and_filters_use

Optional Gibt an, ob der Benutzer vordefinierteFilter und Sichten in der LAE auswäh-len kann.


Standardwert: true

map_editor_user_properties_show_grid

Optional Gibt an, ob ein Gitter im Mapeditor an-gezeigt wird.


Standardwert: true

map_editor_user_properties_snap_to_grid

Optional Gibt an, ob Objekte im Mapeditor amGitter ausgerichtet werden.


Standardwert: false

map_editor_user_properties_grid_size

Optional Gibt die Größe des Rasters imMapeditor an.

Wert: Integer

Standardwert: 5




map_editor_user_properties_editor_width

Optional Gibt die Gesamtbreite desAnzeigebereichs im Mapeditor in Pixelnan.

Wert: Integer

Standardwert: 600

map_editor_user_properties_editor_height

Optional Gibt die Gesamthöhe desAnzeigebereichs im Mapeditor in Pixelnan.

Wert: Integer

Standardwert: 400

Beispiel

Im folgenden Beispiel werden der Benutzer mit dem Namen user1 geändert unddie folgenden Merkmale definiert:v Der Standardfilter zeigt alle Wertigkeitsstufen an.v Die folgenden LAE-Merkmale werden geändert:

– Die Aktualisierungszeit beträgt 90 Sekunden.– Die minimale Aktualisierungszeit beträgt 70 Sekunden.– Der Benutzer kann auf das Fenster der Benutzervorgaben der LAE zugreifen.– Der Benutzer kann keine Aktualisierung der Anzeige der LAE erzwingen.– Der Benutzer kann eigene Benutzervorgaben festlegen.– Das LAE-Fenster Informationen enthält die Registerkarten Details und Jour-

nal.– Das Menü Alerts enthält eine Option zum Öffnen des Fensters Informatio-

nen.<methodCall>

<method methodName="user.modifyUser"><user name="user1"

filter ="Severity>=0"ael_user_properties_refresh_time="90"ael_user_properties_minimum_refresh_time="70"ael_user_properties_show_preferences ="true"ael_user_properties_allow_custom_refresh = "false"ael_user_properties_allow_select = "true"ael_user_properties_show_details ="true"ael_user_properties_show_info ="false"ael_user_properties_show_journal = "true">

</user></method>

</methodCall>


Liste von Benutzern abrufenDas Element <method> zum Abrufen einer Liste von Benutzern hat das folgendeFormat:<method methodName="user.getList" />

Mit dieser Methode können Sie eine Liste der Anmeldenamen aller Benutzer abru-fen, die in der Web-GUI definiert sind und die Rolle 'ncw_user' oder 'ncw_admin'haben.

Beispiel<methodCall>

<method methodName="user.getList" /></methodCall>

SichtanforderungenSichtanforderungen dienen zur Bearbeitung von Web-GUI-Sichten. Es gibt Funktio-nen zum Erstellen, Ändern und Löschen von Sichten. Ferner können Sie eine Listeder Sichten abrufen, die auf dem Web-GUI-Server definiert sind. WAAPI stellt fünfMethoden für die Arbeit mit Sichten bereit: Sichten erstellen, Sichten erstellen oderersetzen, Sichten ändern, Sichten löschen und Sichtenliste abrufen.

Sicht erstellenDas Element <method> zum Erstellen einer Sicht hat das folgende Format:<method methodName="view.create">

Mit dieser Methode können Sie eine neue Sicht zur Verwendung in der Liste akti-ver Ereignisse (LAE), der Ereignisanzeige, der vereinfachten Ereignisliste (LEL), derTabellensicht und dem Ereignis-Dashboard erstellen. Das Element <method> enthältein oder mehrere Elemente <view>, die jeweils die Merkmale einer neuen Sicht de-finieren. Das Element <view> kann maximal jeweils eines der Elemente <columns>,<sorting> und <grouping> enthalten.v „<view>”v „<columns>” auf Seite 23v „<visualEntry>” auf Seite 23v „<sorting>” auf Seite 24v „<sortColumn>” auf Seite 24v „<grouping>” auf Seite 25v „<groupColumn” auf Seite 25v „Beispiel für eine Benutzersicht” auf Seite 26

<view>

Das Element <view> definiert eine Sicht und hat die folgenden Attribute:

Tabelle 6. Attribute des Elements <view>


viewName Erforderlich Gibt einen eindeutigen Namen für eineSicht an.

Wert: Zeichenfolge



Tabelle 6. Attribute des Elements <view> (Forts.)


datasource Optional Der Name der Datenquelle, die Ereig-nisse für die Sicht bereitstellt. Geben Siemehrere Datenquellen in einer durchKommas getrennten Liste an.

Wert: Zeichenfolge

Standardwert: NCOMS

user Optional Für Benutzersichten gibt dieses Attributdie Benutzer an, denen die Sicht zuge-ordnet wird. Der Wert des Attributs isteine durch Kommas getrennte Liste vonBenutzer-IDs.

Wert: Liste von Benutzer-IDs


type Optional Der Typ der Sicht.

Wert: global, system, group oder user

Standardwert: system

relationshipName Optional Der Name einer Ereignisbeziehung, diemit der Sicht verwendet werden soll,die auf die Ereignisanzeige angewendetwird. Eine Ereignisbeziehung organi-siert die Ereignisanzeige nach den Be-ziehungen zwischen Ereignissen. ZumBeispiel können Ereignisse nach ihrerUrsache und ihrem Symptom organi-siert werden.

Wert: Zeichenfolge


<columns>

Das Element <columns> ist ein untergeordnetes Element des Elements <view> undkann einmal oder keinmal verwendet werden. Wenn es angegeben wird, enthält eseine beliebige Anzahl von Elementen <visualEntry>.

<visualEntry>

Das Element <visualEntry> ist ein untergeordnetes Element des Elements <co-lumns>, das die Darstellung von Feldern in der Sicht definiert. Das Element hat diefolgenden Attribute:


Tabelle 7. Attribute des Elements <visualEntry>


fieldName Erforderlich Der Name eines Felds, das in die Sichteingeschlossen werden soll. Dies istanalog zu einem Eintrag aus der ListeVerfügbare Felder imSichterstellungsprogramm.

Wert: Der Name eines Felds aus einerObjectServer-Tabelle.


fieldTitle Erforderlich Der Name, der für den Spaltentitel inder Sicht für dieses Feld verwendetwerden soll.

Wert: Zeichenfolge


dataJustify Erforderlich Gibt an, wie der Text in der Spalte aus-gerichtet werden soll.

Wert: centre, left oder right

Standardwert: left

titleJustify Erforderlich Gibt an, wie der Spaltentitel ausgerich-tet werden soll.

Wert: centre, left oder right

Standardwert: left

columnWidth Erforderlich Die Breite der Spalte in Pixeln.

Wert: Integer

Standardwert: 25

columnLocked Optional Gibt an, ob die Position einer Spaltegesperrt wird oder ob der Benutzer dieReihenfolge der Spalte ändern kann.


Standardwert: false

datasource Optional Der Name der Datenquelle, die Datenfür das Feld bereitstellt.

Wert: Der Name einer Datenquelle

Standardwert: NCOMS

<sorting>

Das Element <sorting> ist ein untergeordnetes Element des Elements <view> undkann einmal oder keinmal verwendet werden. Wenn es angegeben wird, enthältdas Element eine beliebige Anzahl von Elementen <sortColumn>, die die Sortierrei-henfolge für Ereignisse in der Sicht definieren.

<sortColumn>

Das Element <sortColumn> definiert ein Feld, das zum Sortieren der Listenereignis-se in einer Sicht verwendet werden soll. Wenn mehrere Elemente <sortColumn> an-


gegeben werden, werden die Einträge in der Sicht in der Reihenfolge sortiert, inder die Elemente <sortColumn> angegeben sind.

Das Element hat die folgenden Attribute:

Tabelle 8. Attribute des Elements <sortColumn>


fieldName Erforderlich Der Name eines Felds in der Sicht.

Wert: Der Name eines Felds.


order Erforderlich Die Reihenfolge für die Sortierung derSpalteneinträge.

Wert: asc (für aufsteigende Reihenfolge)oder desc (für absteigende Reihenfolge).

Standardwert: asc

datasource Optional Der Name der Datenquelle, die das be-nannte Feld bereitstellt.

Wert: Der Name einer Datenquelle.

Standardwert: NCOMS

<grouping>

Das Element <grouping> ist ein untergeordnetes Element des Elements <view> undkann einmal oder keinmal verwendet werden. Wenn es angegeben wird, enthältdas Element eine beliebige Anzahl von Elementen <groupColumn>, die definieren,wie Ereignisse in der Ereignisanzeige gruppiert werden, wenn diese Sicht verwen-det wird.

<groupColumn

Das Element <groupColumn> definiert ein Feld, das von der Ereignisanzeige zumGruppieren der Listenereignisse in einer Sicht verwendet werden soll. Wenn meh-rere Elemente <groupColumn> angegeben werden, werden die Einträge in der Sichtin der Reihenfolge gruppiert, in der die Elemente <groupColumn> angegeben sind.

Das Element hat die folgenden Attribute:

Tabelle 9. Attribute des Elements <groupColumn>


fieldName Erforderlich Der Name eines Felds in der Sicht. Diesist analog zu einem Eintrag aus der Lis-te Verfügbare Felder imSichterstellungsprogramm.

Wert: Der Name eines Felds.


Anmerkungen:v Die WAAPI-DTD lässt eine beliebige Anzahl von Elementen <groupColumn> zu.

Die maximale Anzahl von Gruppierungsebenen, die Sie verwenden können,


wird jedoch durch das Merkmal columngrouping.maximum.columns in der Initiali-sierungsdatei der Web-GUI (server.init) festgelegt. Standardmäßig ist der Wertdieses Merkmals 3, jedoch kann der Administrator einen anderen Wert festlegen.Wenn Sie mehr Ebenen angeben, als durch dieses Merkmal definiert werden,gibt der Server einen Fehler zurück.

v Das Merkmal columngrouping.allowedcolumns in der Datei server.init definiertdie Namen der Felder, die Sie zum Gruppieren verwenden können. DiesesMerkmal hat den folgenden Standardwert:Acknowledged,AlertGroup,Class,Customer,Location,Node,NodeAlias,NmosCauseType,NmosManagedStatus,Severity,Service

Der Administrator kann diesen Wert ändern. Wenn Sie eine Spalte angeben, dienicht in der Liste für dieses Merkmal enthalten ist, gibt der Server einen Fehlerzurück.

Beispiel für eine Benutzersicht

Im folgenden Beispiel wird eine Benutzersicht mit dem Namen SeveritySummaryerstellt, die die folgenden Merkmale besitzt:v Die Sicht enthält die folgenden Felder im angegebenen Format:

Tabelle 10. Beispiel für das Erstellen einer Benutzersicht: Felder und ihre Formatierung

Feld FeldtitelAusrichtung derDaten

Ausrichtung desTitels Spaltenbreite

Severity Sev Center Center 5

Acknowledged Ack Center Center 3

Node Node Left Left 12

AlertGroup Alert Group Left Left 10

Summary Summary Left Left 40

LastOccurrence Last Occurrence Left Left 14

v Die Spalten für 'Severity' und 'Acknowledged' sind gesperrt.v Die Sicht verwendet die Standarddatenquelle.v Die Sicht sortiert Einträge in absteigender Reihenfolge nach 'Severity' (Wertig-

keit).v Die Sicht ist für die Benutzer 'ncoadmin' und 'tipadmin' verfügbar.v Die Sicht gruppiert Einträge nach 'Node' (Knoten).<methodCall><method methodName="createView"><view viewName="SeveritySummary"user="ncoadmin,tipadmin"type="user"><columns><visualEntry fieldName="Severity"fieldTitle="Sev"dataJustify="centre"titleJustify="center"columnWidth="5"columnLocked="true" /><visualEntry fieldname="Acknowledged"fieldTitle="Ack"datajustify="centre"titleJustify="center"columnWidth="3"columnLocked="true" />


<visualEntry fieldName="Node"fieldTitle="Node"dataJustify="left"titleJustify="left"columnWidth="12" /><visualEntry fieldName="AlertGroup"fieldTitle="Alert Group"dataJustify="left"titleJustify=left"columnWidth="10" /><visualEntry fieldName="Summary"fieldTitle="Summary"dataJustify="left"titleJustify="left"columnWidth="40" /><visualEntry fieldName="LastOccurrence"fieldTitle="Last Occurrence"dataJustify="left"titleJustify="left"columnWidth="14" />

</columns><sorting><sortColumn fieldName="Severity" order="desc" /></sorting><grouping><groupColumn fieldName="Node" /></grouping>

</view></method></methodCall>

Sicht erstellen oder ersetzenDas Element <method> zum Erstellen oder Ersetzen einer Sicht hat das folgendeFormat:<method methodName="view.createOrReplaceView">

Mit dieser Methode können Sie eine vorhandene Sicht ersetzen oder eine neueSicht erstellen, wenn sie noch nicht vorhanden ist. Das Element <method> enthältein oder mehrere Elemente <view>, die jeweils die Merkmale einer Sicht definieren.Jedes Element <view> kann maximal ein Element <columns>, maximal ein Element<sorting> und maximal ein Element <grouping> enthalten. Wenn es angegebenwird, enthält das Element <columns> eine beliebige Anzahl von Elementen<visualEntry> und jedes Element <sorting>, sofern vorhanden, enthält eine belie-bige Anzahl von Elementen <sortColumn>. Wenn vorhanden, kann das Element<grouping> eine beliebige Anzahl von Elementen <groupColumn> enthalten.

Weitere Informationen zum Element <view> und den zugehörigen Unterelementenfinden Sie in „<view>” auf Seite 22.

Im folgenden Beispiel wird eine Sicht mit dem Namen OccurrenceSummary erstelltoder ersetzt, die das letzte Vorkommen von Alerts zusammenfasst. Sie enthält vierSpalten: Severity, Node, Summary und LastOccurrence. Diese Spalten werden inderselben Weise wie die entsprechenden Spalten in dem Beispiel zum Erstellen ei-ner Sicht formatiert.<methodCall><method methodName="view.createOrReplaceView"><view viewName="OccurrenceSummary"user="ncoadmin,tipadmin"type="user"><columns><visualEntry fieldName="Severity"


fieldTitle="Sev"dataJustify="centre"titleJustify="center"columnWidth="5"columnLocked="true" /><visualEntry fieldName="Node"fieldTitle="Node"dataJustify="left"titleJustify="left"columnWidth="12" /><visualEntry fieldName="Summary"fieldTitle="Summary"dataJustify="left"titleJustify="left"columnWidth="40" /><visualEntry fieldName="LastOccurrence"fieldTitle="Last Occurrence"dataJustify="left"titleJustify="left"columnWidth="14" />

</columns><sorting><sortColumn fieldName="LastOccurrence" order="desc" /></sorting>

</view></method></methodCall>

Sicht ändernDas Element <method> zum Ändern einer Sicht hat das folgende Format:<method methodName="view.modifyView">

Mit dieser Methode können Sie die Merkmale einer vorhandenen Sicht ändern. Ge-ben Sie beliebige oder alle der Elemente <columns>, <sorting> und <grouping> mitden zugehörigen untergeordneten Elementen nach Bedarf an. Beispiel: Zum Än-dern der Sortiermethode für die Sicht geben Sie das Element <sorting> mit denElementen <sortColumn> an, die erforderlich sind, um die Sortiermethode zu defi-nieren.


Beispiel

Im folgenden Beispiel wird die Sicht mit dem Namen view1 durch die folgendenÄnderungen geändert:v Die Sicht enthält zwei Felder:

NodeSerial

v Die Sicht sortiert Einträge in aufsteigender Reihenfolge des Felds 'Severity'.<methodCall><method methodName="view.modifyView"><view viewName="view1"><columns><visualEntry fieldName="Node"fieldTitle="Node"dataJustify="left"titleJustify="left"columnWidth="18" /><visualEntry fieldName="Serial"


fieldTitle="Serial"dataJustify="left"titleJustify="left"columnWidth="12" />

</columns><sorting><sortColumn fieldName="Severity" order="asc" /></sorting></view></method></methodCall>

Sicht löschenDas Element <method> zum Löschen einer Sicht hat das folgende Format:<method methodName="view.delete">

Das Element <method> enthält ein oder mehrere Elemente <view>, die jeweils einezu löschende Sicht angeben. Geben Sie im Element 'view' nur das AttributviewName an.


Beispiel

Im folgenden Beispiel wird die Sicht mit dem Namen viewsample2 gelöscht.<methodCall><method methodName="view.deleteView"><view viewName="viewsample2"></view></method></methodCall>

Liste von Sichten abrufenDas Element <method> zum Abrufen einer Liste von Sichten hat das folgende For-mat:<method methodName="view.getList">

Die Methode gibt eine Liste der Namen aller Sichten zurück, die in der Web-GUIdefiniert sind. Für jeden Typ von Sicht gibt es einen separaten Abschnitt in der Lis-te.

Diese Methode gibt keine Attribute der Sichten, sondern nur die Namen zurück.

Beispiel<methodCall><method methodName="view.getList"></method></methodCall>


MapanforderungenMaps stellen eine visuelle Möglichkeit zum Anzeigen von Ereignissen und ihrerPositionen bereit. Es gibt Funktionen zum Erstellen, Ändern und Löschen vonMaps und visuellen Mapelementen. Darüber hinaus können Sie eine Liste der aufdem Server definierten Maps abrufen. WAAPI stellt Methoden für die Arbeit mitMaps bereit: Maps erstellen, Maps erstellen oder ersetzen, Maps ändern, Maps lö-schen und Liste von Maps abrufen. WAAPI stellt vier Methoden für die Arbeit mitvisuellen Mapelementen bereit: visuelle Mapelemente hinzufügen, visuelle Mapele-mente erstellen oder ersetzen, visuelle Mapelemente ändern und visuelle Mapele-mente löschen.

Map erstellenDas Element <method> zum Erstellen einer Map hat das folgende Format:<method methodName="map.createMap">

Mit dieser Methode erstellen Sie eine neue Map. Das Element <method> enthält einoder mehrere Elemente <map>, die jeweils die Merkmale einer neuen Map definie-ren. Das Element <map> enthält eine beliebige Anzahl der Elemente <text>, <but-ton>, <monitor>, <line> und <icon>.v „<map>”v „<text>” auf Seite 31v „<button>” auf Seite 34v „<monitor>” auf Seite 37v „<icon>” auf Seite 41v „<line>” auf Seite 44v „Beispiel” auf Seite 47

<map>

Das Element <map> definiert eine Map und hat die folgenden Attribute:

Tabelle 11. Attribute des Elements <map>


name Erforderlich Gibt einen eindeutigen Namen für eineMap an.

Wert: Zeichenfolge


bgImage Optional Der Pfad einer Grafik, die als Hinter-grund für die Map verwendet werdensoll.

Wert: Zeichenfolge


bgColor Optional Der Name einer Farbe, die als Hinter-grund für die Map verwendet werdensoll.

Wert: Zeichenfolge



Tabelle 11. Attribute des Elements <map> (Forts.)


h Optional Die Höhe der Map in Pixeln.

Wert: Integer


w Optional Die Breite der Map in Pixeln.

Wert: Integer


<text>

Das Element <text> ist ein untergeordnetes Element des Elements <map> und defi-niert die Merkmale einer Textbezeichnung auf einer Map. Das Element kann belie-big oft vorkommen und hat die folgenden Attribute, wenn es vorhanden ist:

Tabelle 12. Attribute des Elements <text>


filter Optional Definiert einen Filter, der dem Feld zu-geordnet werden soll.

Wert: Zeichenfolge


filterType Optional Der Typ des Filters, der im Attribut 'fil-ter' definiert wird.

Wert: global oder system


name Erforderlich Der Name der Textbezeichnung.

Wert: Zeichenfolge


label Optional Der Text, der in der Bezeichnung ange-zeigt werden soll.

Wert: Zeichenfolge


datasource Optional Der Name der Datenquelle, die der Be-zeichnung zugeordnet werden soll. Ge-ben Sie mehrere Datenquellen in einerdurch Kommas getrennten Liste an.

Wert: Zeichenfolge

Standardwert: NCOMS

x Optional Die horizontale Position der Bezeich-nung in Pixeln vom linken Rand derMap.

Wert: Integer



Tabelle 12. Attribute des Elements <text> (Forts.)


y Optional Die vertikale Position der Bezeichnungin Pixeln vom unteren Rand der Map.

Wert: Integer


translucency Optional Der Grad der Transparenz für die Be-zeichnung.

Wert: Integer zwischen 0 und 100 (ein-schließlich)


rotate Optional Der Winkel in Grad für die Rotationder Bezeichnung.



show_shadow Optional Gibt an, ob die Bezeichnung auf derMap mit einer Schattierung dargestelltwird.


Standardwert: false

font Optional Der Name der Schriftart, die für dieBezeichnung verwendet werden soll.

Wert: Zeichenfolge


size Optional Die Punktgröße der Schriftart, die fürdie Bezeichnung verwendet werdensoll.

Wert: Integer


justify Optional Definiert die Ausrichtung des Texts inder Bezeichnung.

Wert: center, left oder right


style Optional Der Textstil (z. B. bold) für die Bezeich-nung.

Wert: Zeichenfolge


color Optional Der Name der Farbe, die für den Textverwendet werden soll.

Wert: Zeichenfolge



Tabelle 12. Attribute des Elements <text> (Forts.)


action Optional Die Aktion, die erfolgt, wenn der Be-nutzer auf die Textbezeichnung klickt.

Wert: Zeichenfolge. Für das Öffnen vonEreignislisten sind die folgenden Wertemöglich:

v "Open URL" oder "go" zum Öffneneiner URL. Die URL wird durch dasAttribut 'url' angegeben.

v "Active Event List (AEL)" oder"ael" zum Öffnen einer Liste aktiverEreignisse.

v "Lightweight Event List (LEL)"zum Öffnen einer vereinfachtenEreignisliste (VEL).

v "Event Table (Table View)" zumÖffnen einer Tabellensicht.

v "Event Viewer" zum Öffnen einerEreignisanzeige.

v "Update Event List (using wires)"zum Senden eines NodeClickedOn-Ereignisses über DashboardApplication Services Hub-Verbindun-gen. Stellen Sie für diese Option si-cher, dass eine Systemverbindungoder eine angepasste Verbindung zueiner Ereignisanzeige oder einer LAE(Liste aktiver Ereignisse) konfiguriertist.


url Optional Die URL (Uniform Resource Locator),die das Aktionsziel für dieTextbezeichnung ist.

Wert: Zeichenfolge


target Optional Das Zielfenster im Browser für die Aus-gabe aus dem Wert im Attribut 'url'.Wenn das Attribut nicht angegebenwird, ersetzt die Ausgabe den Inhaltdes aktuellen Browserfensters.

Wert: Zeichenfolge

Standardwert: _blank

flash Optional Definiert, ob die Textbezeichnungblinkt.


Standardwert: false


<button>

Das Element <button> ist ein untergeordnetes Element des Elements <map> und de-finiert die Merkmale einer Schaltfläche auf einer Map. Das Element kann beliebigoft vorkommen und hat die folgenden Attribute, wenn es vorhanden ist:

Tabelle 13. Attribute des Elements <button>


filter Optional Definiert einen Filter, der derSchaltfläche zugeordnet werden soll.

Wert: Zeichenfolge





name Erforderlich Der Name der Schaltfläche.

Wert: Zeichenfolge


label Optional Der Text, der auf der Schaltfläche ange-zeigt werden soll.

Wert: Zeichenfolge


datasource Optional Der Name der Datenquelle, die derSchaltfläche zugeordnet werden soll.Geben Sie mehrere Datenquellen in ei-ner durch Kommas getrennten Liste an.

Wert: Zeichenfolge

Standardwert: NCOMS

x Optional Die horizontale Position derSchaltfläche in Pixeln vom linken Randder Map.

Wert: Integer


y Optional Die vertikale Position der Schaltflächein Pixeln vom unteren Rand der Map.

Wert: Integer


translucency Optional Der Grad der Transparenz für dieSchaltfläche.




Tabelle 13. Attribute des Elements <button> (Forts.)


show_shadow Optional Gibt an, ob die Schaltfläche auf derMap mit einer Schattierung dargestelltwird.


Standardwert: false

font Optional Der Name der Schriftart, die für dieSchaltflächenbeschriftung verwendetwerden soll.

Wert: Zeichenfolge


size Optional Die Punktgröße der Schriftart, die fürdie Schaltflächenbeschriftung verwen-det werden soll.

Wert: Integer


font_color Optional Der Name der Farbe, die für dieSchaltflächenbeschriftung verwendetwerden soll.

Wert: Zeichenfolge


style Optional Der Textstil (z. B. bold) für dieSchaltflächenbeschriftung.

Wert: Zeichenfolge


color Optional Der Name der Farbe, die für dieSchaltfläche verwendet werden soll.

Wert: Zeichenfolge





action Optional Wert: Zeichenfolge. Für das Öffnen vonEreignislisten sind die folgenden Wertemöglich:








url Optional Die URL (Uniform Resource Locator),die das Aktionsziel für die Schaltflächeist.

Wert: Zeichenfolge



Wert: Zeichenfolge


flash Optional Definiert, ob die Schaltfläche blinkt.


Standardwert: false

w Optional Die Breite der Schaltfläche in Pixeln.

Wert: Integer





h Optional Die Höhe der Schaltfläche in Pixeln.

Wert: Integer


type Optional Der Typ der Schaltfläche, z. B. einRechteck.

Wert: rectangle (Rechteck), rounded(abgerundetes Rechteck) oder ellipse(Ellipse)

Standardwert: rectangle

arc_diameter Optional Der Bogendurchmesser der Schaltflächein Grad.

Wert: Integer


transparent Optional Definiert, ob die Schaltfläche transpa-rent ist.


Standardwert: false

legend Optional Die Legende für die Schaltfläche.

Wert: Zeichenfolge


<monitor>

Das Element <monitor> ist ein untergeordnetes Element des Elements <map> unddefiniert die Merkmale eines Monitorfelds auf einer Map. Das Element kann belie-big oft vorkommen und hat die folgenden Attribute, wenn es vorhanden ist:

Tabelle 14. Attribute des Elements <monitor>


filter Optional Definiert einen Filter, der demMonitorfeld zugeordnet werden soll.

Wert: Zeichenfolge





name Erforderlich Der Name des Monitorfelds.

Wert: Zeichenfolge



Tabelle 14. Attribute des Elements <monitor> (Forts.)


label Optional Der Text, der in dem Monitorfeld ange-zeigt werden soll.

Wert: Zeichenfolge


datasource Optional Der Name der Datenquelle, die demMonitorfeld zugeordnet werden soll.Geben Sie mehrere Datenquellen in ei-ner durch Kommas getrennten Liste an.

Wert: Zeichenfolge

Standardwert: NCOMS

x Optional Die horizontale Position desMonitorfelds in Pixeln vom linken Randder Map.

Wert: Integer


y Optional Die vertikale Position des Monitorfeldsin Pixeln vom unteren Rand der Map.

Wert: Integer


translucency Optional Der Grad der Transparenz für dasMonitorfeld.



show_shadow Optional Gibt an, ob das Monitorfeld auf derMap mit einer Schattierung dargestelltwird.


Standardwert: false

font Optional Der Name der Schriftart, die für denMonitorfeldtext verwendet werden soll.

Wert: Zeichenfolge


size Optional Die Punktgröße der Schriftart, die fürden Monitorfeldtext verwendet werdensoll.

Wert: Integer


style Optional Der Textstil (z. B. bold) für denMonitorfeldtext.

Wert: Zeichenfolge





color Optional Der Name der Farbe, die für dasMonitorfeld verwendet werden soll.

Wert: Zeichenfolge


action Optional Die Aktion, die erfolgt, wenn der Be-nutzer auf das Monitorfeld klickt.









url Optional Die URL (Uniform Resource Locator),die das Aktionsziel für das Monitorfeldist.

Wert: Zeichenfolge



Wert: Zeichenfolge


flash Optional Definiert, ob das Monitorfeld blinkt.


Standardwert: false




w Optional Die Breite des Monitorfelds in Pixeln.

Wert: Integer


h Optional Die Höhe des Monitorfelds in Pixeln.

Wert: Integer


type Optional Der Typ des Monitorfelds, z. B. ein His-togramm.

Wert: lavalamp oder histogram

Standardwert: histogram

flash Optional Definiert, ob das Monitorfeld blinkt.


Standardwert: false

show_label Optional Definiert, ob eine Bezeichnung für dasMonitorfeld angezeigt wird.


Standardwert: false

show_total Optional Definiert, ob die Gesamtzahl der Alertsin dem Monitorfeld angezeigt werdensoll.


Standardwert: false

show_highest Optional Definiert, ob die höchste Wertigkeit indem Monitorfeld angezeigt werden soll.


Standardwert: false

show_lowest Optional Definiert, ob die niedrigste Wertigkeitin dem Monitorfeld angezeigt werdensoll.


Standardwert: false

show_metric Optional Definiert, ob ein Messwert in demMonitorfeld angezeigt wird.


Standardwert: false

show_highest_severity_as_border

Optional Definiert, ob die Farbe des Alerts mitder höchsten Wertigkeit, den der Filtererfasst, als Umrandung desMonitorfelds verwendet werden soll.


Standardwert: false




foreground_color Optional Der Name der Farbe, die für den Vor-dergrund des Monitorfelds verwendetwerden soll.

Wert: Zeichenfolge


background_color Optional Der Name der Farbe, die für den Hin-tergrund des Monitorfelds verwendetwerden soll.

Wert: Zeichenfolge


<icon>

Das Element <icon> ist ein untergeordnetes Element des Elements <map> und defi-niert die Merkmale eines Symbols auf einer Map. Das Element kann beliebig oftvorkommen und hat die folgenden Attribute, wenn es vorhanden ist:

Tabelle 15. Attribute des Elements <icon>


filter Optional Definiert einen Filter, der dem Symbolzugeordnet werden soll.

Wert: Zeichenfolge





name Erforderlich Der Name des Symbols.

Wert: Zeichenfolge


label Optional Der Text, der auf dem Symbol ange-zeigt werden soll.

Wert: Zeichenfolge


datasource Optional Der Name der Datenquelle, die demSymbol zugeordnet werden soll. GebenSie mehrere Datenquellen in einerdurch Kommas getrennten Liste an.

Wert: Zeichenfolge

Standardwert: NCOMS


Tabelle 15. Attribute des Elements <icon> (Forts.)


x Optional Die horizontale Position des Symbols inPixeln vom linken Rand der Map.

Wert: Integer


y Optional Die vertikale Position des Symbols inPixeln vom unteren Rand der Map.

Wert: Integer


translucency Optional Der Grad der Transparenz für das Sym-bol.



show_shadow Optional Gibt an, ob das Symbol auf der Mapmit einer Schattierung dargestellt wird.


Standardwert: false

font Optional Der Name der Schriftart, die für denSymboltext verwendet werden soll.

Wert: Zeichenfolge


font_color Optional Der Name der Farbe, die für denSymboltext verwendet werden soll.

Wert: Zeichenfolge


size Optional Die Punktgröße der Schriftart, die fürden Symboltext verwendet werden soll.

Wert: Integer


style Optional Der Textstil (z. B. bold) für denSymboltext.

Wert: Zeichenfolge


url Optional Die URL (Uniform Resource Locator),die das Aktionsziel für das Symbol ist.

Wert: Zeichenfolge





action Optional Die Aktion, die erfolgt, wenn der Be-nutzer auf das Symbol klickt.










Wert: Zeichenfolge


flash Optional Definiert, ob das Symbol blinkt.


Standardwert: false

w Optional Die Breite des Symbols in Pixeln.

Wert: Integer


h Optional Die Höhe des Symbols in Pixeln.

Wert: Integer





arc_diameter Optional Der Bogendurchmesser des Symbols inGrad.

Wert: Integer


legend Optional Die Legende für das Symbol.

Wert: Zeichenfolge


image Optional Der Name der Grafikdatei, die für dasSymbol verwendet werden soll.

Wert: Zeichenfolge


entity_status_indicator Optional Definiert das Feedbackmerkmal für dasSymbol.

Wert: Highlight Bar(Markierungsbalken), Fill Background(Füllhintergrund) oder Glow Background(Schimmernder Hintergrund).


<line>

Das Element <line> ist ein untergeordnetes Element des Elements <map> und defi-niert die Merkmale einer Linie auf der Map. Das Element kann beliebig oft vor-kommen und hat die folgenden Attribute, wenn es vorhanden ist:

Tabelle 16. Attribute des Elements <line>


filter Optional Definiert einen Filter, der der Linie zu-geordnet werden soll.

Wert: Zeichenfolge





name Erforderlich Der Name der Linie.

Wert: Zeichenfolge


label Optional Der Text, der auf der Linie angezeigtwerden soll.

Wert: Zeichenfolge



Tabelle 16. Attribute des Elements <line> (Forts.)


datasource Optional Der Name der Datenquelle, die der Li-nie zugeordnet werden soll. Geben Siemehrere Datenquellen in einer durchKommas getrennten Liste an.

Wert: Zeichenfolge

Standardwert: NCOMS

x Optional Die horizontale Position der Linie inPixeln vom linken Rand der Map.

Wert: Integer


y Optional Die vertikale Position der Linie in Pi-xeln vom unteren Rand der Map.

Wert: Integer


translucency Optional Der Grad der Transparenz für die Linie.



show_shadow Optional Gibt an, ob die Linie auf der Map miteiner Schattierung dargestellt wird.


Standardwert: false




action Optional Die Aktion, die erfolgt, wenn der Be-nutzer auf die Linie klickt.









url Optional Die URL (Uniform Resource Locator),die das Aktionsziel für die Linie ist.

Wert: Zeichenfolge



Wert: Zeichenfolge


flash Optional Definiert, ob die Linie blinkt.


Standardwert: false

thickness Optional Die Stärke der Linie in Pixeln.

Wert: Integer





x2 Optional Die horizontale Endposition der Liniein Pixeln vom linken Rand der Map.

Wert: Integer


y2 Optional Die vertikale Endposition der Linie inPixeln vom unteren Rand der Map.

Wert: Integer


color Optional Der Name der Farbe, die für die Linieverwendet werden soll.

Wert: Zeichenfolge


Beispiel

Im folgenden Beispiel wird eine Map mit dem Namen map1 erstellt, die zwei Text-bezeichnungen (label), drei Schaltflächen (button) und drei Monitorfelder (monitor)enthält.<methodCall><method methodName="map.createMap"><map name="map1"><text name="map1" label="map1" x="547" y="30" font="Helvetica" size="22"justify="center" style="bi" color="black" rotate="315" />

<text name="ael_instructions" label="Click Monitor Box for Tableview"x="550" y="141" font="Helvetica" size="10" justify="center"style="b" color="black" />

<button name="button1" label="Active Event List" x="296" y="146""Active Event List (AEL)" filter="Example_LastDay" filtertype="system"target="hidden" w="98" h="20" color="lightGray" type="rectangle"arc_diameter="20" transparent="false" legend="Label" font="Helvetica"size="11" font_color="black" show_shadow="true" />

<button name="button2" label="Active Event List" x="144" y="146"action="Active Event List (AEL)" filter="Example_Critical"

filtertype="system"target="hidden" w="98" h="20" color="lightGray" type="rectangle"arc_diameter="20" transparent="false" legend="Label" font="Helvetica"size="11" font_color="black" show_shadow="true" />

<button name="button3" label="Active Event List" x="21" y="146"action="Active Event List (AEL)" filter="Example_Unassigned"

filtertype="system"target="hidden" w="98" h="20" color="lightGray" type="rectangle"arc_diameter="20" transparent="false" legend="Label" font="Helvetica"size="11" font_color="black" show_shadow="true" />

<monitor name="lastday" label="Last Day" x="294" y="10"action="Event Table (Table View)"

target="_blank" filter="Example_LastDay" filtertype="system" w="100"h="126" type="histogram" show_label="true" show_total="true"show_highest="false" show_lowest="false" show_metric="true"foreground_color="red" background_color="lightGray" font="Helvetica"size="10" style="p" show_highest_severity_as_border="false" />


<monitor name="critical" label="Critical" x="142" y="10"action="Event Table (Table View)"

target="_blank" filter="Example_Critical" filtertype="system" w="100"h="126" type="histogram" show_label="true" show_total="true"show_highest="false" show_lowest="false" show_metric="true"foreground_color="black" background_color="lightGray" font="Helvetica"size="10" style="p" show_highest_severity_as_border="false" />

<monitor name="unassigned" label="Unassigned" x="17" y="10"action="Event Table (Table View)"

target="_blank" filter="Example_Unassigned" filtertype="system" w="100"h="126" type="histogram" show_label="true" show_total="true"show_highest="false" show_lowest="false" show_metric="true"foreground_color="black" background_color="lightGray" font="Helvetica"size="10" style="p" show_highest_severity_as_border="false" />

</map></method></methodCall>

Map erstellen oder ersetzenDas Element <method> zum Erstellen oder Ersetzen einer Map hat das folgendeFormat:<method methodName="map.createOrReplaceMap">

Mit dieser Methode können Sie eine vorhandene Map ersetzen oder eine Map er-stellen, wenn sie noch nicht vorhanden ist. Das Element <method> enthält ein odermehrere Elemente <map>, die jeweils die Merkmale einer Map definieren. Jedes Ele-ment <map> enthält eine beliebige Anzahl der Elemente <text>, <button>, <moni-tor>, <icon> und <line>. Weitere Informationen finden Sie in „<map>” auf Seite30.

In diesem Beispiel wird eine Map mit dem Namen map3 erstellt oder ersetzt, diezwei Monitorfelder und eine Textbezeichnung enthält.<methodCall>

<method methodName="map.createOrReplaceMap"><map name="map3"><text name="ael_instructions" label="Click Monitor Box for Tableview"x="550" y="141" font="Helvetica" size="10" justify="center"style="b" color="black" />

<monitor name="critical" label="Critical" x="142" y="10" action="table"target="_blank" filter="Example_Critical" filtertype="system" w="100"h="126" type="histogram" show_label="true" show_total="true"show_highest="false" show_lowest="false" show_metric="true"foreground_color="black" background_color="lightGray" font="Helvetica"size="10" style="p" show_highest_severity_as_border="false" />

<monitor name="unassigned" label="Unassigned" x="17" y="10" action="table"target="_blank" filter="Example_Unassigned" filtertype="system" w="100"h="126" type="histogram" show_label="true" show_total="true"show_highest="false" show_lowest="false" show_metric="true"foreground_color="black" background_color="lightGray" font="Helvetica"size="10" style="p" show_highest_severity_as_border="false" />

</map></method>

</methodCall>


Map löschenDas Element <method> zum Löschen einer Map hat das folgende Format:<method methodName="map.deleteMap">

Mit dieser Methode können Sie eine vorhandene Map löschen. Das Element<method> enthält ein oder mehrere Elemente <map>, die jeweils eine zu löschendeMap angeben. Geben Sie im Element <map> nur das Attribut name an. Weitere Infor-mationen finden Sie in „<map>” auf Seite 30.

Im folgenden Beispiel wird die Map mit dem Namen map2 gelöscht.<methodCall>

<method methodName="map.deleteMap"><map name="map2"></map>

</method></methodCall>

Liste von Maps abrufenDas Element <method> zum Abrufen einer Liste von Maps hat das folgende Format:<method methodName="map.getList">

Die Methode gibt eine Liste aller Maps zurück, die in der Web-GUI definiert sind.<methodCall>

<method methodName="map.getList"></method>

</methodCall>

Map ändernDas Element <method> zum Ändern einer Map hat das folgende Format:<method methodName="map.modifyMap">

Mit dieser Methode können Sie eine vorhandene Map ändern. Das Element<method> enthält ein oder mehrere Elemente <map>, die jeweils eine Map und diezu ändernden Merkmale angeben. Jedes Element <map> enthält eine beliebige An-zahl der Elemente <text>, <button>, <monitor>, <icon> und <line>. Weitere Infor-mationen finden Sie in „<map>” auf Seite 30.

Im nachfolgenden Beispiel werden folgenden Änderungen an einer Map mit demNamen map1 vorgenommen:v Die Hintergrundfarbe wird auf weiß gesetzt.v Die Breite der Map wird in 850 Pixel geändert.v Die Höhe der Map wird in 490 Pixel geändert.<methodCall>

<method methodName="map.modifyMap"><map name="map1" bgImage="" bgColor="white" w="850" h="490" ></map>



Visuelles Mapelement hinzufügenDas Element <method> zum Hinzufügen eines visuellen Elements zu einer Map hatdas folgende Format:<method methodName="map.addMapVisual">

Mit dieser Methode können Sie ein oder mehrere Objekte einer vorhandenen Maphinzufügen. Das Element <method> enthält ein oder mehrere Elemente <map>, die je-weils eine Map angeben, der neue Objekte hinzugefügt werden sollen. Jedes Ele-ment <map> enthält eine beliebige Anzahl der Elemente <text>, <button>, <moni-tor>, <icon> und <line>, die jeweils ein neues Objekt definieren, das der Maphinzugefügt werden soll. Weitere Informationen finden Sie in „<map>” auf Seite30.

Im folgenden Beispiel werden eine Textbezeichnung und ein Monitorfeld der Mapmit dem Namen map2 hinzugefügt.<methodCall><method methodName="map.addMapVisual"><map name="map2"><text name="map2" label="map2" x="147" y="30" font="Helvetica" size="22"justify="center" style="bi" color="black" />

<monitor name="lastday" label="Last Day" x="131" y="92" action="table"url="" target="_blank" filter="ExampleLastDay" filtertype="system"w="100" h="126" type="histogram" show_label="true" show_total="true"show_highest="false" show_lowest="false" show_metric="true"foreground_color="red" background_color="lightGray" font="Helvetica"size="10" style="p" show_highest_severity_as_border="false" />


Visuelles Mapelement hinzufügen oder ersetzenDas Element <method> zum Hinzufügen oder Ersetzen eines Mapobjekts hat dasfolgende Format:<method methodName="map.createOrReplaceMapVisual">

Mit dieser Methode können Sie einer Map ein neues Objekt hinzufügen oder einObjekt ersetzen, wenn es bereits vorhanden ist. Das Element <method> enthält einoder mehrere Elemente <map>, deren Inhalt geändert werden soll. Jedes Element<map> enthält eine beliebige Anzahl der Elemente <text>, <button>, <monitor>,<icon> und <line>, die jeweils ein Objekt definieren, das hinzugefügt oder ersetztwerden soll. Geben Sie im Element <map> nur das Attribut name an. Weitere Infor-mationen finden Sie in „<map>” auf Seite 30.

Im folgenden Beispiel wird ein Symbol auf der Map mit dem Namen map2 erstelltoder ersetzt.<methodCall><method methodName="map.createOrReplaceMapVisual"><map name="map2"><icon name="visual_3" label="Active Icon" x="75" y="233" action="ael"filter="Example_Critical" filtertype="system" target="hidden" w="30" h="19"type="rectangle" arc_diameter="10" legend="None" font="Helvetica"size="10" font_color="black" image="blocks.png"entity_status_indicator="Glow Background"/>



Visuelles Mapelement löschenDas Element <method> zum Löschen eines Objekts von einer Map hat das folgendeFormat:<method methodName="map.deleteMapVisual">

Mit dieser Methode können Sie ein oder mehrere Objekte aus einer Map löschen.Das Element <method> enthält ein oder mehrere Elemente <map>, die jeweils eine zuändernde Map angeben. Jedes Element <map> enthält ein oder mehrere Elemente<text>, <button>, <monitor>, <icon> oder <line>, die das zu entfernende Objektangeben. Geben Sie in allen diesen Elementen nur das Attribut name an. Weitere In-formationen finden Sie in „<map>” auf Seite 30.

Im folgenden Beispiel wird eine Textbezeichnung mit dem Namen visual_4 von ei-ner Map mit dem Namen map1 entfernt.<methodCall><method methodName="map.deleteMapVisual"><map name="map1"><text name="visual_4" /></map></method></methodCall>

Visuelles Mapelement ändernDas Element <method> zum Ändern eines Objekts auf einer Map hat das folgendeFormat:<method methodName="map.modifyMapVisual">

Mit dieser Methode können Sie die Merkmale eines Objekts auf einer Map ändern.Das Element <method> enthält ein oder mehrere Elemente <map>, die jeweils eine zuändernde Map angeben. Jedes Element <map> enthält ein oder mehrere Elemente<text>, <button>, <monitor>, <icon> und <line>, die die zu ändernden Objekte an-geben. Geben Sie im Element <map> nur das Attribut name an. Weitere Informatio-nen finden Sie in „<map>” auf Seite 30.

Im nachfolgenden Beispiel werden die folgenden Änderungen an der Textbezeich-nung einer Schaltfläche mit dem Namen visual_1 auf einer Map mit dem Namenmap1 vorgenommen:v Die Schaltfläche erhält den Text My Active Button.v Die horizontale Position der Schaltfläche wird in 230 Pixel geändert.v Die vertikale Position der Schaltfläche wird in 188 Pixel geändert.<methodCall><method methodName="map.modifyMapVisual"><map name="map1"><button name="visual_1" label="My Active Button" x="230" y="188" /></map></method></methodCall>


RessourcenanforderungenRessourcen sind Grafiken, die auf Web-GUI-Maps dargestellt werden können. Esgibt Funktionen zum Hinzufügen und Entfernen von Ressourcen sowie zum Abru-fen einer Liste der Ressourcen, die auf dem Web-GUI-Server definiert sind. WAAPIstellt vier Methoden für die Arbeit mit Mapressourcen bereit: Ressourcen hinzufü-gen, Ressourcen erstellen oder ersetzen, Ressourcen entfernen und Liste von Res-sourcen abrufen.

Ressource hinzufügenDas Element <method> zum Hinzufügen einer Ressource hat das folgende Format:<method methodName="resource.addResource">

Mit dieser Methode können Sie dem System eine Ressource hinzufügen. Das Ele-ment <method> enthält ein oder mehrere Elemente <resources>, die jeweils eineMap definieren, der die Ressource hinzugefügt werden soll. Das Element<resources> enthält ein oder mehrere Elemente <resource>, die jeweils eine Res-source angeben.

<resources>

Das Element <resources> definiert eine Gruppe von Ressourcen für eine Map undhat das folgende Attribut:

Tabelle 17. Attribute des Elements <resources>


mapName Erforderlich Der Name einer Map, der die Ressourcehinzugefügt werden soll.

Wert: Zeichenfolge


<resource>

Das Element <resource> ist ein untergeordnetes Element des Elements <resour-ces>. Das Element definiert eine Ressource für eine Map und hat das folgende At-tribut:

Tabelle 18. Attribute des Elements <resource>


name Erforderlich Der Name der Ressource, die der Maphinzugefügt werden soll.

Wert: Zeichenfolge


Beispiel

Im folgenden Beispiel wird eine Grafik mit dem Namen 'ny.gif' einer Map mit demNamen 'map1' hinzugefügt.


<methodCall><method methodName="resource.addResource"><resources mapName="map1"><resource name="ny.gif" /></resources></method></methodCall>

Ressource erstellen oder ersetzenDas Element <method> zum Erstellen oder Ersetzen einer Ressource hat das folgen-de Format:<method methodName="createOrReplaceResource">

Mit dieser Methode können Sie eine Ressource einer Map hinzufügen, wenn dieMap die Ressource nicht enthält, oder die vorhandene Instanz der Ressource aufder Map ersetzen. Das Element <method> enthält eine beliebige Anzahl von Ele-menten <resources>, die die zu ändernden Maps angeben. Weitere Informationenfinden Sie in „<resources>” auf Seite 52. Jedes Element <resources> enthält einoder mehrere Elemente <resource>, die jeweils eine hinzuzufügende oder zu erset-zende Ressource angeben. Weitere Informationen finden Sie in „<resource>” aufSeite 52.

Beispiel

Im folgenden Beispiel wird eine Grafik mit dem Namen 'ny.gif' einer Map mit demNamen 'map1' hinzugefügt oder ersetzt.<methodCall><method methodName="resource.creatOrReplaceResource"><resources mapName="map1"><resource name="ny.gif" /></resources></method></methodCall>

Ressource entfernenDas Element <method> zum Entfernen einer Ressource hat das folgende Format:<method methodName="removeResource">

Mit dieser Methode können Sie eine Ressource von einer Map entfernen. Das Ele-ment <method> enthält eine beliebige Anzahl von Elementen <resources>, die diezu ändernden Maps angeben. Weitere Informationen finden Sie in „<resources>”auf Seite 52. Jedes Element <resources> enthält ein oder mehrere Elemente <re-source>, die jeweils eine zu entfernende Ressource angeben. Weitere Informationenfinden Sie in „<resource>” auf Seite 52.

Beispiel

Im folgenden Beispiel wird die Ressource 'ny.gif' aus der Map 'map1' entfernt.<methodCall><method methodName="resource.removeResource"><resources mapName="map1"><resource name="ny.gif" /></resources></method></methodCall>


Liste von Ressourcen abrufenDas Element <method> zum Abrufen einer Liste von Ressourcen hat das folgendeFormat:<method methodName="resource.getList">

Diese Methode gibt eine Liste aller Ressourcen zurück, die auf dem Web-GUI-Ser-ver definiert sind. Sie hat keine untergeordneten Elemente. Jede Map hat einen ei-genen Abschnitt in der Liste.

Beispiel<methodCall><method methodName="resource.getList"></method></methodCall>

DateianforderungenMithilfe von Dateianforderungen können Sie mit Dateien und Verzeichnissen aufdem Web-GUI-Server arbeiten. Sie können Dateien und Verzeichnisse erstellen undlöschen. WAAPI stellt sechs Methoden für die Arbeit mit Dateien bereit: Verzeich-nisse hinzufügen, Dateien hinzufügen, Dateien erstellen oder ersetzen, Datei lö-schen, Verzeichnisse löschen und Verzeichnisse rekursiv löschen.

Verzeichnis hinzufügenDas Element <method> zum Hinzufügen eines Verzeichnisses auf dem Web-GUI-Server hat das folgende Format:<method methodName="file.addDir">

Mit dieser Methode können Sie ein neues Verzeichnis auf dem Web-GUI-Server er-stellen. Das Element <method> enthält ein oder mehrere Elemente <file>, die je-weils ein zu erstellendes Verzeichnis auf dem System definieren. In jedem Element<file> geben Sie das Attribut dirName an, um das zu erstellende Verzeichnis zu de-finieren.v „<file>”v „Beispiel” auf Seite 55

<file>

Das Element <file> definiert die Merkmale einer Datei oder eines Verzeichnisses,mit der bzw. dem gearbeitet werden soll. Das Element hat die folgenden Attribute:

Tabelle 19. Attribute des Elements <file>


fileName Optional Der Name einer Datei, mit der gearbei-tet werden soll.

Wert: Zeichenfolge


dirName Optional Die Angabe eines Verzeichnisses, mitdem gearbeitet werden soll.

Wert: Zeichenfolge



Tabelle 19. Attribute des Elements <file> (Forts.)


toDir Optional Das Zielverzeichnis für einen Befehl.

Wert: Zeichenfolge


fromDir Optional Das Quellenverzeichnis für einen Be-fehl.

Wert: Zeichenfolge


Beispiel

Im folgenden Beispiel wird ein Verzeichnis mit dem Namen data auf dem Lauf-werk C: eines Windows-Systems erstellt.<methodCall><method methodName="file.addDir"><file dirName="C:\data"></file></method></methodCall

Datei hinzufügenDas Element <method> zum Hinzufügen einer Datei auf dem Web-GUI-Server hatdas folgende Format:<method methodName="file.addFile">

Mit dieser Methode können Sie eine Datei auf dem Web-GUI-Server erstellen. DasElement <method> enthält ein oder mehrere Elemente <file>, die jeweils den Na-men und die Position einer zu erstellenden Datei definieren. Der Inhalt des Ele-ments <file> wird zum Inhalt der neuen Datei. Weitere Informationen finden Siein „<file>” auf Seite 54.

Beispiel

Im folgenden Beispiel wird eine Datei mit dem Namen data.txt im VerzeichnisC:\data\ auf einem Windows-System erstellt.<methodCall><method methodName="file.addFile"><file fileName="data.txt" toDir="C:\data"></file></method></methodCall>


Datei erstellen oder ersetzenDas Element <method> zum Erstellen oder Ersetzen einer Datei hat das folgendeFormat:<method methodName="file.createOrReplaceFile">

Mit dieser Methode können Sie eine vorhandene Datei mit demselben Namen er-setzen oder die Datei erstellen, wenn sie nicht vorhanden ist. Das Element<method> enthält ein oder mehrere Elemente <file>, die jeweils eine zu erstellendeoder zu ersetzende Datei angeben. Der Inhalt des Elements <file> wird zum In-halt der neuen Datei. Weitere Informationen finden Sie in „<file>” auf Seite 54.

Beispiel

Im folgenden Beispiel wird eine Datei mit dem Namen hello.txt im VerzeichnisC:\data erstellt oder ersetzt und als Inhalt der Datei der Text "Hello world" festge-legt.<methodCall><method methodName="file.createOrReplaceFile"><file fileName="hello.txt" toDir="C:\data"></file></method><methodCall>

Datei löschenDas Element <method> zum Löschen einer Datei hat das folgende Format:<method methodName="file.deleteFile">

Mit dieser Methode können Sie eine Datei vom Web-GUI-Server löschen. Das Ele-ment <method> enthält ein oder mehrere Elemente <file>, die jeweils den Namenund die Position einer zu löschenden Datei definieren. Weitere Informationen fin-den Sie in „<file>” auf Seite 54.

Beispiel

Im folgenden Beispiel wird die Datei hello.txt aus dem Verzeichnis C:\data ge-löscht.<methodCall><method methodName="file.deleteFile"><file fileName="hello.txt" fromDir="C:\data"></file></method></methodCall>

Verzeichnis entfernenDas Element <method> zum Entfernen eines Verzeichnisses hat das folgende For-mat:<method methodName="deleteDir">

Mit dieser Methode können Sie ein Verzeichnis vom Web-GUI-Server entfernen.Das Element <method> enthält ein oder mehrere Elemente <file>, die jeweils ein zuentfernendes Verzeichnis definieren. Die angegebenen Verzeichnisse müssen leersein. Weitere Informationen finden Sie in „<file>” auf Seite 54.


Beispiel

Im folgenden Beispiel wird das Verzeichnis mit dem Namen C:\test entfernt.<methodCall><method methodName="deleteDir"><file dirName="test"></file></method></methodCall>

Verzeichnis rekursiv entfernenDas Element <method> zum rekursiven Entfernen eines Verzeichnisses hat das fol-gende Format:<method methodName="file.recurseRemove">

Mit dieser Methode können Sie ein Verzeichnis und alle darin befindlichen Inhalteentfernen. Diese Methode ist nützlich, um Verzeichnisstrukturen zu löschen. DasElement <method> enthält ein oder mehrere Elemente <file>, die jeweils ein Ver-zeichnis definieren, das mit allen Inhalten gelöscht werden soll. Weitere Informatio-nen finden Sie in „<file>” auf Seite 54.

Beispiel

Im folgenden Beispiel wird das Verzeichnis mit dem Namen C:\data rekursiv ge-löscht.<methodCall><method methodName="recurseRemove"><file dirName="C:\data"></file></method></methodCall>

MenüanforderungenMenüs ermöglichen Benutzern den Zugriff auf Funktionen der Web-GUI. Es gibtFunktionen zum Erstellen, Ändern und Löschen von Menüs. Sie können außerdemeine Liste aller Menüs auf dem System abrufen. WAAPI stellt fünf Methoden fürdie Arbeit mit Menüs bereit: Menü erstellen, Menü erstellen oder ersetzen, Menüändern, Menü löschen und Liste von Menüs abrufen.

Menü erstellenDas Element <method> zum Erstellen eines Menüs hat das folgende Format:<method methodName="menu.createMenu">

Mit dieser Methode erstellen Sie ein neues Menü, das Tools, Untermenüs undTrennlinien enthalten kann. Das Element <method> enthält ein oder mehrere Ele-mente <supermenu>. Jedes Element <supermenu> enthält eine beliebige Anzahl vonElementen <separator>, <menu> und <tool>, die den Inhalt des Menüs definieren.v „<supermenu>” auf Seite 58

– „<separator>” auf Seite 58– „<menu>” auf Seite 58– „<tool>” auf Seite 59

v „Beispiel” auf Seite 59


<supermenu>

Das Element <supermenu> ist der Container für ein Menü und hat die folgendenAttribute:

Tabelle 20. Attribute des Elements <supermenu>


name Erforderlich Gibt einen eindeutigen Namen für einMenü an.

Wert: Zeichenfolge


label Optional Der Titel des Menüs, wie er in der Listeaktiver Ereignisse (LAE) angezeigtwird.

Wert: Zeichenfolge

Standardwert: Der Wert des Attributs'name'.

mnemonic Optional Ein einzelnes Zeichen, über das der Be-nutzer das Menü durch Drücken derTaste Alt und der entsprechendenZeichentaste auswählen kann.

Wert: Ein einzelner Buchstabe.


<separator>

Das Element <separator> ist ein untergeordnetes Element des Elements<supermenu> und definiert die Position einer Trennlinie in einem Menü. Es kannbeliebig oft verwendet werden. Das Element hat keinen Inhalt und keine Attribute.

<menu>

Das Element <menu> ist ein untergeordnetes Element des Elements <supermenu>und definiert die Position eines Untermenüs. Das Element kann beliebig oft vor-kommen und hat die folgenden Attribute:

Tabelle 21. Attribute des Elements <menu>


name Erforderlich Gibt einen eindeutigen Namen für einMenü an.

Wert: Zeichenfolge


label Erforderlich Der Titel des Menüs, wie er in der Listeaktiver Ereignisse (LAE) angezeigtwird.

Wert: Zeichenfolge



Tabelle 21. Attribute des Elements <menu> (Forts.)


mnemonic Optional Ein einzelnes Zeichen, über das der Be-nutzer das Menü durch Drücken derTaste Alt und der entsprechendenZeichentaste auswählen kann.



<tool>

Das Element <tool> ist ein untergeordnetes Element des Elements <supermenu>und definiert ein Tool, das als Option im Menü angezeigt werden soll. Das Ele-ment kann beliebig oft verwendet werden und hat die folgenden Attribute:

Tabelle 22. Attribute des Elements <tool>


name Erforderlich Gibt einen eindeutigen Namen für einTool an.

Wert: Zeichenfolge


label Erforderlich Der Titel des Tools, wie er im Menü derListe aktiver Ereignisse (LAE) angezeigtwird.

Wert: Zeichenfolge


mnemonic Optional Ein einzelnes Zeichen, über das der Be-nutzer das Menü mit dem Tool durchDrücken der Taste Alt und der entspre-chenden Zeichentaste auswählen kann.



shortcut Optional Ein einzelnes Zeichen, über das der Be-nutzer das Tool durch Drücken der Tas-te Strg und der entsprechendenZeichentaste auswählen kann.



Beispiel

Im folgenden Beispiel werden leere Menüs mit den Namen menu1 und toolMenu1erstellt, denen durch andere Funktionen Elemente hinzugefügt werden.<methodCall><method methodName="menu.createMenu"><supermenu name="menu1" ></supermenu>


<supermenu name="toolMenu1"></supermenu></method></methodCall>

Menü erstellen oder ersetzenDas Element <method> zum Erstellen oder Ersetzen eines Menüs hat das folgendeFormat:<method methodName="menu.createOrReplaceMenu">

Mit dieser Methode können Sie ein neues Menü erstellen oder ein vorhandenesMenü ersetzen, das Tools, Untermenüs und Trennlinien enthalten kann. Das Ele-ment <method> enthält ein oder mehrere Elemente <supermenu>. Jedes Element<supermenu> enthält eine beliebige Anzahl von Elementen <separator>, <menu> und<tool>, die den Inhalt des Menüs definieren. Weitere Informationen finden Sie in„<supermenu>” auf Seite 58.

Beispiel

Im folgenden Beispiel werden ein Menü mit dem Namen toolMenu2 erstellt oderersetzt und diesem Menü zwei Tools hinzugefügt.<methodCall><method methodName="menu.createOrReplaceMenu"><supermenu name="toolMenu2"><tool shortcut="" label="Ping" name="Ping" mnemonic="" /><tool shortcut="" label="commandTool1" name="commandTool1" mnemonic="" /></supermenu><method></methodCall>

Menü löschenDas Element <method> zum Löschen eines Menüs hat das folgende Format:<method methodName="menu.deleteMenu">

Mit dieser Methode können Sie ein vorhandenes Menü löschen. Das Element<method> enthält ein oder mehrere Elemente <supermenu>, die jeweils ein zu lö-schendes Menü angeben. Geben Sie im Element <supermenu> nur das Attribut namean.

Beispiel

Im folgenden Beispiel wird das Menü mit dem Namen menu1 gelöscht.<methodCall><method methodName="menu.deleteMenu"><supermenu name="menu1"></supermenu></method></methodCall>


Liste von Menüs abrufenDas Element <method> zum Abrufen einer Liste von Menüs hat das folgende For-mat:<method methodName="menu.getList">

Die Methode gibt eine Liste aller Menüs zurück, die in der Web-GUI definiert sind.

Beispiel<methodCall><method methodName="menu.getList"></method></methodCall>

Menü ändernDas Element <method> zum Ändern eines Menüs hat das folgende Format:<method methodName="menu.modifyMenu">

Mit dieser Methode können Sie ein vorhandenes Menü ändern. Das Element<method> enthält ein oder mehrere Elemente <supermenu>. Jedes Element<supermenu> enthält eine beliebige Anzahl von Elementen <separator>, <menu> und<tool>, die den Inhalt des Menüs definieren.

Beispiel

In diesem Beispiel werden ein Menü und zwei Tools dem Menü menu1 hinzuge-fügt. Anschließend wird dieses Menü zusammen mit weiteren Tools dem MenütoolMenu2 hinzugefügt.<methodCall><method methodName="menu.modifyMenu">

<supermenu name="menu1" mnemonic="n" ><menu name="alerts" label="Alerts" mnemonic="a" /><separator /><tool name="acknowledge" label="Acknowledged" mnemonic="a"shortcut="ctrl+a" /><separator /><tool name="prioritise" label="Prioritize" mnemonic="p" shortcut="" /></supermenu>

<supermenu name="toolMenu1"><tool shortcut="" label="Ping" name="Ping" mnemonic="" /><separator /><menu name="menu1" label="menu1"/><separator /><tool shortcut="" label="commandTool1" name="commandTool1" mnemonic="" /></supermenu></method></methodCall>


ToolanforderungenTools bieten Benutzern erweiterte Möglichkeiten zum Verwalten von Ereignissen inder Liste aktiver Ereignisse (LAE). Es gibt Funktionen zum Erstellen, Ändern undLöschen von Tools. Sie können außerdem eine Liste aller Tools abrufen, die aufdem System definiert sind. WAAPI stellt fünf Methoden für die Arbeit mit Toolsbereit: Tool erstellen, Tool erstellen oder ersetzen, Tool ändern, Tool löschen undListe von Tools abrufen.

Tool erstellenDas Element <method> zum Erstellen eines Tools hat das folgende Format:<method methodName="createTool">

Jedes dieser Elemente definiert ein bestimmtes Tool.v „<tool:tool>”

– „<tool:access>” auf Seite 63- „<tool:osfield>” auf Seite 63

v „<tool:criterion>” auf Seite 63– „<tool:equals>” auf Seite 63

v „<tool:security>” auf Seite 64

„<tool:sql>” auf Seite 64– „<tool:journal>” auf Seite 64– „<tool:cgiurl>” auf Seite 65

- „<tool:fieldlist>” auf Seite 65v „<tool:field>” auf Seite 66

– „<tool:cmdline>” auf Seite 66- „<tool:command>” auf Seite 66

– „<tool:script>” auf Seite 67v „Hinweise zur Verwendung” auf Seite 67v „Beispiel: SQL-Tool” auf Seite 67v „Beispiel: CGI/URL-Tool” auf Seite 68v „Script-Tool” auf Seite 68

<tool:tool>

Das Element <tool:tool> ist ein Container für ein Tool und kann beliebig oft ver-wendet werden. Das Element hat die folgenden Attribute:

Tabelle 23. Attribute des Elements <tool:tool>


name Erforderlich Gibt einen eindeutigen Namen für einTool an.

Wert: Zeichenfolge



Tabelle 23. Attribute des Elements <tool:tool> (Forts.)


datasource Optional Die Datenquellen, die ein Tool verwen-det. Geben Sie mehrere Datenquellen ineiner durch Kommas getrennten Listean.

Wert: Zeichenfolge

Standardwert: Die Standarddatenquelle

<tool:access>

Das Element <tool:access> ist ein untergeordnetes Element des Elements<tool:tool> und definiert die Zugriffskriterien für ein Tool. Das Element hat keineAttribute, sondern enthält die folgenden untergeordneten Elemente in der angege-benen Reihenfolge:v <tool:osfield>

v <tool:security>

<tool:osfield>

Das Element <tool:osfield> enthält die ObjectServer-Felder, die ein Tool verwen-det. Das Element hat keine Attribute, sondern enthält eine beliebige Anzahl vonElementen <tool:criterion>.

<tool:criterion>

Das Element <tool:criterion> ist ein untergeordnetes Element der Elemente<tool:osfield> und <tool:security>. Es definiert ein Zugriffskriterium für einTool und enthält ein oder mehrere Elemente <tool:equals>. Darüber hinaus hatdas Element das folgende Attribut:

Tabelle 24. Attribute des Elements <tool:criterion>


name Erforderlich Der Zugriffstyp für ein Tool.

Wert: Class oder Group. Wenn diesesElement ein untergeordnetes Elementdes Elements <tool:osfield> ist, mussder Wert dieses Attributs Class sein.Wenn das Element ein untergeordnetesElement des Elements <tool:security>ist, muss der Wert des Attributs Groupsein.


<tool:equals>

Das Element <tool:equals> ist ein untergeordnetes Element des Elements<tool:criterion> und weist einen Wert einem Objekt zu, das durch das überge-ordnete Element definiert wird. Das Element hat keinen Inhalt, jedoch die folgen-den Attribute:


Tabelle 25. Attribute des Elements <tool:equals>


value Erforderlich Gibt einen Wert für dasZugriffskriterium an.

Wert: Zeichenfolge


datasource Optional Die Datenquellen, die das Kriteriumverwendet. Geben Sie mehrereDatenquellen in einer durch Kommasgetrennten Liste an.

Wert: Zeichenfolge

Standardwert: Die Standarddatenquelle

<tool:security>

Das Element <tool:security> definiert die Zugriffskriterien für ein LAE-Tool. DasTool enthält eine beliebige Anzahl von Elementen <tool:criterion>, die die Zu-griffskriterien definieren. Das Element hat keine Attribute. Weitere Informationenzum Element <tool:criterion> finden Sie in „<tool:criterion>” auf Seite 63.

<tool:sql>

Das Element <tool:sql> enthält den SQL-Befehl und die zugeordneten Optionenfür ein SQL-LAE-Tool. Das Element ist leer, hat jedoch die folgenden Attribute:

Tabelle 26. Attribute des Elements <tool:sql>


foreach Optional Definiert, ob ein Tool an jeder der aus-gewählten Zeilen in der LAE operiert.


Standardwert: false

command Erforderlich Der SQL-Befehl für das Tool.

Wert: Zeichenfolge


<tool:journal>

Das Element <tool:journal> enthält den Journaleintrag, der erstellt wird, wenn einLAE-Tool ausgeführt wird. Das Element ist leer, hat jedoch die folgenden Attribute:

Tabelle 27. Attribute des Elements <tool:journal>




Standardwert: false


Tabelle 27. Attribute des Elements <tool:journal> (Forts.)


entry Erforderlich Der Text für den Journaleintrag.

Wert: Zeichenfolge


<tool:cgiurl>

Das Element <tool:cgiurl> definiert ein CGI/URL-Tool. Das Element enthält dasElement <tool:fieldlist> und hat die folgenden Attribute:

Tabelle 28. Attribute des Elements <tool:cgiurl>




Standardwert: false

windowforeach Optional Definiert, ob ein Ausgabefenster fürjede Zeile angezeigt werden soll, wenndas Tool für die LAE ausgeführt wird.


Standardwert: false

method Optional Die Methode, die das Tool zum Sendenvon Daten an den Server verwendet.

Wert: GET oder POST

Standardwert: GET

target Optional Das Zielfenster im Browser für die Aus-gabe aus dem Tool, das einer URL zu-geordnet ist, die im Attribut 'url'angegeben wird.

Wert: Zeichenfolge


url Erforderlich Die URL (Uniform Resource Locator),die das Aktionsziel für das Tool ist.

Wert: Zeichenfolge


<tool:fieldlist>

Das Element <tool:fieldlist> ist ein untergeordnetes Element des Elements<tool:cgiurl> und definiert die ObjectServer-Felder, die mit dem Tool verwendetwerden sollen. Das Element enthält ein oder mehrere Elemente <tool:field>, diejeweils ein ObjectServer-Feld angeben, und hat keine Attribute.


<tool:field>

Das Element <tool:field> ist ein untergeordnetes Element des Elements<tool:fieldlist> und definiert den Namen eines ObjectServer-Felds, das mit demTool verwendet werden soll. Das Element ist leer, hat jedoch das folgende Attribu-te:

Tabelle 29. Attribute des Elements <tool:field>


name Erforderlich Der Name eines ObjectServer-Felds.

Wert: Zeichenfolge


<tool:cmdline>

Das Element <tool:cmdline> definiert ein Befehlszeilentool. Das Element enthältein oder mehrere Elemente <tool:command> und hat keine Attribute.

<tool:command>

Das Element <tool:command> ist ein untergeordnetes Element des Elements<tool:cmdline> und definiert die den plattformspezifischen Befehl, der einem Be-fehlszeilentool zugeordnet ist. Das Element ist leer, hat jedoch die folgenden Attri-bute:

Tabelle 30. Attribute des Elements <tool:command>


enabled Optional Definiert, ob es aktiviert oder inaktiviertist. Dieses Attribut wird in Kombinationmit dem Attribut 'platform' verwendet,um festzulegen, ob ein Tool auf einerbestimmten Plattform verfügbar ist.


Standardwert: false

platform Erforderlich Gibt die Plattform an, für die das Toolgültig ist. Dieses Attribut wird in Kom-bination mit dem Attribut 'enabled' ver-wendet, um festzulegen, ob ein Tool aufeiner bestimmten Plattform verfügbarist.

Wert: Windows, Solaris, Linux, HPUXoder AIX


executable Erforderlich Der Befehl, der ausgeführt wird, wenndas Tool ausgeführt wird.

Wert: Zeichenfolge



Tabelle 30. Attribute des Elements <tool:command> (Forts.)




Standardwert: false

<tool:script>

Das Element <tool:script> definiert ein Script-Tool. Das Element ist leer, hat je-doch die folgenden Attribute:

Tabelle 31. Attribute des Elements <tool:script>




Standardwert: false

command Erforderlich Das Script für das Tool.

Wert: Zeichenfolge


Hinweise zur Verwendung

Das Element <tool:journal> wird in der Regel in Verbindung mit anderen Toolsverwendet, um Journaleinträge über die Operationen der Tools zu erstellen. Bei-spiel: Sie können das Element <tool:journal> dazu verwenden, die Aktion aufzu-zeichnen, die durch ein Element <tool:sql> ausgeführt wird.

Zum Erstellen eines Befehlszeilentools, das auf einer beliebigen Plattform in IhrerOrganisation ausgeführt werden kann, verwenden Sie mehrere Elemente<tool:cmdline>. Jedes dieser Elemente enthält einen plattformspezifischen Befehl,wobei alle Befehle zu demselben oder einem ähnlichen Ergebnis führen. Sie könn-ten zum Beispiel ein Element für Windows und ein anderes Element für Linux ha-ben. Das Beispiel in „Tool erstellen oder ersetzen” auf Seite 69 zeigt dieses Verfah-ren.

Beispiel: SQL-Tool

Im folgenden Beispiel wird ein SQL-Tool mit dem Namen sqlSample1 erstellt.<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"><method methodName="tool.createTool"><tool:tool name="sqlSample1"><tool:access><tool:osfield><tool:criterion name="Class">


<tool:equals value="7450"/><tool:equals value="7500"/></tool:criterion></tool:osfield><tool:security><tool:criterion name="Group"><tool:equals value="restricted"/><tool:equals value="Desktop"/></tool:criterion></tool:security></tool:access><tool:sql foreach="true"command="update alerts.status set Summary=’sqlTest1’ where Serial=@Serial;"/><tool:journal foreach="true"entry="Tool ausgeführt für Ereignis Class CONVERSION(@Class)."/>

</tool:tool></method></methodCall>

Beispiel: CGI/URL-Tool

Im folgenden Beispiel wird ein CGI/URL-Tool mit dem Namen cmsSample1 erstellt.<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"><method methodName="tool.createTool"><tool:tool name="cmdSample"><tool:access><tool:osfield/><tool:security><tool:criterion name="Group"><tool:equals value="restricted"/><tool:equals value="Desktop"/></tool:criterion></tool:security></tool:access><tool:cmdline><tool:command foreach="true" enabled="true" platform="Windows"executable="start cmd /k c:\temp\sample.bat {@Class} {@Node}"/><tool:command foreach="true" enabled="true" platform="Solaris"executable="xterm -e /bin/sh -c ’/tmp/sample.sh {@Class} {@Node}; read a’"/><tool:command foreach="true" enabled="false" platform="AIX"executable="xterm -e /bin/sh -c ’/tmp/sample.sh {@Class} {@Node}; read a’"/></tool:cmdline></tool:tool></method></methodCall>

Script-Tool

Im folgenden Beispiel wird ein Script-Tool mit dem Namen scriptSample1 erstellt.<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"><method methodName="tool.createTool"><tool:tool name="scriptSample">


<tool:access><tool:osfield/><tool:security><tool:criterion name="Group"><tool:equals value="restricted"/><tool:equals value="Desktop"/></tool:criterion></tool:security></tool:access><tool:script foreach="false" command="alert(’{@Node}’);"/></tool:tool></method></methodCall>

Tool erstellen oder ersetzenDas Element <method> zum Erstellen oder Ersetzen eines Tools hat das folgendeFormat:<method methodName="createOrReplaceTool">

Mit dieser Methode können Sie ein neues Tool erstellen oder ein vorhandenes Toolersetzen. Das Element <method> enthält ein oder mehrere Elemente <tool:tool>. Je-des Element <tool:tool> enthält ein Element <tool:access>, gefolgt von einer be-liebigen Anzahl der folgenden Elemente:v <tool:sql>

v <tool:journal>

v <tool:cgiurl>

v <tool:cmdline>

v <tool:script>

Jedes dieser Elemente definiert ein bestimmtes Tool. Weitere Informationen findenSie in „<tool:tool>” auf Seite 62.

Beispiel

Im folgenden Beispiel wird ein Tool mit dem Namen cmdSample erstellt oder er-setzt.<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"><method methodName="tool.createOrReplaceTool"><tool:tool name="cmdSample"><tool:access><tool:osfield/><tool:security/></tool:access><tool:cmdline><tool:command foreach="true" enabled="true" platform="Windows"executable="start cmd /k c:\temp\sample.bat {@Class} {@Node}"/><tool:command foreach="true" enabled="true" platform="Linux"executable="xterm -e /bin/sh -c ’/tmp/sample.sh {@Class} {@Node}; read a’"/><tool:command foreach="true" enabled="true" platform="AIX"executable="xterm -e /bin/sh -c ’/tmp/sample.sh {@Class} {@Node}; read a’"/>

</tool:cmdline></tool:tool></method></methodCall>


Tool löschenDas Element <method> zum Löschen eines Tools hat das folgende Format:<method methodName="tool.deleteTool">

Mit dieser Methode können Sie ein vorhandenes Tool löschen. Das Element<method> enthält ein oder mehrere Elemente <tool:tool>, die jeweils ein zu lö-schendes Tool angeben. Geben Sie im Element <tool:tool> nur das Attribut namean.

Beispiel

Im folgenden Beispiel werden die Tools mit den Namen sqlSample1, sqlSample2,cgiSample, cmdSample, scriptSample und scriptSample2 gelöscht.<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1">

<method methodName="tool.deleteTool">

<tool:tool name="sqlSample1"/><tool:tool name="sqlSample2"/><tool:tool name="cgiSample"/><tool:tool name="cmdSample"/><tool:tool name="scriptSample"/><tool:tool name="scriptSample2"/>


Liste von Tools abrufenDas Element <method> zum Abrufen einer Liste von Tools hat das folgende Format:<method methodName="tool.getList">

Die Methode gibt eine Liste aller Tools zurück, die in der Web-GUI definiert sind.

Beispiel<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1">

<method methodName="tool.getList"/></method></methodCall>

Tool ändernDas Element <method> zum Ändern eines Tools hat das folgende Format:<method methodName="modifyTool">

Mit dieser Methode können Sie ein vorhandenes Tool ändern. Das Element<method> enthält ein oder mehrere Elemente <tool:tool>. Jedes Element<tool:tool> enthält ein Element <tool:access>, gefolgt von einer beliebigen An-zahl der folgenden Elemente:v <tool:sql>

v <tool:journal>

v <tool:cgiurl>

v <tool:cmdline>

v <tool:script>

Weitere Informationen finden Sie in „<tool:tool>” auf Seite 62.


Beispiel

Im folgenden Beispiel werden die Tools mit den Namen sqlSample1 und cgiSamplegeändert.<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"><method methodName="tool.modifyTool"><tool:tool name="sqlSample1"><tool:access><tool:osfield><tool:criterion name="Class"><tool:equals value="7450"/></tool:criterion></tool:osfield><tool:security/></tool:access><tool:sql foreach="true"command="update alerts.status set Summary=’sqlTest1’ where Serial=@Serial;"/><tool:journal foreach="true" entry="Tool executed on event Class @Class."/></tool:tool>

<tool:tool name="cgiSample"><tool:access><tool:osfield><tool:criterion name="Class"><tool:equals value="7500"/></tool:criterion></tool:osfield><tool:security/></tool:access><tool:cgiurl foreach="true" windowforeach="true" target="_blank"method="GET" url="$(SERVER)/cgi-bin/sample.cgi"><tool:fieldlist><tool:field name="Class"/><tool:field name="Node"/></tool:fieldlist></tool:cgiurl></tool:tool></method></methodCall>

Anforderungen für EingabeaufforderungenEingabeaufforderungen sind bestimmten Tooltypen zugeordnet. Sie generieren einEingabeaufforderungsfenster oder ein Popup-Menü, in dem Benutzer zur Eingabeoder Auswahl der für ein Tool erforderlichen Informationen aufgefordert werden.Es gibt Funktionen zum Erstellen, Ändern und Löschen von Eingabeaufforderun-gen. Außerdem können Sie eine Liste der Eingabeaufforderungen abrufen, die fürden Server definiert sind. WAAPI stellt fünf Methoden für die Arbeit mit Eingabe-aufforderungen bereit: Eingabeaufforderung erstellen, Eingabeaufforderung erstel-len oder ersetzen, Eingabeaufforderung ändern, Eingabeaufforderung löschen undListe von Eingabeaufforderungen abrufen.

Die WAAPI-Datei für Eingabeaufforderungen enthält mehrere Beispiele und befin-det sich in WEBGUI_HOME/waapi/etc/samples/samplerequest_prompt.xml.


Eingabeaufforderung erstellen oder ersetzenDas Element <method> zum Erstellen oder Ersetzen einer Eingabeaufforderung hatdas folgende Format:<method methodName="prompt.creatOrReplacePrompt">

Mit dieser Methode können Sie eine neue Eingabeaufforderung erstellen oder einevorhandene Eingabeaufforderung ersetzen. Das Element <method> enthält ein odermehrere Elemente <prompt:prompt>, die jeweils die Merkmale einer neuen Eingabe-aufforderung definieren. Das Element <prompt:prompt> enthält ein optionales Ele-ment <prompt:parameters>, auf das ein optionales Element <prompt:choice> folgt.Weitere Informationen finden Sie in „<prompt:prompt>”. Weitere Informationenzur Verwendung des Elements <prompt:prompt> und der zugehörigen Unterele-mente finden Sie in „Hinweise zur Verwendung” auf Seite 74.v „<prompt:prompt>”v „<prompt:parameters>”v „<prompt:additionalParams>” auf Seite 73v „<prompt:param>” auf Seite 73v „<prompt:choice>” auf Seite 74v „<prompt:item>” auf Seite 74v „Hinweise zur Verwendung” auf Seite 74v „Beispiele: Eingabeaufforderungen erstellen” auf Seite 77v „Beispiel: Eingabeaufforderung ersetzen” auf Seite 79

<prompt:prompt>

Das Element <prompt:prompt> definiert eine Eingabeaufforderung und hat die fol-genden Attribute:

Tabelle 32. Attribute des Elements <prompt:prompt>


name Erforderlich Gibt einen eindeutigen Namen für eineEingabeaufforderung an.

Wert: Zeichenfolge


type Erforderlich Der Typ der Eingabeaufforderung.

Wert: Einer der folgenden Werte:String, Integer, Float, Password, Time,Lookup, FixedChoice, DynamicChoice,MultilineString, FormattedString,RealTimeDynamicChoice


<prompt:parameters>

Das Element <prompt:parameters> ist ein untergeordnetes Element des Elements<prompt:prompt> und definiert die Parameter für eine Eingabeaufforderung. DasElement kann einmal angegeben werden oder weggelassen werden, wenn die Ein-gabeaufforderung keine Parameter benötigt. Für bestimmte Eingabeaufforde-rungstypen enthält dieses Element ein Element <prompt:additionalParameters>.Das Element <prompt:parameters> hat die folgenden Attribute:


Tabelle 33. Attribute des Elements <prompt:parameters>


label Erforderlich Der Text, der in einemEingabeaufforderungsfenster angezeigtwird. Er erläutert dem Benutzer, welcheAngaben erforderlich sind.

Wert: Zeichenfolge


order Erforderlich Der Rang einer Eingabeaufforderunginnerhalb einer Reihe vonEingabeaufforderungen in einemEingabeaufforderungsfenster.

Wert: Integer


localized Erforderlich Definiert, ob eine Eingabeaufforderunglokalisiert werden kann.



errorMessage Optional Der Text, der dem Benutzer nach derEingabe ungeeigneter Informationenangezeigt wird.

Wert: Zeichenfolge


defaultValue Optional Die Standardantwort auf eineEingabeaufforderung, die vom Benutzerausgewählt werden kann.

Wert: Zeichenfolge


<prompt:additionalParams>

Das Element <prompt:additionalParams> ist ein untergeordnetes Element des Ele-ments <prompt:parameters>, das zusätzliche Parameter bereitstellt, die für die fol-genden Typen von Tools erforderlich sind:v Suche (Lookup)v Dynamische Auswahl (DynamicChoice)v Formatierte Zeichenfolge (FormattedString)v Dynamische Echtzeitauswahl (RealTimeDynamicChoice)

Das Element enthält eine beliebige Anzahl von Elementen <prompt:param>, die je-weils einen zusätzlichen Parameter definieren und keine Attribute haben.

<prompt:param>

Das Element <prompt:param> ist ein untergeordnetes Element des Elements<prompt:additionalParams> und definiert den Namen und den Wert eines zusätzli-chen Parameters für ein Tool. In den Hinweisen zur Verwendung finden Sie weite-re Informationen dazu, wie dieses Element verwendet wird. Das Element ist leerund hat die folgenden Attribute:


Tabelle 34. Attribute des Elements <prompt:param>


name Erforderlich Der Name des Parameters.

Wert: Zeichenfolge


value Erforderlich Der Wert des Parameters.

Wert: Abhängig vom Typ derEingabeaufforderung, jedoch in der Re-gel eine Zeichenfolge (String).


<prompt:choice>

Das Element <prompt:choice> ist ein untergeordnetes Element des Elements<prompt:prompt> und definiert die Auswahlmöglichkeiten für ein Menü in einerEingabeaufforderung mit festen Auswahlmöglichkeiten (FixedChoice). Es hat keineAttribute, sondern enthält einen oder mehrere Einträge <prompt:item>, die jeweilseine Auswahlmöglichkeit im Menü definieren.

<prompt:item>

Das Element <prompt:item> ist ein untergeordnetes Element des Elements<prompt:choice> und kann einmal oder mehrmals verwendet werden. Jedes Vor-kommen definiert eine Auswahlmöglichkeit im Menü für eine Eingabeaufforde-rung mit festen Auswahlmöglichkeiten. Das Element hat die folgenden Attribute:

Tabelle 35. Attribute des Elements <prompt:item>


value Erforderlich Der Wert, den die Eingabeaufforderungzurückgibt, wenn der Benutzer dieseOption auswählt.

Wert: Zeichenfolge


label Erforderlich Der Text, der im Menü für dieseAuswahlmöglichkeit angezeigt wird.

Wert: Zeichenfolge


Hinweise zur Verwendung

Die folgenden Hinweise erläutern, wie die untergeordneten Elemente des Elements<prompt:prompt> für die einzelnen Typen von Eingabeaufforderungen verwendetwerden.

String (Zeichenfolge)

Geben Sie ein einzelnes Element <prompt:parameters> an, das die anzuzeigendeZeichenfolge der Eingabeaufforderung ('label'), ihren Rang relativ zu anderen Ein-


gabeaufforderungen ('order'), eine Fehlernachricht ('errorMessage'), den Lokalisie-rungsindikator ('localized') und den Standardwert ('defaultValue') enthält. LassenSie alle anderen untergeordneten Elemente weg.

Integer (ganze Zahl)

Geben Sie ein einzelnes Element <prompt:parameters> an, das die anzuzeigendeZeichenfolge der Eingabeaufforderung ('label'), ihren Rang relativ zu anderen Ein-gabeaufforderungen ('order'), eine Fehlernachricht ('errorMessage'), den Lokalisie-rungsindikator ('localized') und den Standardwert ('defaultValue') enthält. LassenSie alle anderen untergeordneten Elemente weg.

Float (Gleitkommazahl)

Geben Sie ein einzelnes Element <prompt:parameters> an, das die anzuzeigendeZeichenfolge der Eingabeaufforderung ('label'), ihren Rang relativ zu anderen Ein-gabeaufforderungen ('order'), eine Fehlernachricht ('errorMessage'), den Lokalisie-rungsindikator ('localized') und den Standardwert ('defaultValue') enthält. LassenSie alle anderen untergeordneten Elemente weg.

Password (Kennwort)

Geben Sie ein einzelnes Element <prompt:parameters> an, das die anzuzeigendeZeichenfolge der Eingabeaufforderung ('label'), ihren Rang relativ zu anderen Ein-gabeaufforderungen ('order') und den Lokalisierungsindikator ('localized') enthält.Lassen Sie alle anderen untergeordneten Elemente weg.

Time (Zeit)

Geben Sie ein einzelnes Element <prompt:parameters> an, das die anzuzeigendeZeichenfolge der Eingabeaufforderung ('label'), ihren Rang relativ zu anderen Ein-gabeaufforderungen ('order') und den Lokalisierungsindikator ('localized') enthält.Lassen Sie alle anderen untergeordneten Elemente weg.

Lookup (Suche)

Geben Sie ein einzelnes Element <prompt:parameters> an, das die anzuzeigendeZeichenfolge der Eingabeaufforderung ('label'), ihren Rang relativ zu anderen Ein-gabeaufforderungen ('order') und die Lokalisierungsmarkierung ('localized') ent-hält. Geben Sie außerdem ein Element <prompt:additionalParams> an, das ein ein-zelnes Element <prompt:param> mit den folgenden Werten für die zugehörigenAttribute enthält:

Tabelle 36. Werte für das Element <prompt:param> in einer Lookup-Eingabeaufforderung

Attribut Wert

name file

value Der Pfad der Datei, die die Elemente enthält, die in der Lookup-Liste an-gezeigt werden sollen. Beispiel:

/tmp/lookup.txt

FixedChoice (feste Auswahlmöglichkeiten)

Geben Sie ein einzelnes Element <prompt:parameters> an, das die anzuzeigendeZeichenfolge der Eingabeaufforderung ('label'), ihren Rang relativ zu anderen Ein-


gabeaufforderungen ('order') und die Lokalisierungsmarkierung ('localized') ent-hält. Geben Sie außerdem ein Element <prompt:choice> mit einem Element<prompt:item> für jede Auswahlmöglichkeit in dem Menü an.

DynamicChoice (dynamische Auswahlmöglichkeiten)


Tabelle 37. Werte für das Element <prompt:param> in einer Eingabeaufforderung mit dyna-mischen Auswahlmöglichkeiten

Attribut Wert

name sqlCommand

value Ein SQL-Befehl für den ObjectServer für bis zu zwei Spalten aus einer Ta-belle. Jede Zeile, die der ObjectServer zurückgibt, wird dem Benutzer alsElement in einem Untermenü oder einer Liste angezeigt. Bei Ausführungfür mehrere ObjectServer kann der SQL-Befehl nur Spalten undSpaltenwerte auswählen, die alle Server gemeinsam haben. Beispiel:

select Conversion, Value from alerts.conversionswhere Colname=’Severity’ order by Value desc;

MultilineString (mehrzeilige Zeichenfolge)


FormattedString (formatierte Zeichenfolge)

Geben Sie ein einzelnes Element <prompt:parameters> an, das die anzuzeigendeZeichenfolge der Eingabeaufforderung ('label'), ihren Rang relativ zu anderen Ein-gabeaufforderungen ('order'), eine Fehlernachricht ('errorMessage'), den Lokalisie-rungsindikator ('localized') und den Standardwert ('defaultValue') enthält. GebenSie außerdem ein Element <prompt:additonalParams> an, das ein einzelnes Element<prompt:param> mit den folgenden Werten für die zugehörigen Attribute enthält:

Tabelle 38. Werte für das Element <prompt:param> in einer Eingabeaufforderung mit forma-tierter Zeichenfolge

Attribut Wert

name format

value Ein regulärer Ausdruck, mit dem die Zeichenfolge, die der Benutzer ein-gibt, übereinstimmen muss. Beispiel:

^[a-zA-Z]{3}\d{3}$


RealTimeDynamicChoice (dynamische Echtzeitauswahl)


Tabelle 39. Werte für das Element <prompt:param> in einer Eingabeaufforderung mit dyna-mischer Echtzeitauswahl

Attribut Wert

name sqlCommand

value Ein SQL-Befehl für den ObjectServer für bis zu zwei Spalten aus einer Ta-belle. Jede Zeile, die der ObjectServer zurückgibt, wird dem Benutzer alsElement in einem Untermenü oder einer Liste angezeigt. Bei Ausführungfür mehrere ObjectServer kann der SQL-Befehl nur Spalten undSpaltenwerte auswählen, die alle Server gemeinsam haben. Beispiel:

select Conversion, Value from alerts.conversionswhere Colname=’Type’ order by Value desc;

Die Eingabeaufforderung mit dynamischen Echtzeitauswahlmöglichkeiten erstellteine Liste mit Blätterfunktion, die die Ergebnisse der ObjectServer-Abfrage enthält,die generiert wird, wenn das Tool ausgeführt wird. Diese Eingabeaufforderung istfür die Verwendung mit Daten aus einer ObjectServer-Tabelle gedacht, die sichhäufig ändern kann. Da dieser Eingabeaufforderungstyp in Echtzeit ausgeführtwird, verwenden Sie sie sparsam, um die Belastung für den Web-GUI-Server zuverringern.

Beispiele: Eingabeaufforderungen erstellen

Im folgenden Beispiel wird eine Eingabeaufforderung von jedem Typ erstellt.<methodCall xmlns:prompt="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2">

<method methodName="prompt.createPrompt"><prompt:prompt type="String" name="testString"><prompt:parameters label="Type in a string value" order="100"errorMessage="String value cannot be empty" localized="false"defaultValue="Default string"/>

</prompt:prompt>

<prompt:prompt type="Integer" name="testInteger"><prompt:parameters label="Type in an integer value" order="110"errorMessage="Invalid integer value" localized="false" defaultValue="5"/>

</prompt:prompt>

<prompt:prompt type="Float" name="testFloat"><prompt:parameters label="Type in a float value" order="120"errorMessage="Invalid float value" localized="false" defaultValue="1.0"/>

</prompt:prompt>

<prompt:prompt type="Password" name="testPassword"><prompt:parameters label="Type in the password" order="130"localized="false"/>

</prompt:prompt>


<prompt:prompt type="Time" name="testTime"><prompt:parameters label="Specify a date/time" order="140"errorMessage="Invalid date/time value" localized="false"/>

</prompt:prompt>

<prompt:prompt type="Lookup" name="testLookup"><prompt:parameters label="Select a lookup option" order="150"localized="false"><prompt:additionalParams><prompt:param name="file" value="/tmp/lookup.txt"/></prompt:additionalParams></prompt:parameters></prompt:prompt>

<prompt:prompt type="FixedChoice" name="testFixedChoice"><prompt:parameters label="Select a fixed option" order="160"localized="false"defaultValue="fixed2"/><prompt:choice><prompt:item value="fixed1" label="Fixed One"/><prompt:item value="fixed2" label="Fixed Two"/><prompt:item value="fixed3" label="Fixed Three"/></prompt:choice></prompt:prompt>

<prompt:prompt type="DynamicChoice" name="testDynamicChoice"><prompt:parameters label="Select a dynamic option" order="170"localized="false"><prompt:additionalParams><prompt:param name="sqlCommand"value="select Conversion, Value from alerts.conversionswhere Colname=’Severity’ order by Value desc;"/></prompt:additionalParams></prompt:parameters>

</prompt:prompt>



<prompt:prompt type="MultilineString" name="testMultilineString"><prompt:parameters label="Type in a journal entry" order="0"errorMessage="Journal entry cannot be empty" localized="false"defaultValue="Journal entry"/></prompt:prompt>

<prompt:prompt type="FormattedString" name="testFormattedString"><prompt:parameters label="Type in the ticket ID (3 letters, 3 digits)"order="180" errorMessage="Invalid ticket ID format" localized="false"defaultValue="ABC123"><prompt:additionalParams><prompt:param name="format" value="^[a-zA-Z]{3}\d{3}$"/></prompt:additionalParams></prompt:parameters></prompt:prompt>

<prompt:prompt type="RealTimeDynamicChoice" name="testRealTimeDynamicChoice"><prompt:parameters label="Select a real-time dynamic option" order="190"localized="false"><prompt:additionalParams>


<prompt:param name="sqlCommand" value="select Conversion, Value fromalerts.conversions where Colname=’Type’ order by Value desc;"/>

</prompt:additionalParams></prompt:parameters></prompt:prompt></method>

</methodCall>

Beispiel: Eingabeaufforderung ersetzen

Im folgenden Beispiel wird die Definition der vorhandenen Eingabeaufforderungmit dem Namen testFormattedString ersetzt.<methodCall xmlns:prompt="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2">

<method methodName="prompt.createOrReplacePrompt"><prompt:prompt type="FormattedString" name="testFormattedString">

<prompt:parameters label="Type in the ticket ID (3 letters, 3 digits)"order="180" errorMessage="Invalid ticket ID format" localized="false"defaultValue="Bbc123"><prompt:additionalParams><prompt:param name="format" value="^[a-zA-Z]{3}\d{3}$"/></prompt:additionalParams></prompt:parameters>

</prompt:prompt></method>

</methodCall>

Eingabeaufforderung löschenDas Element <method> zum Löschen einer Eingabeaufforderung hat das folgendeFormat:<method methodName="prompt.deletePrompt">

Mit dieser Methode können Sie eine vorhandene Eingabeaufforderung löschen. DasElement <method> enthält ein oder mehrere Elemente <prompt:prompt>, die jeweilseine zu löschende Eingabeaufforderung angeben. Geben Sie im Element<prompt:prompt> nur das Attribut name an.

Beispiel

Im folgenden Beispiel wird die Eingabeaufforderung mit dem Namen testStringgelöscht.<methodCall xmlns:prompt="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2">

<method methodName="prompt.deletePrompt"><prompt:prompt name="testString"/>


Liste von Eingabeaufforderungen abrufenDas Element <method> zum Abrufen einer Liste von Eingabeaufforderungen hatdas folgende Format:<method methodName="prompt.getList" />

Mit dieser Methode können Sie eine Liste der Namen der definierten Eingabeauf-forderungen abrufen.


Beispiel<methodCall xmlns:prompt="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2">

<method methodName="prompt.getList"/>

</methodCall>

Eingabeaufforderung ändernDas Element <method> zum Ändern einer Eingabeaufforderung hat das folgendeFormat:<method methodName="prompt.modifyPrompt">

Mit dieser Methode können Sie eine vorhandene Eingabeaufforderung ändern. DasElement <method> enthält ein oder mehrere Elemente <prompt:prompt>, die jeweilsdie Merkmale einer neuen Eingabeaufforderung definieren. Das Element<prompt:prompt> enthält ein optionales Element <prompt:parameters>, auf das einoptionales Element <prompt:choice> folgt. Weitere Informationen finden Sie in„<prompt:prompt>” auf Seite 72. Weitere Informationen zur Verwendung des Ele-ments <prompt:prompt> und der zugehörigen Unterelemente finden Sie in „Hinwei-se zur Verwendung” auf Seite 74.

Beispiel

Im folgenden Beispiel wird die Eingabeaufforderung mit dem NamentestFixedChoice geändert.<methodCall xmlns:prompt="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2">

<method methodName="prompt.modifyPrompt"><prompt:prompt type="FixedChoice" name="testFixedChoice">

<prompt:parameters label="Select a fixed option" order="160"localized="false" defaultValue="fixed6"/><prompt:choice>

<prompt:item value="fixed4" label="Fixed Four"/><prompt:item value="fixed5" label="Fixed Five"/><prompt:item value="fixed6" label="Fixed Six"/>

</prompt:choice></prompt:prompt>


CGI-AnforderungenCGI-Anforderungen dienen zur Bearbeitung von CGI-Scripts, die als Tools in derWeb-GUI verwendet werden. Es gibt Funktionen zum Registrieren, Ändern undZurücknehmen der Registrierung eines Scripts. WAAPI stellt vier Methoden für dieArbeit mit CGI-Scripts bereit: CGI-Script registrieren, CGI-Script erstellen oder er-setzen, CGI-Script ändern und Registrierung eines CGI-Scripts zurücknehmen.


CGI-Script registrierenDas Element <method> zum Registrieren eines CGI-Scripts hat das folgende Format:<method methodName="cgi.registerCGI">

Mit dieser Methode registrieren Sie ein CGI-Script beim Web-GUI-Server. Das Ele-ment <method> enthält ein oder mehrere Elemente <cgi>, die jeweils ein zu regist-rierendes Script definieren.v „<cgi>”v „Beispiel”

<cgi>

Das Element <cgi> definiert die Merkmale eines CGI-Scripts und hat die folgendenAttribute:

Tabelle 40. Attribute des Elements <cgi>


name Erforderlich Gibt einen eindeutigen Namen für einCGI-Script an.

Wert: Zeichenfolge


useSmartPageCommands Optional Definiert, ob SmartPage-Befehle beimAusführen des Scripts verwendet wer-den sollen.


Standardwert: false

fileName Optional Der Pfadname der Datei, die das Scriptenthält.

Wert: Zeichenfolge

Standardwert: Wenn dieses Attributnicht angegeben wird, enthält das Ele-ment <cgi> den Inhalt des Scripts.

Beispiel

Im folgenden Beispiel wird ein Script mit dem Namen myping in einer Datei mitdem Namen nco_myping.cgi registriert.<methodCall><method methodName="cgi.registerCGI"><cgi name="myping" acl="*" useSmartPageCommands="true"fileName="/home/nco_myping.cgi"></cgi></method></methodCall>


CGI-Script erstellen oder ersetzenDas Element <method> zum Erstellen oder Ersetzen eines CGI-Scripts hat das fol-gende Format:<method methodName="cgi.createOrReplaceCGI">

Mit dieser Methode können Sie ein neues CGI-Script beim Web-GUI-Server regist-rieren oder eine Definition ersetzen, wenn sie bereits vorhanden ist. Das Element<method> enthält ein oder mehrere Elemente <cgi>, die jeweils ein zu registrieren-des Script definieren. Weitere Informationen finden Sie in „<cgi>” auf Seite 81.

Im folgenden Beispiel wird ein Script mit dem Namen myping1 erstellt oder ersetzt.<methodCall><method methodName="cgi.createOrReplaceCGI"><cgi name="myping1" acl="*" useSmartPageCommands="false"fileName="/home/nco_myping1.cgi"></cgi></method></methodCall>

CGI-Script ändernDas Element <method> zum Ändern eines CGI-Scripts hat das folgende Format:<method methodName="cgi.modifyCGI">

Mit dieser Methode können Sie ein zuvor registriertes CGI-Script ändern. Das Ele-ment <method> enthält ein oder mehrere Elemente <cgi>, die jeweils die Merkmaleeines CGI-Scripts ändern. Weitere Informationen finden Sie in „<cgi>” auf Seite 81.

Beispiel

Im folgenden Beispiel wird der Wert des Attributs acl für das Script mit dem Na-men myping geändert.<methodCall><method methodName="cgi.modifyCGI"><cgi name="myping" acl="example" useSmartPageCommands="false" ></cgi></method></methodCall>

Registrierung eines CGI-Scripts zurücknehmenDas Element <method> zum Zurücknehmen der Registrierung eines CGI-Scripts hatdas folgende Format:<method methodName="cgi.unregisterCGI">

Mit dieser Methode können Sie die Registrierung eines zuvor registrierten CGI-Scripts zurücknehmen. Das Element <method> enthält ein oder mehrere Elemente<cgi>, die jeweils ein CGI-Script angeben, dessen Registrierung zurückgenommenwerden soll. Geben Sie im Element <cgi> nur das Attribut name an.

Beispiel

Im folgenden Beispiel wird die Registrierung eines Scripts mit dem Namen mypingzurückgenommen.


<methodCall><method methodName="cgi.unregisterCGI"><cgi name="myping" ></cgi></method></methodCall>

FilteranforderungenFilteranforderungen dienen zur Bearbeitung von Filtern, die zum Anzeigen von Er-eignissen in der Liste aktiver Ereignisse (LAE), in der Ereignisanzeige, in der Ver-einfachten Ereignisliste (VEL, engl. LEL - Lightweight Event List), in der Tabellen-sicht sowie in Monitorfeldern im Ereignis-Dashboard verwendet werden. Es gibtFunktionen zum Erstellen, Ändern, Entfernen und Auflisten von Filtern. Sie kön-nen außerdem die Standardsicht festlegen. WAAPI stellt sechs Methoden zum Ar-beiten mit Filtern bereit: Filter hinzufügen, Filter erstellen oder ersetzen, Filterändern, Filter löschen, Liste von Filtern abrufen und Standardsicht für einen Filterfestlegen.

Filter hinzufügenDas Element <method> zum Hinzufügen eines Filters hat das folgende Format:<method methodCall="filter.addFilter">

Mit dieser Methode können Sie einen neuen Filter zur Verwendung mit der Listeaktiver Ereignisse (LAE), der Ereignisanzeige, der vereinfachten Ereignisliste (LEL),der Tabellensicht und dem Ereignis-Dashboard definieren. Das Element <method>enthält ein oder mehrere Elemente <filter>, die jeweils die Merkmale eines neuenFilters definieren.

Für einen abhängigen Filter enthält das Element <filter> eine oder mehrere Ins-tanzen des Elements <dependentlist>.v „<filter>”v „<dependentlist>” auf Seite 85v „Regeln für abhängige Filter” auf Seite 86v „Beispiel: Ereignisfilter” auf Seite 86v „Beispiel: Gruppenfilter” auf Seite 86v „Beispiel: Abhängiger Filter” auf Seite 87

<filter>

Das Element <filter> definiert die Merkmale eines Filters und hat die folgendenAttribute:

Tabelle 41. Attribute des Elements <filter>


name Erforderlich Gibt einen eindeutigen Namen für ei-nen Filter an.

Wert: Zeichenfolge



Tabelle 41. Attribute des Elements <filter> (Forts.)


user Optional Für Benutzerfilter gibt dieses Attributdie Benutzer an, denen der Filter zuge-ordnet wird. Der Wert des Attributs isteine durch Kommas getrennte Liste vonBenutzer-IDs.

Wert: Liste von Benutzer-IDs


group Optional Für Gruppenfilter gibt dieses Attributdie Gruppen an, denen der Filter zuge-ordnet wird. Der Wert des Attributs isteine durch Kommas getrennte Liste vonGruppen-IDs.

Wert: Liste von Gruppen-IDs


sql Optional Der Wert der SQL-WHERE-Klausel, derdie zum Filtern von Ereignissen zu ver-wendenden Felder und ihre Werte defi-niert.

Wert: Eine SQL-WHERE-Klausel


mode Optional Definiert, ob der Filter ein abhängigerFilter ist. Geben Sie dieses Attribut nurfür abhängige Filter an.

Wert: dependent


description Optional Definiert eine Textbeschreibung des Fil-ters.

Wert: Zeichenfolge


filtercollection Optional Gibt den Namen einerFilterobjektgruppe an, zu der der Filtergehört.

Wert: Zeichenfolge


type Optional Gibt den Typ des Filters an.

Wert: global, system, user oder group

Standardwert: System

view Optional Gibt die Sicht an, die dem Filter zuge-ordnet ist.

Wert: Zeichenfolge


viewtype Optional Gibt den Typ der Sicht an.

Wert: global, system oder user



Tabelle 41. Attribute des Elements <filter> (Forts.)


datasource Optional Gibt die Datenquelle an, die Ereignissefür die Filterung liefert. Geben Sie meh-rere Datenquellen in einer durch Kom-mas getrennten Liste an. Dieses Attributist für das Hinzufügen eines Filters isterforderlich.

Wert: Zeichenfolge


metriclabel Optional Definiert die Bezeichnung zur Beschrei-bung der zusammengefasstenStatistikdaten, die in Monitorfeldern imEreignis-Dashboard angezeigt werden.

Wert: Zeichenfolge

Standardwert: Metric:

metricshow Optional Definiert die Berechnungskriterien fürden Messwert, der in Monitorfeldern imEreignis-Dashboard angezeigt wird.

Wert: Average, Count, Sum, Minimum oderMaximum

Standardwert: Average

metricof Optional Definiert das ObjectServer-Feld, das beider Berechnung des Messwerts verwen-det wird, der in Monitorfeldern im Er-eignis-Dashboard angezeigt wird.

Wert: Feldname

Standardwert: Severity

<dependentlist>

Das Element <dependentlist> gibt die Liste von Filtern an, die von einem abhängi-gen Filter verwendet werden, und hat die folgenden Attribute.

Tabelle 42. Attribute des Elements <dependentList>


type Erforderlich Gibt den Typ von Filtern in dieser Listevon abhängigen Filtern an.

Wert: global, system, group oder user


list Erforderlich Definiert die Filter, die einem abhängi-gen Filter zugeordnet sind. Der Wertdes Attributs enthält eine durch Kom-mas getrennte Liste mit einem odermehreren Filternamen.

Wert: Liste von Filternamen



Regeln für abhängige Filter

Jeder Typ von abhängigem Filter kann, wie durch den Wert des Attributs type imElement <dependentList> festgelegt, nur von bestimmten Filtertypen abhängen:

Tabelle 43. Regeln für die Filtertypen, von denen ein abhängiger Filter abhängen kann

Typ des abhängi-gen Filters Regeln

GlobalSystem

Ein abhängiger globaler Filter oder Systemfilter:

v Kann von globalen Filtern oder Systemfiltern abhängen.

v Kann nicht von Benutzerfiltern abhängen.

Benutzer Ein abhängiger Benutzerfilter:


v Kann von anderen Benutzerfiltern für denselben Benutzer abhängen.

Gruppe Ein abhängiger Gruppenfilter:


v Kann von anderen Gruppenfiltern für dieselbe Benutzergruppe ab-hängen.

v Kann nicht von Benutzerfiltern abhängen.

Beispiel: Ereignisfilter

Im folgenden Beispiel wird ein Filter mit dem Namen exampleFilter1 hinzugefügt,der die folgenden Merkmale hat:v Die SQL-WHERE-Klausel: Severity>=0v Die Messwertbezeichnung: Metric:v Der Name der Sicht, die dem Filter zugeordnet ist: advancedv Der Filter ist ein globaler Filter.v Der Name der Datenquelle: NCOMS<methodCall><method methodName="filter.addFilter"><filter name="exampleFilter1"sql="Severity >=0"metriclabel="Metric : "view="advanced"type="global"datasource="NCOMS"/></method></methodCall>

Beispiel: Gruppenfilter

Im folgenden Beispiel wird ein Gruppenfilter mit dem Namen exampleGroupFilterhinzugefügt, der die folgenden Merkmale hat:v Die SQL-WHERE-Klausel: Severity>=0v Die Messwertbezeichnung: Metric:v Der Name der Sicht, die dem Filter zugeordnet ist, lautet advanced und die Sicht

hat den Typ global.v Der Filter ist für Benutzer in den Gruppen Netcool_OMNIbus_Admin und

Netcool_OMNIbus_User verfügbar.v Der Name der Datenquelle: NCOMS


<methodCall><method methodName="filter.addFilter"><filter name="exampleGroupFilter"sql="Severity >=0"metriclabel="Metric : "view="advanced"viewtype="global"type="group"group="Netcool_OMNIbus_Admin,Netcool_OMNIbus_User"datasource="NCOMS"/>


Beispiel: Abhängiger Filter

Im folgenden Beispiel wird ein abhängiger Filter mit dem Namen exampleFilter3hinzugefügt, der die folgenden Merkmale hat:v Die Messwertbezeichnung: Metric:v Der Name der Sicht, die dem Filter zugeordnet ist: advancedv Der Filter ist ein globaler Filter.v Der Name der Datenquelle: NCOMSv Der Filter hängt von den Filtern mit den Namen dependentfilter1 und

dependentfilter2 ab.<methodCall><method methodName="filter.addFilter"><filter name="exampleFilter3"metriclabel="Metric : "view="advanced"type="global"mode="dependent"datasource="NCOMS"><dependentlist type="global" list="dependentFilter1,dependentFilter2"/></filter></method></methodCall>

Filter erstellen oder ersetzenDas Element <method> zum Erstellen oder Ersetzen eines Filters hat das folgendeFormat:<method methodName="filter.createOrReplaceFilter">

Mit dieser Methode können Sie einen neuen Filter erstellen oder einen bereits vor-handenen Filter ersetzen. Das Element <method> enthält ein oder mehrere Elemente<filter>, die jeweils die Merkmale eines Filters definieren. Weitere Informationenfinden Sie in „<filter>” auf Seite 83.

Für einen abhängigen Filter enthält das Element <filter> eine oder mehrere Ins-tanzen des Elements <dependentlist>. Weitere Informationen finden Sie in„<dependentlist>” auf Seite 85.

Im folgenden Beispiel wird ein Filter mit dem Namen exampleFilter2 erstellt oderersetzt, der die folgenden Merkmale hat:v Die SQL-WHERE-Klausel: Severity>=1v Die Messwertbezeichnung: My Metric:

v Der Name der Sicht, die dem Filter zugeordnet ist: advancedv Der Filter ist ein globaler Filter.


v Der Name der Datenquelle: NCOMS<methodCall><method methodName="filter.createOrReplaceFilter"><filter name="exampleFilter2"sql="Severity >=1"metriclabel="My Metric : "view="advanced"type="global"datasource="NCOMS"/></method></methodCall>

Filter löschenDas Element <method> zum Löschen eines Filters hat das folgende Format:<method methodName="filter.deleteFilter">

Mit dieser Methode können Sie einen vorhandenen Filter löschen. Das Element<method> enthält ein oder mehrere Elemente <filter>, die jeweils einen zu löschen-den Filter definieren. Geben Sie im Element <filter> die Attribute name und typean. Geben Sie für Benutzerfilter außerdem das Attribut user an, um die Benutzerzu definieren, von denen der Filter entfernt werden soll. Analog verwenden Sie fürGruppenfilter das Attribut group, um die Gruppen zu definieren, von denen derFilter entfernt werden soll. Weitere Informationen finden Sie in „<filter>” auf Seite83.

Beispiel

Im folgenden Beispiel werden die globalen Filter mit den Namen exampleFilter1und exampleFilter3 sowie der Benutzerfilter mit dem Namen exampleFilter2 unddie globalen abhängigen Filter mit den Namen dependentFilter1 unddependentFilter2 gelöscht. Der Benutzerfilter wird von den Benutzer-IDs 'webtop-adminuser' und 'root' entfernt.<methodCall><method methodName="filter.deleteFilter"><filter name="exampleFilter1" type="global"/><filter name="exampleFilter2" type="user" user="webtopadminuser,root"/><filter name="exampleFilter3" type="global"/><filter name="dependentFilter1" type="global"/><filter name="dependentFilter2" type="global"/></method></methodCall>

Liste von Filtern abrufenDas Element <method> zum Abrufen einer Liste von Filtern hat das folgende For-mat:<method methodName="filter.getList" />

Mit dieser Methode können Sie eine Liste der Namen der definierten Filter abru-fen. Die Liste enthält einen separaten Abschnitt für jeden Filtertyp ('global', 'sys-tem', 'user' und 'group').

Diese Methode gibt keine Attribute der Filter, sondern nur die Namen zurück.


Beispiel<methodCall><method methodName="filter.getList" /></methodCall>

Filter ändernDas Element <method> zum Ändern eines Filters hat das folgende Format:<method methodName="filter.modify">

Mit dieser Methode können Sie die Merkmale eines vorhandenen Filters ändern.Das Element <method> enthält ein oder mehrere Elemente <filter>, die jeweils dieneuen Merkmale eines vorhandenen Filters definieren. Geben Sie nur die Attributedes Elements <filter> an, die den Merkmalen entsprechen, die Sie ändern wollen.Wenn Sie ein Attribut nicht angeben, wird das entsprechende Merkmal nicht ge-ändert. Weitere Informationen finden Sie in „<filter>” auf Seite 83.

Für einen abhängigen Filter enthält das Element <filter> eine oder mehrere Ins-tanzen des Elements <dependentlist>. Weitere Informationen finden Sie in„<dependentlist>” auf Seite 85.

Beispiel

Im folgenden Beispiel wird der Filter mit dem Namen exampleFilter1 durch diefolgenden Änderungen an den Merkmalen des Filters geändert:v Die SQL-WHERE-Klausel wird in lastOccurrence >= getdate-1800 geändert.v Die Messwertbezeichnung wird in MyMetric: geändert.

Darüber hinaus werden dem Filter in diesem Beispiel die folgenden Merkmale hin-zugefügt:v Die Sicht ist eine globale Sicht.v Der Messwert ist der Durchschnittswert des Felds SubDivision.<methodCall><method methodName="filter.modifyFilter"><filter name="exampleFilter1"sql="LastOccurrence >= getdate -1800"metriclabel="MyMetric:"metricshow="Average"metricof="SubDivision"view = "advanced"viewtype="global"type="global"datasource="NCOMS"/></method></methodCall>


Standardsicht festlegenDas Element <method> zum Festlegen der Standardsicht hat das folgende Format:<method methodName="filter.setDefaultView">

Mit dieser Methode können Sie die Standardsicht festlegen, die einem Filter zuge-ordnet wird. Das Element <method> enthält ein oder mehrere Elemente <filter>,die jeweils einen Filter definieren, dem eine Standardsicht zugeordnet werden soll.Schließen Sie in das Element <filter> das Attribut name zur Angabe des Filters so-wie die Attribute view und viewtype zur Angabe der Standardsicht für den betref-fenden Filter ein. Weitere Informationen finden Sie in „<filter>” auf Seite 83.

Beispiel

Im folgenden Beispiel wird die globale Sicht mit dem Namen Default dem Filtermit dem Namen exampleFilter1 zugeordnet:<methodCall><method methodName="filter.setDefaultView"><filter name="exampleFilter1" view="Default" viewtype="global"/></method></methodCall>

FilterobjektgruppenanforderungenFilterobjektgruppen sind logische Gruppierungen von Filtern, die in der Regel fürEntitätsdaten verwendet werden, die aus Netcool/Webtop migriert wurden. Es gibtFunktionen zum Erstellen, Ändern, Löschen und Auflisten von Filterobjektgrup-pen. Sie können außerdem Filter einer Objektgruppe hinzufügen, eine Liste vonFilterobjektgruppen abrufen und die Standardsicht festlegen.

WAAPI stellt acht Methoden für die Arbeit mit Filterobjektgruppen bereit: Filterob-jektgruppe erstellen, Filterobjektgruppe erstellen oder ersetzen, Filterobjektgruppeändern, Filterobjektgruppe löschen, Filter einer Filterobjektgruppe hinzufügen, Fil-ter aus einer Filterobjektgruppe löschen, Liste von Filterobjektgruppen abrufen undSicht für eine Filterobjektgruppe festlegen.

Filterobjektgruppe erstellenDas Element <method> zum Erstellen einer Filterobjektgruppe hat das folgende For-mat:<method methodCall="filtercollection.createFilterCollection">

Mit dieser Methode können Sie eine neue Filterobjektgruppe definieren. Das Ele-ment <method> enthält ein oder mehrere Elemente <filterCollection>, die jeweilsdie Merkmale einer neuen Objektgruppe definieren. Jedes dieser Elemente enthältein oder mehrere Elemente <filter>, die die Filter angeben, die zu der Objekt-gruppe gehören. Sie können nur Systemfilter und globale Filter angeben, die be-reits im System vorhanden sind. In den Elementen <filter> werden nur die Attri-bute name und type zur Angabe des Filters verwendet. Weitere Informationenfinden Sie in „<filter>” auf Seite 83.v „<filterCollection>” auf Seite 91v „Beispiel” auf Seite 91


<filterCollection>

Das Element <filterCollection> definiert die Merkmale einer Filterobjektgruppe.Das Element enthält ein oder mehrere Elemente <filter>, die die Filter in der Ob-jektgruppe jeweils durch die beiden Attribute name und type angeben, und hat diefolgenden Attribute:

Tabelle 44. Attribute des Elements <filterCollection>


name Erforderlich Gibt einen eindeutigen Namen für eineFilterobjektgruppe an.

Wert: Zeichenfolge


description Optional Definiert eine Textbeschreibung derFilterobjektgruppe.

Wert: Zeichenfolge


viewName Optional Gibt die Sicht an, die dem Filter zuge-ordnet ist.

Wert: Zeichenfolge


viewType Optional Gibt den Typ der Sicht an.


Standardwert: global

Beispiel

Im folgenden Beispiel wird eine Filterobjektgruppe mit dem Namentestcollection erstellt, die zwei Filter mit den Namen Example_Critical undAllEvents enthält.<methodCall><method methodName="filtercollection.createFilterCollection"><filterCollection name="testcollection" viewName="Default"viewType="global" description="A collection of filters for testing"><filter name="Example_Critical" type="system"/><filter name="AllEvents" type="global"/></filterCollection></method></methodCall>

Filter einer Filterobjektgruppe hinzufügenDas Element <method> zum Hinzufügen eines Filters zu einer Objektgruppe hatdas folgende Format:<method methodCall="filtercollection.addFilter">

Mit dieser Methode können Sie einen Filter einer vorhandenen Filterobjektgruppehinzufügen. Das Element <method> enthält ein oder mehrere Elemente <filter-Collection>, die jeweils eine Objektgruppe angeben. Weitere Informationen findenSie in „<filterCollection>”. Jedes dieser Elemente enthält ein oder mehrere Elemen-te <filter>, die die Filter angeben, die der Objektgruppe hinzugefügt werden sol-len. Sie können nur Systemfilter und globale Filter angeben, die bereits im System


vorhanden sind. In den Elementen <filter> werden nur die Attribute name undtype zur Angabe des Filters verwendet. Weitere Informationen finden Sie in„<filter>” auf Seite 83.

Beispiel

Im folgenden Beispiel werden Filter mit den Namen Last10Mins und Informationder Objektgruppe mit dem Namen testcollection2 hinzugefügt.<methodCall><method methodName="filtercollection.addFilter"><filterCollection name="testcollection2"><filter name="Last10Mins" type="global"/><filter name="Information" type="global"/></filterCollection></method></methodCall>

Filterobjektgruppe erstellen oder ersetzenDas Element <method> zum Erstellen oder Ersetzen einer Filterobjektgruppe hat dasfolgende Format:<method methodCall="filtercollection.createOrReplaceFilterCollection">

Mit dieser Methode können Sie eine neue Filterobjektgruppe erstellen oder eine be-reits vorhandene Filterobjektgruppe ersetzen. Das Element <method> enthält einoder mehrere Elemente <filterCollection>, die jeweils die Merkmale einer Ob-jektgruppe definieren. Weitere Informationen finden Sie in „<filterCollection>” aufSeite 91. Jedes dieser Elemente enthält ein oder mehrere Elemente <filter>, die dieFilter angeben, die zu der Objektgruppe gehören. Sie können nur Systemfilter undglobale Filter angeben, die bereits im System vorhanden sind. In den Elementen<filter> werden nur die Attribute name und type zur Angabe des Filters verwen-det. Weitere Informationen finden Sie in „<filter>” auf Seite 83.

Beispiel

Im folgenden Beispiel wird eine Filterobjektgruppe mit dem Namentestcollection2 erstellt oder ersetzt.<methodCall><method methodName="filtercollection.createOrReplaceFilterCollection"><filterCollection name="testcollection2" viewName="Default"viewType="global" description="Another collection of filters for testing"><filter name="Escalated" type="global"/><filter name="AllEvents" type="global"/></filterCollection></method></methodCall>

Filterobjektgruppe löschenDas Element <method> zum Löschen einer Filterobjektgruppe hat das folgende For-mat:<method methodCall="filtercollection.deleteFilterCollection">

Mit dieser Methode können Sie eine vorhandene Filterobjektgruppe löschen. DasElement <method> enthält ein oder mehrere Elemente <filterCollection>, die je-weils eine zu löschende Objektgruppe angeben. Geben Sie im Element<filterCollection> nur das Attribut name an. Weitere Informationen finden Sie in„<filterCollection>” auf Seite 91.


Beispiel

Im folgenden Beispiel wird die Filterobjektgruppe mit dem Namen testCollectiongelöscht.<methodCall><method methodName="filtercollection.deleteFilterCollection"><filterCollection name="testcollection"/></method></methodCall>

Filter aus einer Filterobjektgruppe löschenDas Element <method> zum Löschen eines Filters aus einer Filterobjektgruppe hatdas folgende Format:<method methodCall="filtercollection.deleteFilter">

Mit dieser Methode können Sie einen Filter aus einer vorhandenen Filterobjekt-gruppe löschen. Das Element <method> enthält ein oder mehrere Elemente <filter-Collection>, die jeweils eine Objektgruppe angeben. Weitere Informationen findenSie in „<filterCollection>” auf Seite 91. Jedes dieser Elemente enthält ein oder meh-rere Elemente <filter>, die die Filter angeben, die aus der Objektgruppe gelöschtwerden sollen. In den Elementen <filter> werden nur die Attribute name und typezur Angabe der Filter verwendet. Weitere Informationen finden Sie in „<filter>”auf Seite 83.

Beispiel

Im folgenden Beispiel wird der Filter mit dem Namen Information aus der Objekt-gruppe mit dem Namen testcollection2 entfernt.<methodCall><method methodName="filtercollection.deleteFilter"><filterCollection name="testcollection2"><filter name="Information" type="global"/></filterCollection></method></methodCall>

Liste von Filterobjektgruppen abrufenDas Element <method> zum Abrufen einer Liste von Filterobjektgruppen hat dasfolgende Format:<method methodCall="filtercollection.getList">

Mit dieser Methode können Sie eine Liste der definierten Filterobjektgruppen abru-fen.

Beispiel<methodCall><method methodName="filtercollection.getList /></methodCall>


Filterobjektgruppe ändernDas Element <method> zum Ändern einer Filterobjektgruppe hat das folgende For-mat:<method methodCall="filtercollection.modifyFilterCollection">

Mit dieser Methode können Sie die Merkmale einer vorhandenen Filterobjektgrup-pe ändern. Das Element <method> enthält ein oder mehrere Elemente <filterColl-ection>, die jeweils die Merkmale einer Objektgruppe definieren. Jedes dieser Ele-mente enthält ein oder mehrere Elemente <filter>, die die Filter angeben, die zuder Objektgruppe gehören. Sie können nur Systemfilter und globale Filter angeben,die bereits im System vorhanden sind. In den Elementen <filter> werden nur dieAttribute name und type zur Angabe des Filters verwendet.

Beispiel

Im folgenden Beispiel wird die Filterobjektgruppe mit dem NamentestCollection2 geändert.<methodCall><method methodName="filtercollection.modifyFilterCollection"><filterCollection name="testcollection2" viewName="Default" viewType="global"description="A new description for testcollection2"><filter name="TaskList" type="global"/><filter name="NetcoolStatus" type="global"/></filterCollection></method></methodCall>

Sicht für eine Filterobjektgruppe festlegenDas Element <method> zum Festlegen der Standardsicht einer Objektgruppe hat dasfolgende Format:<method methodName="filtercollection.setView">

Mit dieser Methode können Sie die Sicht festlegen, die einer Filterobjektgruppe zu-geordnet wird. Das Element <method> enthält ein oder mehrere Elemente <filter-Collection>, die jeweils eine Objektgruppe definieren, der eine Standardsicht zuge-ordnet werden soll. Schließen Sie in das Element <filterCollection> das Attributname zur Angabe des Filters und die Attribute viewName und viewType zur Angabeder Sicht für den betreffenden Filter ein. Weitere Informationen finden Sie in„<filterCollection>” auf Seite 91.

Beispiel

Im folgenden Beispiel wird die Sicht für die Filterobjektgruppe mit dem Namentestcollection2 festgelegt.<methodCall><method methodName="filtercollection.setView"><filterCollection name="testcollection2" viewName="DefaultTable"viewType="global"/>



MesswertanforderungenMesswertanforderungen dienen zur Bearbeitung von Leistungsmesswerten, die vonder Web-GUI in Form von Messanzeige dargestellt werden. Es gibt Funktionenzum Erstellen, Ändern, Ersetzen und Löschen von Messwerten. Sie können außer-dem eine Liste der zurzeit definierten Messwerte abrufen. WAAPI stellt fünf Me-thoden für die Arbeit mit Messwerten bereit: Messwert erstellen, Messwert erstel-len oder ersetzen, Messwert ändern, Messwert löschen und Liste von Messwertenabrufen.

Messwert erstellenDas Element <method> zum Erstellen eines Messwerts hat das folgende Format:<method methodName="metric.create">

Mit dieser Methode definieren Sie einen neuen Messwert für eine Messanzeige.Das Element <method> enthält ein oder mehrere Elemente <metric:metric>, die je-weils die Merkmale eines neuen Messwerts definieren.

Jedes Element <metric:metric> enthält eine Instanz des Elements <metric:com-mand>. Das Element <metric:command> enthält wiederum ein Element <metric-:text>.v „<metric:metric>”v „<metric:command>” auf Seite 97v „<metric:text>” auf Seite 98v „Beispiele” auf Seite 99

<metric:metric>

Das Element <metric:metric> definiert die Merkmale eines Messwerts und hat diefolgenden Attribute:

Tabelle 45. Attribute des Elements <metric:metric>


name Erforderlich Gibt einen eindeutigen Namen für ei-nen Messwert an.

Wert: Zeichenfolge


description Optional Definiert eine Textbeschreibung desMesswerts, die angezeigt wird, wennder Benutzer den Mauszeiger über dieMessanzeige bewegt. Wenn der aktuelleWert des Messwerts in der Beschrei-bung angegeben werden soll, fügen Sieden Platzhalter {0} an der gewünschtenPosition ein.

Wert: Zeichenfolge



Tabelle 45. Attribute des Elements <metric:metric> (Forts.)


descriptionKey Optional Ein Schlüssel für das Attribut'description', das dieses unter allen defi-nierten Messwerten eindeutig identifi-ziert. Lassen Sie dieses Attribut weg,wenn das System automatisch eineneindeutigen Schlüssel für Sie generierensoll.

Wert: Zeichenfolge

Standardwert: Ein systemgenerierterWert.

displayName Optional Der Name des Messwerts, der auf derSeite "Messanzeigen" unterhalb einerMessanzeige angezeigt wird.

Wert: Zeichenfolge


displayNameKey Optional Ein Schlüssel für das AttributdisplayName, das dieses unter allen defi-nierten Messwerten eindeutig identifi-ziert. Lassen Sie dieses Attribut weg,wenn das System automatisch eineneindeutigen Schlüssel für Sie generierensoll.

Wert: Zeichenfolge


units Optional Definiert die Einheiten für den Mess-wert. Dabei kann es sich z. B. um dieAnzahl von Vorfällen oder die Anzahlder Clientverbindungen zu einem Ser-ver handeln.

Wert: Zeichenfolge


unitsKey Optional Ein Schlüssel für das Attribut 'units',das dieses unter allen definierten Mess-werten eindeutig identifiziert. LassenSie dieses Attribut weg, wenn das Sys-tem einen eindeutigen Schlüssel für Siegenerieren soll.

Wert: Zeichenfolge


maxValue Optional Definiert den Maximalwert für einenMesswert entsprechend den für denMesswert definierten Einheiten.

Wert: Integer



Tabelle 45. Attribute des Elements <metric:metric> (Forts.)


minValue Optional Definiert den Mindestwert für einenMesswert entsprechend den für denMesswert definierten Einheiten.

Wert: Integer


threshold1 Optional Definiert den Schwellenwert für denunteren und den mittleren Wertebereichfür einen Messwert. Das Attribut defi-niert den Schwellenwert als Prozent-wert bezogen auf den Wertebereich desMesswerts. Der Wert muss unter demWert für threshold2 liegen.

Wert: Integer


threshold2 Optional Definiert den Schwellenwert für denmittleren und den oberen Wertebereichfür einen Messwert. Das Attribut defi-niert den Schwellenwert als Prozent-wert bezogen auf den Wertebereich desMesswerts. Der Wert muss über demWert für threshold1 liegen.

Wert: Integer


Jedes Element <metric::metric> kann eine Instanz des Elements <metric:command>enthalten.

<metric:command>

Das Element <metric:command> definiert den Befehl, der Werte für den Messwertgeneriert. In der Regel handelt es sich hierbei um einen SQL-Befehl, der die Object-Server-Datenbank abfragt. Das Element kann die folgenden Attribute haben:

Tabelle 46. Attribute des Elements <metric:command>


type Optional Definiert den Typ von Befehl, der Wertefür den Messwert generiert. Gegenwär-tig ist sql der einzig gültige Wert fürdieses Attribut.

Wert: Zeichenfolge

Standardwert: sql


Tabelle 46. Attribute des Elements <metric:command> (Forts.)


mode Optional Definiert den Modus, in dem der Mess-wert zu verwenden ist. Im einfachenModus ('basic') werden alleEinschränkungsfilter angewendet, diefür die angegebenen Datenbanktabellenaktiv sind. Im erweiterten Modus('advanced') werdenEinschränkungsfilter nicht angewendet,wenn der Benutzer über eineMessanzeige auf den Messwert zugreift.

Wert: basic oder advanced

Standardwert: advanced

Wenn angegeben, enthält das Element <metric:command> genau eine Instanz desElements <metric:text>.

<metric:text>

Das Element <metric:text> enthält den Befehl, der Werte für den Messwert gene-riert. Das Element hat die folgenden Attribute:

Tabelle 47. Attribute des Elements <metric:text>


data Siehe Beschrei-bung.

Enthält den Text des Befehls, der zurGenerierung von Werten für den Mess-wert verwendet wird. Dieses Attributist erforderlich, wenn das Attribut modedes Elements <metric:command> nichtangegeben wird oder den Wertadvanced hat.

Wert: Zeichenfolge


selectField Siehe Beschrei-bung.

Enthält das Tabellenfeld oder eineAggregatfunktion der SELECT-Klauseldes Befehls, der zur Generierung vonWerten für den Messwert verwendetwird. Dieses Attribut ist erforderlich,wenn das Attribut mode des Elements<metric:command> den Wert basic hat.

Wert: Zeichenfolge


whereClause Siehe Beschrei-bung.

Enthält die WHERE-Klausel des Be-fehls, der zur Generierung von Wertenfür den Messwert verwendet wird. Die-ses Attribut ist erforderlich, wenn dasAttribut mode des Elements<metric:command> den Wert basic hat.

Wert: Zeichenfolge



Tabelle 47. Attribute des Elements <metric:text> (Forts.)


databaseName Siehe Beschrei-bung.

Enthält die Datenbanknamensklauseldes Befehls, der zur Generierung vonWerten für den Messwert verwendetwird. Dieses Attribut ist erforderlich,wenn das Attribut mode des Elements<metric:command> den Wert basic hat.

Wert: Zeichenfolge


tableName Siehe Beschrei-bung.

Enthält die Tabellennamensklausel desBefehls, der zur Generierung von Wer-ten für den Messwert verwendet wird.Dieses Attribut ist erforderlich, wenndas Attribut mode des Elements<metric:command> den Wert basic hat.

Wert: Zeichenfolge


Beispiele

Im folgenden Beispiel wird ein Messwert mit dem Namen metricsample1 im er-weiterten Modus ('advanced') erstellt. Der neue Messwert misst die Anzahl ausste-hender kritischer Ereignisse und hat die folgenden Merkmale:v Den Minimalwert 0 und den Maximalwert 10000v Den Schwellenwert 30% für den unteren bis mittleren Wertebereichv Den Schwellenwert 70% für den mittleren bis oberen Wertebereich<methodCall xmlns:metric="http://www.ibm.com/tivoli/netcool/webtop/metrics/7.4.0"><method methodName="metric.createMetric"><metric:metric name="metricsample1"displayName="MetricSample1"description="Kritische Ereignisse. Aktueller Wert: {0}"units="events"maxValue="10000"minValue="0"threshold1="30"threshold2="70"><metric:command type="sql"><metric:text data="select sum(Tally) from alerts.status where Severity=5;"/></metric:command></metric:metric></method></methodCall>

Im folgenden Beispiel wird ein ähnlicher Messwert im einfachen Modus ('basic') er-stellt. Daher werden alle Einschränkungsfilter angewendet, die aktiv sind, wennder Benutzer auf den Messwert zugreift.<methodCall><method methodName="metric.createMetric"><metric:metric name="metricsample1"displayName="MetricSample1"description="Kritische Ereignisse. Aktueller Wert: {0}"units="events"maxValue="10000"minValue="0"


threshold1="30"threshold2="70"><metric:command type="sql" mode="basic"><metric:text selectField="sum(Tally)" whereClause="Severity=5"databaseName="alerts" tableName="status"/></metric:command></metric:metric></method></methoodCall>

Messwert erstellen oder ersetzenDas Element <method> zum Erstellen oder Ersetzen eines Messwerts hat das folgen-de Format:<method methodName="metric.createOrReplaceMetric">

Mit dieser Methode können Sie einen vorhandenen Messwert ersetzen oder einenneuen Messwert erstellen, wenn er noch nicht vorhanden ist. Das Element<method> enthält ein oder mehrere Elemente <metric:metric>, die jeweils dieMerkmale eines neuen Messwerts definieren. Jedes Element <metric:metric> ent-hält ein Element <metric:command>, das wiederum ein Element <metric:text> ent-hält. Weitere Informationen finden Sie in den folgenden Beschreibungen dieser Ele-mente:v „<metric:metric>” auf Seite 95v „<metric:command>” auf Seite 97v „<metric:text>” auf Seite 98

Beispiel

Im folgenden Beispiel wird ein Messwert mit dem Namen metricsample2 im er-weiterten Modus erstellt oder ersetzt. Der neue Messwert misst die Anzahl ausste-hender bedeutender Ereignisse und hat die folgenden Merkmale:v Den Minimalwert 0v Den Maximalwert 100v Den Schwellenwert 40% für den unteren bis mittleren Wertebereichv Den Schwellenwert 80% für den mittleren bis oberen Wertebereich<methodCall xmlns:metric="http://www.ibm.com/tivoli/netcool/webtop/metrics/7.4.0"><method methodName="metric.createOrReplaceMetric"><metric:metric name="metricsample2"displayName="MetricSample2"description="Bedeutende Ereignisse. Aktueller Wert: {0}"units="events"maxValue="100"minValue="0"threshold1="40"threshold2="80"><metric:command type="sql"><metric:text data="select sum(Tally) from alerts.status where Severity=4;"/></metric:command></metric:metric></method></methodCall>

Zum Erstellen oder Ersetzen eines Messwerts im einfachen Modus verwenden Siedasselbe Format der Elemente <metric:command> und <metric:text>, das im Bei-spiel zum Erstellen eines Messwerts im einfachen Modus gezeigt wird.


Messwert löschenDas Element <method> zum Löschen eines Messwerts hat das folgende Format:<method methodName="metric.deleteMetric">

Mit dieser Methode können Sie einen vorhandenen Messwert löschen. Das Element<method> enthält ein oder mehrere Elemente <metric:metric>, die jeweils einen zulöschenden Messwert angeben. Geben Sie im Element <metric:metric> nur das At-tribut name an. Weitere Informationen finden Sie in „<metric:metric>” auf Seite 95.

Beispiel

Im folgenden Beispiel wird der Messwert mit dem Namen metricsample2 gelöscht.<methodCall xmlns:metric="http://www.ibm.com/tivoli/netcool/webtop/metrics/7.4.0"><method methodName="metric.deleteMetric"><metric:metric name="metricsample2"/></method></methodCall>

Liste von Messwerten abrufenDas Element <method> zum Abrufen einer Liste von Messwerten hat das folgendeFormat:<method methodName="metric.getList" />

Mit dieser Methode können Sie eine Liste der Namen der definierten Messwerteabrufen.

Beispiel<methodCall xmlns:metric="http://www.ibm.com/tivoli/netcool/webtop/metrics/7.4.0"><method methodName="metric.getList" /></methodCall>

Messwert ändernDas Element <method> zum Ändern eines Messwerts hat das folgende Format:<method methodName="metric.modifyMetric">

Mit dieser Methode können Sie die Merkmale eines vorhandenen Messwerts än-dern. Das Element <method> enthält ein oder mehrere Elemente <metric:metric>,die jeweils die neuen Merkmale eines vorhandenen Messwerts definieren. GebenSie nur die Attribute des Elements <metric:metric> an, die den Merkmalen ent-sprechen, die Sie ändern wollen. Wenn Sie ein Attribut nicht angeben, wird dasentsprechende Merkmal nicht geändert.

Zum Ändern des Befehls, der dem Messwert zugeordnet ist, geben Sie ein<metric:command> an, das wiederum das Element <metric:text> enthält.

Weitere Informationen finden Sie in den folgenden Beschreibungen dieser Elemen-te:v „<metric:metric>” auf Seite 95v „<metric:command>” auf Seite 97v „<metric:text>” auf Seite 98


Beispiel

Im folgenden Beispiel wird der Messwert mit dem Namen metricsample1 durchdie folgenden Änderungen an den Merkmalen des Messwerts geändert:v Der Text der Beschreibung wird erweitert.v Der Maximalwert wird von 10000 in 250 geändert.v Der Schwellenwert für den niedrigen bis mittleren Wertebereich wird von 30%

in 40% geändert.v Der Schwellenwert für den mittleren bis hohen Wertebereich wird von 70% in

90% geändert.<methodCall xmlns:metric="http://www.ibm.com/tivoli/netcool/webtop/metrics/7.4.0"><method methodName="metric.modifyMetric"><metric:metric name="metricsample1"displayName="MetricSample1"description="Kritische Ereignisse. Geändert von WAAPI. Aktueller Wert: {0}"units="events"maxValue="250"minValue="0"threshold1="40"threshold2="90"><metric:command type="sql"><metric:text data="select sum(Tally) from alerts.status where Severity=5;"/></metric:command></metric:metric></method></methodCall>

Zum Ändern eines Messwerts im einfachen Modus verwenden Sie dasselbe Formatder Elemente <metric:command> und <metric:text>, das im Beispiel zum Erstelleneines Messwerts im einfachen Modus gezeigt wird.

BeziehungsanforderungenBeziehungsanforderungen dienen zur Bearbeitung von Ereignisbeziehungen, diedie Anzeige von Ereignissen in der Ereignisanzeige verbessern können. Es gibtFunktionen zum Erstellen, Ändern, Ersetzen und Löschen von Beziehungen. Siekönnen außerdem eine Liste der zurzeit definierten Beziehungen abrufen. WAAPIstellt fünf Methoden für die Arbeit mit Beziehungen bereit: Beziehung erstellen, Be-ziehung erstellen oder ersetzen, Beziehung ändern, Beziehung löschen und Listevon Beziehungen abrufen.

Beziehung erstellenDas Element <method> zum Erstellen einer Beziehung hat das folgende Format:<method methodName="relationship.createRelationship">

Mit dieser Methode können Sie eine neue Beziehung zur Verwendung in der Ereig-nisanzeige erstellen. Das Element <method> enthält ein oder mehrere Elemente<relationship:relationship>, die jeweils die Merkmale einer neuen Beziehung de-finieren.

Jedes Element <relationship:relationship> enthält eine Instanz des Elements<relationship:definition>. Das Element <relationship:definition> enthält wie-derum eine Instanz des Elements <relationship:relationshipColumn>.v „<relationship:relationship>” auf Seite 103v „<relationship:definition>” auf Seite 104v „<relationship:relationshipColumn>” auf Seite 104


v „Beispiel” auf Seite 105

<relationship:relationship>

Das Element <relationship:relationship> definiert die Merkmale einer Beziehungund hat die folgenden Attribute:

Tabelle 48. Attribute des Elements <relationship:relationship>


name Erforderlich Gibt einen eindeutigen Namen für eineBeziehung an.

Wert: Zeichenfolge


description Optional Definiert eine Textbeschreibung der Be-ziehung. Diese wird imBeziehungseditor in der Web-GUI ange-zeigt.

Wert: Zeichenfolge


descriptionKey Optional Ein Schlüssel für das Attribut'description', das dieses unter allen defi-nierten Beziehungen eindeutig identifi-ziert. Lassen Sie dieses Attribut weg,wenn das System automatisch eineneindeutigen Schlüssel für Sie generierensoll.

Wert: Zeichenfolge


displayName Erforderlich Der Name der Beziehung, wie sie imBeziehungseditor angezeigt wird.

Wert: Zeichenfolge


displayNameKey Optional Ein Schlüssel für das AttributdisplayName, das dieses unter allen defi-nierten Beziehungen eindeutig identifi-ziert. Sie können dieses Attributweglassen, wenn das System automa-tisch einen eindeutigen Schlüssel für Siegenerieren soll. Die Angabe dieses At-tributs hilft jedoch bei der Implementie-rung der Globalisierung IhrerAnwendung, bei der dieser Wert dielokalisierte Version des Anzeigenamensin verschiedenen Sprachen identifiziert.

Wert: Zeichenfolge



Tabelle 48. Attribute des Elements <relationship:relationship> (Forts.)


dataSources Optional Der Name der Datenquelle, die Ereig-nisse bereitstellt, die entsprechend die-ser Beziehung gruppiert werden sollen.Geben Sie mehrere Datenquellen in ei-ner durch Kommas getrennten Liste an.

Wert: Zeichenfolge


Jedes Element <relationship:relationship> enthält eine Instanz des Elements<relationship:definition>.

<relationship:definition>

Das Element <relationship:definition> definiert eine Beziehung zwischen zweiFeldern im ObjectServer und hat das folgende Attribut:

Tabelle 49. Attribute des Elements <relationship:definition>


type Erforderlich Definiert den Typ einer Beziehung. Ge-genwärtig ist relationshipColumn dereinzig gültige Wert für dieses Attribut.

Wert: Zeichenfolge

Standardwert: relationshipColumn

Wenn angegeben, enthält das Element <relationship:definition> genau eine Ins-tanz des Elements <relationship:relationshipColumn>.

<relationship:relationshipColumn>

Das Element <relationship:relationshipColumn> definiert zwei ObjectServer-Spal-ten, die eine Ereignisbeziehung bilden, und hat die folgenden Attribute:

Tabelle 50. Attribute des Elements <relationship:relationshipColumn>


column Erforderlich Definiert die Spalte, die die Beziehungdefiniert.

Wert: Zeichenfolge


keyColumn Erforderlich Definiert den Namen der Spalte, derder Schlüssel für die Spalte ist, die imAttribut column definiert wird.

Wert: Zeichenfolge



Beispielv Im folgenden Beispiel wird eine Beziehung mit dem Namen

SummaryRelationship1 hinzugefügt, die die folgenden Merkmale hat:– Sie verwendet die Spalte mit dem Namen 'NmosSerial'.– Als Schlüsselspalte wird die Spalte 'Summary' definiert.<methodCall xmlns:relationship="http://www.ibm.com/tivoli/netcool/webtop/relationships/8.1"><method methodName="relationship.createRelationship"><relationship:relationship name="SummaryRelationship1"displayName="RelationshipSample1"description="Eine mit WAAPI erstellte Beispielbeziehung."><relationship:definition type="relationshipColumn"><relationship:relationshipColumn column="NmosSerial" keyColumn="Summary"/></relationship:definition></relationship:relationship></method></methodCall>

Beziehung erstellen oder ersetzenDas Element <method> zum Erstellen oder Ersetzen einer Beziehung hat das folgen-de Format:<method methodName="relationship.createOrReplaceRelationship">

Mit dieser Methode können Sie eine vorhandene Beziehung ersetzen oder eineneue Beziehung erstellen, wenn sie noch nicht vorhanden ist. Das Element<method> enthält ein oder mehrere Elemente <relationship:relationship>, die je-weils die Merkmale einer Beziehung definieren. Jedes Element<relationship:relationship> enthält ein Element <relationship:definition>, daswiederum ein Element <relationship:relationshipColumn> enthält. Weitere Infor-mationen zum Element <relationship:relationship> und den zugehörigen Unter-elementen finden Sie in „<relationship:relationship>” auf Seite 103.

Im folgenden Beispiel wird eine Beziehung mit dem Namen SummaryRelationship2erstellt oder ersetzt.<methodCall xmlns:relationship="http://www.ibm.com/tivoli/netcool/webtop/relationships/8.1"><method methodName="relationship.createOrReplaceRelationship"><relationship:relationship name="SummaryRelationship2"displayName="RelationshipSample1"description="Ein Beispiel für eine mit WAAPI erstellte Beziehung."><relationship:definition type="relationshipColumn"><relationship:relationshipColumn column="ParentSerial" keyColumn="Serial"/></relationship:definition></relationship:relationship></method></methodCall>


Beziehung löschenDas Element <method> zum Löschen einer Beziehung hat das folgende Format:<method methodName="relationship.deleteRelationship">

Mit dieser Methode können Sie eine vorhandene Beziehung löschen. Das Element<method> enthält ein oder mehrere Elemente <relationship:relationship>, die je-weils eine zu löschende Beziehung definieren. Geben Sie im Element<relationship:relationship> nur das Attribut name an. Weitere Informationenzum Element <relationship:relationship> und den zugehörigen Unterelementenfinden Sie in „<relationship:relationship>” auf Seite 103.

Im folgenden Beispiel wird eine Beziehung mit dem Namen SummaryRelationship2gelöscht.<methodCall xmlns:relationship="http://www.ibm.com/tivoli/netcool/webtop/relationships/8.1"><method methodName="relationship.deleteRelationship"><relationship:relationship name="SummaryRelationship2"</relationship:relationship></method></methodCall>

Liste von Beziehungen abrufenDas Element <method> zum Abrufen einer Liste von Beziehungen hat das folgendeFormat:<method methodName="relationship.getList">

Mit dieser Methode können Sie eine Liste der Namen der definierten Beziehungenabrufen.<methodCall xmlns:relationship="http://www.ibm.com/tivoli/netcool/webtop/relationships/8.1"><method methodName="relationship.getList" /></methodCall>

Beziehung ändernDas Element <method> zum Ändern einer Beziehung hat das folgende Format:<method methodName="relationship.modifyRelationship">

Mit dieser Methode können Sie die Merkmale einer vorhandenen Beziehung än-dern. Das Element <method> enthält ein oder mehrere Elemente <relationship:re-lationship>, die jeweils die neuen Merkmale einer vorhandenen Beziehung defi-nieren. Geben Sie nur die Attribute des Elements <relationship:relationship> an,die Sie ändern wollen. Wenn Sie ein Attribut nicht angeben, wird das entsprechen-de Merkmal nicht geändert.

Das Element <relationship:relationship> enthält kein oder ein Element <relati-onship:definition>. Geben Sie dieses Element nur an, wenn Sie die Spalten än-dern wollen, die einer Beziehung zugeordnet sind. Wenn es angegeben wird, ent-hält das Element <relationship:definition> genau ein Element<relationship:relationshipColumn>. Weitere Informationen zum Element<relationship:relationship> und den zugehörigen Unterelementen finden Sie in„<relationship:relationship>” auf Seite 103.

Im folgenden Beispiel wird die Beschreibung einer Beziehung mit dem NamenSummaryRelationship1 geändert:


<methodCall xmlns:relationship="http://www.ibm.com/tivoli/netcool/webtop/relationships/8.1"><method methodName="relationship.modifyRelationship"><relationship:relationship name="SummaryRelationship1"description="Beziehung auf Basis des Felds ’Summary’"></relationship:relationship></method></methodCall>

Sonstige AnforderungenEs stehen verschiedene Funktionen zur Verfügung, mit denen Sie den Web-GUI-Cache resynchronisieren, einen Knoten aus einem Cluster entfernen, einen Status-bericht generieren sowie die Filter und Sichten des Servers erneut laden können.

WAAPI stellt vier weitere Funktionen bereit:v Systemstatusbericht generierenv Filter und Sichten erneut ladenv Knoten aus einem Lastausgleichscluster entfernenv Web-GUI-Cache mit der ObjectServer-Datenbank resynchronisieren

Systemstatusbericht generierenDas Element <method> zur Generierung eines Systemstatusberichts hat das folgendeFormat:<method methodName="webtopprobe.generateReport">

Mit dieser Methode können Sie einen Statusbericht für die Web-GUI generieren.Der generierte Bericht enthält die gleichen Informationen, die auch von der Funkti-on unter Fehlerbehebung und Unterstützung > Systeminformationen fürNetcool/OMNIbus Web GUI der Web-GUI generiert werden, und enthält die fol-genden Abschnitte:v Versionsnummern der Web-GUI, von Dashboard Common Infrastructure (DCI)

und Java Runtime Environmentv Speicherbelegungsstatistikenv Informationen zur Laufzeitplattformv Verwendete Protokollev ObjectServer-Merkmale und Konfigurationsdaten, einschließlich Informationen

zum Cachev Alle Systemmerkmale, einschließlich der internen Merkmale der Web-GUI

Beispiel<methodCall><method methodName="webtopprobe.generateReport" /></methodCall>


Filter und Sichten erneut ladenDas Element <method> zum erneuten Laden von Filtern und Sichten hat das folgen-de Format:<method methodName="xmldao.reloadFiltersAndViews">

Mit dieser Methode können Sie die Web-GUI veranlassen, alle zurzeit aktiven Filterund Sichten erneut zu laden. Darüber hinaus veranlasst diese Methode LAE-Cli-ents, ihre Filter und Sichten bei der nächsten Neuanzeige zu aktualisieren.

Beispiel<methodCall><method methodName="xmldao.reloadFiltersAndViews" /></methodCall>

Knoten aus einem Lastausgleichscluster entfernenDas Element <method> zum Entfernen eines Knotens aus einem Cluster hat das fol-gende Format:<method methodName="cluster.removeNode">

Mit dieser Methode können Sie einen Knoten aus einem Lastausgleichscluster ent-fernen. Diese Methode entfernt den Knoten, an den Sie diese Anforderung senden.Wenn dies der letzte Knoten im Cluster ist, entfernt die Methode auch alle Konfi-gurationsdaten für den Lastausgleich.

Anmerkung: Diese Methode wird in Verbindung mit anderen Schritten im Rah-men eines längeren Prozesses verwendet. Dieser Befehl entfernt einen Knoten nurtemporär aus einem Lastausgleichscluster. Wenn der AppServer erneut gestartetwird, wird der Knoten wieder in den Cluster eingegliedert.

Weitere Informationen finden Sie unter Lastausgleichscluster verwalten im Web-GUIAdministrations- und Benutzerhandbuch.

Beispiel<methodCall><method methodName="cluster.removeNode" /></methodCall>

Web-GUI-Cache mit der ObjectServer-Datenbank resynchroni-sieren

Das Element <method> zur Resynchronisierung des Web-GUI-Cache mit der Object-Server-Datenbank hat das folgende Format:<method methodName="osresync.refreshOSCache" />

Mit dieser Methode können Sie die Web-GUI veranlassen, ihren Cache mit der Ob-jectServer-Datenbank zu resynchronisieren. Diese Funktion ist insbesondere nütz-lich, wenn die ObjectServer-Berechtigungen eines Benutzers geändert wurden, dasie sicherstellt, dass die Web-GUI über die neuesten Informationen verfügt und soden Benutzer ordnungsgemäß verwalten kann.

Beispiel<methodCall><method methodName="osresync.refreshOSCache" /></methodCall>


Anhang A. WAAPI-Merkmale und Befehlszeilenoptionen

Dieser Abschnitt enthält Informationen zu den Merkmalen und Befehlszeilenoptio-nen des WAAPI-Clients.

Die Merkmaldatei für den WAAPI-Client befindet sich in WEBGUI_HOME/waapi/etc/waapi.init. Bei der Ausführung des Befehls runwaapi werden standardmäßig diein dieser Datei angegebenen Merkmale verwendet.

Tipp: Wenn Sie eine andere Merkmaldatei angeben möchten, müssen Sie die Opti-on -props verwenden. Beispiel:runwaapi -props WEBGUI_HOME/waapi/etc/test/waapi.init

Verwenden Sie die WAAPI-Merkmaldatei für Merkmalwerte, die sich bei der Aus-führung des WAAPI-Clients voraussichtlich nicht ändern werden. Da sich Hostna-me und Port des WAAPI-Client normalerweise nicht ändern, können Sie in der Da-tei waapi.init beispielsweise die folgenden Merkmale definieren:v waapi.host

v waapi.port

Wenn Sie bei der Ausführung des WAAPI-Clients die Einstellung eines Werts inder Datei waapi.init überschreiben möchten, müssen Sie die Befehlszeilenoptionfür diese Einstellung verwenden. Zum Angeben einer anderen XML-Befehlsdateifür den WAAPI-Client können Sie beispielsweise die Option -file verwenden:runwaapi -file pfad_zur_datei

Dabei überschreibt pfad_zur_datei den Wert des Merkmals waapi.file in der Dateiwaapi.init.

Die Standardmerkmale und entsprechenden Befehlszeilenoptionen für den WAAPI-Client finden Sie in der folgenden Tabelle.

Tabelle 51. WAAPI-Merkmale und Befehlszeilenoptionen

MerkmalBefehlszeilen-option Beschreibung

N/Z -help Zeigt den Hilfetext für die WAAPI-Befehlszeile an.

N/Z -outfile string Der Pfad der Ausgabedatei.

N/Z -props string Gibt eine WAAPI-Merkmaldatei an. Der Stan-dardwert ist waapi.init.

Verbindungsmerkmale:

waapi.host -host string Der Hostname des Web-GUI-Servers.

waapi.port -port integer Der TCP/IP-Port, über den der Web-GUI-Ser-ver ausgeführt wird.

waapi.contextpath N/Z Der Kontext mit der Sicht des Servlets derWeb-GUI, in der das Servlet ausgeführt wird.

waapi.secureport -secureport integer Der TCP/IP-Port, über den der Web-GUI-Ser-ver im sicheren Modus empfangsbereit ist.

Der Standardport für HTTPS ist 16316.


Tabelle 51. WAAPI-Merkmale und Befehlszeilenoptionen (Forts.)


waapi.user -user string Der Name des WAAPI-Benutzers. Dieser Be-nutzer muss die Web-GUI-Rolle 'ncw_admin'besitzen, benötigt jedoch keine Rollen imObjectServer.

waapi.password -password string Das Kennwort des Benutzers.

waapi.password.encryption

-passwordEncryptionnone|aes|fips

Gibt an, dass die Kennwörter in der Dateiwaapi.init verschlüsselt sind.

AES Das Kennwort kann mit demDienstprogramm ncw_aes_crypt ver-schlüsselt werden.

FIPS Das Kennwort kann mit demDienstprogramm ncw_fips_encryptverschlüsselt werden.

Wenn WAAPI im FIPS 140–2-Modus ausge-führt wird, ist die Option aes nicht zulässig.

waapi.file -file string Der Pfad und Dateiname der WAAPI-Konfigurationsdatei.

waapi.timeoutsecs -timeout integer Die Zeit, die eine inaktive Benutzersitzungaktiv bleibt. Nach Ablauf dieses Zeitraumswird die Netzverbindung freigegeben.

Der Standardwert (in Sekunden) ist 600.

Merkmale für den sicheren Modus:

waapi.secure -secureoff|on|fips

Aktiviert die sicheren HTTPS-Funktionen undden FIPS 140–2-Modus:

off WAAPI unterstützt nur HTTP (keineVerschlüsselung).

on WAAPI unterstützt sicheres HTTPS.

fips WAAPI verwendet als Verschlüsse-lung HTTPS im FIPS 140–2-Modus.

Kann nur dann verwendet werden,wenn WAAPI die JRE im Paket mitder Web-GUI oder eine AIX-JRE ver-wendet.

Der Standardwert ist off.

waapi.ssl.keyStore -keyStorestring Die Position des SSL-Keystores.

waapi.ssl.keyStorePassword

-keyStorePasswordstring

Das Kennwort für den Keystore.

waapi.ssl.keyManagerType

-keyManagerTypestring

Der Key Manager-Typ:

v Legen Sie für dieses Merkmal den WertIbmX509 fest, wenn Sie die JRE im Paketmit Web-GUI oder eine AIX-JRE verwen-den.

v Legen Sie für dieses Merkmal den WertSunX509 fest, wenn Sie nicht die JRE im Pa-ket bzw. keine AIX-JRE verwenden.

Der Standardwert ist IbmX509.




waapi.ssl.keyStoreType

-keyStoreTypestring

Der Keystore-Typ:

v Legen Sie für dieses Merkmal den WertPKCS12 fest, wenn Sie die JRE im Paket mitWeb-GUI oder eine AIX-JRE verwenden.

v Legen Sie für dieses Merkmal den Wert JKSfest, wenn Sie nicht die JRE im Paket bzw.keine AIX-JRE verwenden.

Der Standardwert ist PKCS12.

waapi.ssl.trustStore -trustStorestring

Die Position des SSL-Truststores.

waapi.ssl.trustStorePassword

-trustStorePasswordstring

Das Kennwort für den Truststore.

waapi.ssl.trustManagerType

-trustManagerTypestring

Der Key Manager-Typ:

v Legen Sie für dieses Merkmal den WertIbmX509 fest, wenn Sie die JRE im Paketmit Web-GUI oder eine AIX-JRE verwen-den.

v Legen Sie für dieses Merkmal den WertSunX509 fest, wenn Sie nicht die JRE im Pa-ket bzw. keine AIX-JRE verwenden.

Der Standardwert ist IbmX509.

waapi.ssl.trustStoreType

-trustStoreTypestring

Der Truststore-Typ:

v Legen Sie für dieses Merkmal den WertPKCS12 fest, wenn Sie die JRE im Paket mitWeb-GUI oder eine AIX-JRE verwenden.

v Legen Sie für dieses Merkmal den Wert JKSfest, wenn Sie nicht die JRE im Paket bzw.keine AIX-JRE verwenden.

Der Standardwert ist PKCS12.

waapi.fips.security.key

-fipsSecurityKeystring

Verweist auf die Position, in der der Sicher-heitsschlüssel gespeichert ist. Der Standard-wert ist %%/etc/encrypt/vault.key.

waapi.ssl.protocol.handler.pkgs

-protocolHandlerstring

Das SSL-Protokollhandlerpaket. Der Stan-dardwert ist com.ibm.net.ssl.www2.protocol.

Anhang A. WAAPI-Merkmale und Befehlszeilenoptionen 111



waapi.ssl.ip.authentication

-sslIPAuthenticationfalse|true

Mit der Standardprüffunktion für SSL-Hostnamen in JVM 1.4 können IP-Adressennicht als vertrauenswürdige Hostpositionenvalidiert werden:

false Optional: Verwenden Sie dieStandardprüffunktion fürHostnamen zum Überprüfen vonVerbindungsberechtigungen.

true Verwenden Sie eine angepasstePrüffunktion für Hostnamen, umden Namen des Zielhosts mit demNamen des Peers in der bestehendenSSL-Sitzung zu vergleichen.

Der Hostname des Peers muss keinvollständig qualifizierter Hostnamebzw. gar kein Hostname sein. Eskann sich beispielsweise um eineZeichenfolgecodierung derNetzadresse des Peers handeln.

Der Hostname wird nicht authentifi-ziert.

Geben Sie eine vertrauenswürdigeIP-Adresse ein, an der die IP-Adres-se des Hosts überprüft wird.

waapi.ssl.default.check

-defaultSslCheckfalse|true

Wenn waapi.ssl.ip.authentication auffalse gesetzt ist, gibt dieses Merkmal an, obdie IP-Adresse des verbundenen Hosts an derhier angegebenen vertrauenswürdigen IP-Adresse überprüft wird.

false Es findet keine Überprüfung statt.

true Die Überprüfung findet mit derStandardprüffunktion fürHostnamen statt.

waapi.trusted.host.ip -trustedHostIPstring, string

Wenn waapi.ssl.ip.authentication auf 'true'gesetzt wird, gibt dieses Merkmal die Listeder vertrauenswürdigen IP-Adressen an, ander die IP-Adresse des verbundenen Hostsüberprüft wird.Anmerkung: Mehrere IP-Adressen werden inForm einer durch Kommas getrennten Listeangegeben.

Protokolldateimerkmale:

waapi.logfile -logfilestring Die Position der WAAPI-Protokolldateien und-verzeichnisse.


Anhang B. WAAPI-Client auf einem fernen Host installieren

Zusätzlich zur Installation auf dem Web-GUI-Server kann der WAAPI-Client aufeinem fernen Host installiert werden.

Informationen zu diesem Vorgang

So installieren Sie den WAAPI-Client auf einem fernen Host:

Vorgehensweise1. Melden Sie sich mit einer geeigneten Benutzer-ID bei der Web-GUI an.2. Klicken Sie im Navigationsfenster auf Willkommen und anschließend im Ar-

beitsbereich auf Informationen zum Webtop-Verwaltungs-API-Client.3. Laden Sie den WAAPI-Client herunter:

v UNIX Linux Klicken Sie auf waapi.tar.gz.

v Windows Klicken Sie auf waapi.zip.Speichern Sie die Datei in dem Verzeichnis, in dem Sie den Client installierenwollen.

4. Wechseln Sie in das Verzeichnis, in dem die Dateien installiert werden sollen.5. Dekomprimieren Sie die Datei.

Tipp: UNIX Verwenden Sie den Befehl gtar xzvf waapi.tar.gz oder dieBefehle gunzip waapi.tar.gz und tar -xvf waapi.tar.Die Dateien werden in einem Unterverzeichnis namens waapi installiert und ha-ben die folgende Struktur:v waapi/

v waapi/bin

v waapi/etc/

v waapi/etc/default

v waapi/etc/docs

v waapi/etc/samples/

v waapi/log/

v waapi/platform/java/bin

v waapi/platform/java/lib

6. UNIX Legen Sie die Ausführungsberechtigungen für den Befehl runwaapifest:chmod +x waapi/bin/runwaapi

Ergebnisse

Nun können Sie den WAAPI-Client auf dem fernen Host verwenden.



Anhang C. WAAPI-Sicherheit

WAAPI verfügt über eine Reihe von Sicherheitsfunktionen, die helfen, eine sichereKommunikation mit dem Web-GUI-Server zu gewährleisten.

Die Verwaltung jedes Systems beruht auf Sicherheit. WAAPI stellt eine Reihe vonSicherheitsfunktionen bereit, die Sie nutzen können:v Eine sichere Verbindung zum Web-GUI-Server

Ziehen Sie die Verwendung einer SSL-Verbindung mit oder ohne FIPS-142-Schutz in Betracht, wenn Sie den WAAPI-Client auf einem Server ausführen, dervom Web-GUI-Server entfernt ist.

v Verschlüsselung von WAAPI-KennwörternSie können WAAPI-Kennwörter entweder mit AES oder mit FIPS-142 verschlüs-seln. (FIPS-142 ist erforderlich, wenn die Verbindung mit FIPS-142 geschütztwird.) Sie können diese Funktion verwenden, wenn der WAAPI-Client auf ei-nem fernen Server zum Web-GUI-Server installiert ist.

v Schützen der Datei waapi.initDie Merkmaldatei für den WAAPI-Client enthält einige sensible Einträge. Sieenthält zum Beispiel den Benutzernamen und das Kennwort des Benutzers, derauf dem Web-GUI-Server zum Ausführen von WAAPI-Befehlen zu verwendenist. Daher ist es wichtig sicherzustellen, dass die Datei nur für berechtigte Admi-nistratoren verfügbar ist.

WAAPI stellt die folgenden Sicherheitstasks bereit:v „Sichere WAAPI-Verbindungen erstellen”v „WAAPI-Kennwortverschlüsselung aktivieren” auf Seite 125v „Merkmaldatei 'waapi.init' schützen” auf Seite 127

Sichere WAAPI-Verbindungen erstellenSie können die Web-GUI für die Verwendung des SSL-Protokolls (SSL - Secure So-ckets Layer) für sichere WAAPI-Kommunikation konfigurieren. Dabei kann entwe-der die Nur-Server-Authentifizierung oder die Client/Server-Authentifizierung ver-wendet werden. Optional können Sie den FIPS 140-2-Modus aktivieren.


Die folgenden WAAPI-Verbindungsmodi können für die Web-GUI konfiguriertwerden:

SSL nicht aktiviertDer WAAPI-Client stellt über Standard-HTTP eine Verbindung zur Web-GUI her. Für diesen Modus ist keine zusätzliche Konfiguration erforderlich.

SSL aktiviert, Nur-Server-Authentifizierung (ohne FIPS 140–2)Der WAAPI-Client stellt über HTTPS unter Verwendung der Nur-Server-Authentifizierung (ohne den FIPS 140–2-Modus) eine Verbindung zur Web-GUI her.


SSL aktiviert, Client/Server-Serverauthentifizierung (ohne FIPS 140–2)Der WAAPI-Client stellt über HTTPS unter Verwendung der Client/Server-Serverauthentifizierung (ohne den FIPS 140–2-Modus) eine Verbindung zurWeb-GUI her.

SSL aktiviert, Nur-Server-Authentifizierung (mit FIPS 140–2)Der WAAPI-Client stellt über HTTPS unter Verwendung der Nur-Server-Authentifizierung (im FIPS 140–2-Modus) eine Verbindung zur Web-GUIher.

SSL aktiviert, Client/Server-Serverauthentifizierung (mit FIPS 140–2)Der WAAPI-Client stellt über HTTPS unter Verwendung der Client/Server-Serverauthentifizierung (im FIPS 140–2-Modus) eine Verbindung zur Web-GUI her.

WAAPI-SSL-Verbindung erstellen (Nur-Server-Authentifizie-rung)

Zur Erstellung einer sicheren Verbindung mit Serverauthentifizierung zwischenWAAPI und der in Dashboard Application Services Hub implementierten Web-GUI(ohne FIPS 140–2) muss Dashboard Application Services Hub sowohl im WAAPI-Truststore als auch in der Datei waapi.init referenziert werden.


So erstellen Sie eine sichere, serverauthentifizierte Verbindung zwischen WAAPIund der Web-GUI:

Vorgehensweise1. Extrahieren Sie unter Verwendung der Dashboard Application Services Hub-

GUI das standardmäßig definierte Truststore-Unterzeichnerzertifikat.a. Klicken Sie auf Konsoleneinstellungen > WebSphere-Administrationskon-

sole und klicken Sie auf WebSphere-Administrationskonsole starten.b. Klicken Sie auf Sicherheit > Verwaltung von SSL-Zertifikaten und Schlüs-

seln > Keystores und Zertifikate > NodeDefaultKeyStore > PersönlicheZertifikate.

c. Wählen Sie das standardmäßig definierte Truststore-Zertifikat (Alias) ausund klicken Sie auf Extrahieren.

d. Geben Sie einen Namen ein, z. B. /example/tipcert.arm.e. Wählen Sie Base64-verschlüsselte ASCII-Daten aus und klicken Sie auf

OK.2. Fügen Sie das neue Zertifikat unter Verwendung des Dienstprogramms 'Ikey-

man' von Dashboard Application Services Hub zum WAAPI-Truststore hinzu.a. Wechseln Sie zum Verzeichnis JazzSM_HOME/bin und starten Sie Ikeyman.b. Klicken Sie auf KeyDatabaseFile > New und wählen Sie PKCS als Schlüs-

seldatenbanktyp aus.c. Geben Sie einen Truststore-Namen ein, z. B. /example/waapiTruststore.p12.d. Geben Sie das Standardkennwort WebAS ein und klicken Sie auf OK.e. Wählen Sie Signer Certificates (Unterzeichnerzertifikate) in der Dropdown-

Liste aus und klicken Sie auf Add (Hinzufügen).f. Verweisen Sie auf das Unterzeichnerzertifikat (in diesem Beispiel /example/

tipcert.arm) und klicken Sie auf OK. Notieren Sie den Wert für den allgemei-nen Namen (CN, Common Name) des Unterzeichnerzertifikats.

3. Bearbeiten Sie die Datei waapi.init.


a. Öffnen Sie die Datei WEBGUI_HOME/waapi/etc/waapi.init und suchen Sieden Abschnitt für den sicheren WAAPI-Modi auf.

b. Geben Sie Folgendes an: waapi.secure:on.c. Stellen Sie sicher, dass der Hostname in waapi.host mit dem Wert für den

allgemeinen Namen im Unterzeichnerzertifikat übereinstimmt.d. Geben Sie den Truststore-Namen an (in diesem Beispiel /example/

waapiTruststore.p12).e. Geben Sie das Kennwort WebAS ein.

Nächste Schritte

Führen Sie ein WAAPI-Beispiel aus, um zu testen, ob die WAAPI-SSL-Verbindungerfolgreich eingerichtet wurde.

WAAPI-SSL-Verbindung erstellen (Client/Server-Authentifizie-rung)

Zur Erstellung einer sicheren Verbindung mit Client/Server-Authentifizierung zwi-schen WAAPI und der in Dashboard Application Services Hub implementiertenWeb-GUI (ohne FIPS 140–2) muss Dashboard Application Services Hub im WAAPI-Truststore und WAAPI im Dashboard Application Services Hub-Truststore referen-ziert werden. Dann können Sie die SSL-Authentifizierung in WAAPI aktivierenund das WAAPI-Truststore-Zertifikat zum Truststore des verwendeten Browsershinzufügen. Abschließend wird die Clientauthentifizierung in Dashboard Applica-tion Services Hub aktiviert.









seldatenbanktyp aus.c. Geben Sie einen Truststore-Namen an, z. B. /example/waapiTruststore.p12.d. Geben Sie das Standardkennwort WebAS ein und klicken Sie auf OK.e. Wählen Sie Signer Certificates (Unterzeichnerzertifikate) in der Dropdown-



Anhang C. WAAPI-Sicherheit 117

3. Extrahieren Sie unter Verwendung des Dienstprogramms 'Ikeyman' von Dash-board Application Services Hub ein selbst signiertes persönliches Keystore-Zer-tifikat aus dem WAAPI-Keystore.a. Wechseln Sie zum Verzeichnis JazzSM_HOME/bin und starten Sie Ikeyman.b. Klicken Sie auf KeyDatabaseFile > New und wählen Sie PKCS als Schlüs-

seldatenbanktyp aus.c. Geben Sie einen Keystore-Namen an, z. B. waapiKeystore.p12.d. Geben Sie das Standardkennwort WebAS ein und klicken Sie auf OK.e. Wählen Sie Personal Certificates in der Dropdown-Liste aus und klicken

Sie auf New Self-Signed.f. Geben Sie einen Schlüsselkennsatz ein, z. B. WAAPI_cert, füllen Sie die ande-

ren Felder entsprechend der Vorgaben aus, und klicken Sie dann auf OK.g. Wählen Sie das neue Keystore-Zertifikat aus (in diesem Beispiel WAAPI_cert)

und klicken Sie auf Extract Certificate (Zertifikat extrahieren).h. Wählen Sie Base64-verschlüsselte ASCII-Daten aus.i. Geben Sie einen Namen für die Zertifikatsdatei ein, z. B. WAAPI_cert.arm.

Definieren Sie eine Position (in diesem Beispiel /example/) und klicken Siedann auf OK.

4. Fügen Sie das neue WAAPI-Keystore-Zertifikat mithilfe der Dashboard Applica-tion Services Hub-GUI zum Dashboard Application Services Hub-Truststorehinzu.a. Klicken Sie auf Einstellungen > WebSphere-Administrationskonsole und

klicken Sie auf WebSphere-Administrationskonsole starten.b. Klicken Sie auf Sicherheit > Verwaltung von SSL-Zertifikaten und Schlüs-

seln > Keystores und Zertifikate > NodeDefaultTrustStore > Unterzeich-nerzertifikate.

c. Klicken Sie auf Hinzufügen und geben Sie einen Aliasnamen fürWAAPI_cert (für dieses Beispiel) ein.

d. Verweisen Sie auf das zuvor generierte Zertifikat WAAPI_cert, klicken Sieauf OK und dann auf Speichern.

5. Fügen Sie das neue Keystore-Zertifikat mithilfe der Sicherheitsmanagement-funktion des Browsers zum Truststore des Browsers hinzu.Warnung: Wenn Sie diesen Schritt nicht ausführen, können Sie nach der Akti-vierung der Clientauthentifizierung (siehe nächster Schritt) nicht mehr aufDashboard Application Services Hub zugreifen.

6. Aktivieren Sie die Clientauthentifizierung mithilfe der Dashboard ApplicationServices Hub-GUI.a. Klicken Sie auf Einstellungen > WebSphere-Administrationskonsole und

klicken Sie auf WebSphere-Administrationskonsole starten.b. Klicken Sie auf Sicherheit > Verwaltung von SSL-Zertifikaten und Schlüs-

seln > SSL-Konfigurationen > NodeDefaultSSLSettings > Einstellungenfür Datenschutzniveau.

c. Wählen Sie aus der Dropdown-Liste Allgemeine Eigenschaften > Clientau-thentifizierung die Option Erforderlich aus.

d. Klicken Sie auf OK und dann auf Speichern.7. Bearbeiten Sie die Datei waapi.init.


b. Geben Sie Folgendes an: waapi.secure:on.


c. Stellen Sie sicher, dass der Hostname in 'waapi.host' mit dem Wert für denallgemeinen Namen im Unterzeichnerzertifikat übereinstimmt.

d. Geben Sie den Namen des Keystore (Schlüsselspeicher) an (in diesem Bei-spiel /example/waapiKeystore.p12).

e. Geben Sie den Truststore-Namen an (in diesem Beispiel /example/waapiTruststore.p12).

f. Geben Sie das Kennwort WebAS ein.

Anmerkung: Windows Verwenden Sie beim Eingeben der Keystore-Positionunter Windows zwei umgekehrte Schrägstriche als Pfadtrennzeichen (ein ein-zelner umgekehrter Schrägstrich wird als Escapezeichen interpretiert). GebenSie den Truststore beispielsweise wie folgt an: \\example\\waapiTruststore.p12.

Nächste Schritte


WAAPI-SSL-Verbindung mit FIPS 140–2 erstellen (Nur-Server-Authentifizierung)

Zur Erstellung einer sicheren Verbindung mit Serverauthentifizierung zwischenWAAPI und der in Dashboard Application Services Hub implementierten Web-GUI(FIPS 140–2-Modus aktiviert) muss Dashboard Application Services Hub sowohl imWAAPI-Truststore als auch in der Datei 'waapi.init' referenziert werden. Anschlie-ßend müssen Sie FIPS 140–2 in Dashboard Application Services Hub aktivieren.


Wenn Sie FIPS 140–2 im Rahmen der Konfiguration von FIPS 140–2 für die Web-GUI bereits in Dashboard Application Services Hub aktiviert haben, müssen SieSchritt 4 nicht ausführen.









seldatenbanktyp aus.c. Geben Sie einen Truststore-Namen an, z. B. /example/waapiTruststore.p12.


d. Geben Sie das Standardkennwort WebAS ein und klicken Sie auf OK.e. Wählen Sie Signer Certificates (Unterzeichnerzertifikate) in der Dropdown-



3. Bearbeiten Sie die Datei waapi.init.a. Öffnen Sie die Datei WEBGUI_HOME/waapi/etc/waapi.init und suchen Sie

den Abschnitt für den sicheren WAAPI-Modi auf.b. Geben Sie Folgendes an: waapi.secure:fips.c. Stellen Sie sicher, dass der Hostname in 'waapi.host' mit dem Wert für den



4. Aktivieren Sie FIPS 140–2 auf dem Dashboard Application Services Hub-Server.a. Öffnen Sie WEBGUI_HOME/java/jre/lib/security/java.security.b. Entfernen Sie in der Liste der Provider und deren Rangfolge die Kommen-

tarzeichen fürsecurity.provider:<x>=com.ibm.crypto.fips.provider.IBMJCEFIPS.

c. Ersetzen Sie die Variable <x> durch 1 und nummerieren Sie die nachfolgen-den Sicherheitsprovider um.

d. Aktivieren Sie FIPS 140–2 mithilfe der Dashboard Application Services Hub-GUI.Klicken Sie auf Sicherheit > Verwaltung von SSL-Zertifikaten und Schlüs-seln und wählen Sie in den Konfigurationseinstellungen das Kontrollkäst-chen FIPS aus. Klicken Sie dann auf Anwenden.

e. Führen Sie einen Neustart des Dashboard Application Services Hub-Serversaus.

Beispiel

Nächste Schritte


WAAPI-SSL-Verbindung mit FIPS 140–2 erstellen (Client/Ser-ver-Authentifizierung)

Zur Erstellung einer sicheren Verbindung mit Client/Server-Authentifizierung zwi-schen WAAPI und der in Dashboard Application Services Hub implementiertenWeb-GUI (FIPS 140–2-Modus aktiviert) muss Dashboard Application Services Hubim WAAPI-Truststore und WAAPI im Dashboard Application Services Hub-Trust-store referenziert werden. Dann können Sie die FIPS 140–2-Authentifizierung inWAAPI aktivieren und das WAAPI-Truststore-Zertifikat dem Truststore des ver-wendeten Browsers hinzufügen. Abschließend werden die Clientauthentifizierungund FIPS 140–2 in Dashboard Application Services Hub aktiviert.



Wenn Sie FIPS 140–2 im Rahmen der Konfiguration von FIPS 140–2 für die Web-GUI bereits in Dashboard Application Services Hub aktiviert haben, müssen SieSchritt 8 nicht ausführen.









seldatenbanktyp aus.c. Geben Sie einen Truststore-Namen an, z. B. /example/waapiTruststore.p12.d. Geben Sie das Standardkennwort WebAS ein und klicken Sie auf OK.e. Wählen Sie Signer Certificates (Unterzeichnerzertifikate) in der Dropdown-



3. Extrahieren Sie mithilfe des Dienstprogramms 'Ikeyman' von Dashboard Appli-cation Services Hub ein selbst signiertes persönliches Keystore-Zertifikat ausdem WAAPI-Keystore.a. Wechseln Sie zum Verzeichnis JazzSM_HOME/bin und starten Sie Ikeyman.b. Klicken Sie auf KeyDatabaseFile > New und wählen Sie PKCS als Schlüs-

seldatenbanktyp aus.c. Geben Sie einen Keystore-Namen an, z. B. waapiKeystore.p12.d. Geben Sie das Standardkennwort WebAS ein und klicken Sie auf OK.e. Wählen Sie Personal Certificates in der Dropdown-Liste aus und klicken

Sie auf New Self-Signed.f. Geben Sie einen Schlüsselkennsatz ein, z. B. WAAPI_cert, füllen Sie die ande-

ren Felder entsprechend der Vorgaben aus, und klicken Sie dann auf OK.g. Wählen Sie das neue Keystore-Zertifikat aus (in diesem Beispiel WAAPI_cert)

und klicken Sie auf Zertifikat extrahieren.h. Wählen Sie Base64-verschlüsselte ASCII-Daten aus.i. Geben Sie einen Namen für die Zertifikatsdatei ein, z. B. WAAPI_cert.arm.

Definieren Sie eine Position (in diesem Beispiel /example/) und klicken Siedann auf OK.


4. Fügen Sie das neue Keystore-Zertifikat mithilfe der Dashboard Application Ser-vices Hub-GUI zum Dashboard Application Services Hub-Truststore hinzu.a. Klicken Sie auf Sicherheit > Verwaltung von SSL-Zertifikaten und Schlüs-

seln > Keystores und Zertifikate > NodeDefaultTrustStore > Unterzeich-nerzertifikate.

b. Klicken Sie auf Hinzufügen und geben Sie einen Aliasnamen fürWAAPI_cert (für dieses Beispiel) ein.

c. Verweisen Sie auf das zuvor generierte Zertifikat WAAPI_cert, klicken Sieauf OK und dann auf Speichern.

5. Fügen Sie das neue Keystore-Zertifikat mithilfe der Sicherheitsmanagement-funktion des Browsers zum Truststore des Browsers hinzu.Warnung: Wenn Sie diesen Schritt nicht ausführen, können Sie nach der Akti-vierung der Clientauthentifizierung (siehe nächster Schritt) nicht mehr aufDashboard Application Services Hub zugreifen.

6. Aktivieren Sie die Clientauthentifizierung mithilfe der Dashboard ApplicationServices Hub-GUI.a. Klicken Sie auf Sicherheit > Verwaltung von SSL-Zertifikaten und Schlüs-

seln > SSL-Konfigurationen > NodeDefaultSSLSettings > Einstellungenfür Datenschutzniveau.

b. Wählen Sie aus der Dropdown-Liste Allgemeine Eigenschaften > Clientau-thentifizierung die Option Erforderlich aus.

c. Klicken Sie auf OK und dann auf Speichern.7. Bearbeiten Sie die Datei waapi.init.


b. Geben Sie Folgendes an: waapi.secure:fips.c. Stellen Sie sicher, dass der Hostname in waapi.host mit dem Wert für den



8. Aktivieren Sie FIPS 140–2 auf dem Dashboard Application Services Hub-Server.a. Öffnen Sie WEBGUI_HOME/java/jre/lib/security/java.security.b. Entfernen Sie in der Liste der Provider und deren Rangfolge die Kommen-

tarzeichen fürsecurity.provider:<x>=com.ibm.crypto.fips.provider.IBMJCEFIPS.

c. Ersetzen Sie die Variable <x> durch 1 und nummerieren Sie die nachfolgen-den Sicherheitsprovider um.

d. Aktivieren Sie FIPS 140–2 mithilfe der Dashboard Application Services Hub-GUI.Klicken Sie auf Sicherheit > Verwaltung von SSL-Zertifikaten und Schlüs-seln und wählen Sie in den Konfigurationseinstellungen das Kontrollkäst-chen FIPS aus. Klicken Sie dann auf Anwenden.

e. Führen Sie einen Neustart des Dashboard Application Services Hub-Serversaus.

Nächste Schritte



SP800-131a-Übergangsmodus auf dem WAAPI-Client festlegenWenn in Ihrer Umgebung Web-GUI Administration API (WAAPI) dazu verwendetwird, den Web-GUI-Server über Fernzugriff zu verwalten, ist eine zusätzliche Kon-figuration erforderlich, um den Übergangsmodus (Transition) auf dem WAAPI-Client zu aktivieren. Der Umfang der Konfiguration hängt davon ab, ob Sie einenÜbergang von FIPS 140-2-Stufen der Verschlüsselung auf SP800-131 durchführenwollen.

Wenn Sie einen Übergang von FIPS 140-2-Stufen der Verschlüsselung durchführenund folglich bereits ein WAAPI-Truststore vorhanden ist, besteht die einzige Konfi-guration, die Sie vornehmen müssen, darin, SP800-131 in der WAAPI-Initialisie-rungsdatei verbindlich anzugeben. Wenn Sie noch keinen WAAPI-Truststore haben,zum Beispiel weil Sie zurzeit keine FIPS 140-2-Stufen der Verschlüsselung verwen-den, müssen Sie die Zertifikate aktualisieren. Anschließend erstellen Sie einenWAAPI-Truststore und aktualisieren diesen mit dem neuen Zertifikat.

Vorgehensweise

Wenn Sie bereits einen WAAPI-Truststore mit dem vorhandenen Zertifikat haben,führen Sie nur den folgenden Schritt aus. Überspringen Sie die übrigen Schritte.1. Bearbeiten Sie auf dem WAAPI-Host die Datei waapi.init wie folgt:

a. Ändern Sie den Wert des Merkmals waapi.secure in "transition".b. Stellen Sie sicher, dass das Merkmal waapi.host denselben Wert wie das At-

tribut CN in Schritt 5g hat.

Wenn Sie Zertifikate erstellen oder aktualisieren müssen sowie einen WAAPI-Trust-store erstellen und den Truststore aktualisieren müssen, führen Sie außerdem diefolgenden Schritte aus:2. Melden Sie sich bei der Administrationskonsole an und klicken Sie auf Sicher-

heit > Verwaltung von SSL-Zertifikaten und Schlüsseln. Klicken Sie dann un-ter Zugehörige Elemente auf Keystores und Zertifikate.

3. Klicken Sie auf NodeDefaultKeyStore, klicken Sie auf Persönliche Zertifikateund wählen Sie default (Standard) aus.

4. Klicken Sie auf Extrahieren. Geben Sie auf der Seite Zertifikat extrahieren denWert WEBGUI_HOME/etc/encrypt/tipcert.arm in das Feld Name der Zertifikats-datei ein. Speichern Sie anschließend die Änderungen und melden Sie sich vonDashboard Application Services Hub ab.

5. Entfernen Sie den WAAPI-Truststore, der zuvor für die FIPS 140-2-Verschlüsse-lung verwendet wurde. Beispiel: WEBGUI_HOME/etc/encrypt/waapiTruststore.p12.

6. Wechseln Sie in das Verzeichnis JazzSM_HOME/bin und führen Sie den Befehlikeyman für Ihr Betriebssystem aus. Erstellen Sie einen Truststore und laden Siedas Unterzeichnerzertifikat aus Dashboard Application Services Hub, sodassder WAAPI-Client die Dashboard Application Services Hub-Zertifikaten akzep-tiert.a. Klicken Sie auf KeyDatabaseFile > New und wählen Sie den Schlüsselda-

tenbanktyp PKSC12 aus.b. Geben Sie den Dateinamen WEBGUI_HOME/etc/encrypt/waapiTruststore.p12

ein.c. Geben Sie ein Kennwort an.d. Klicken Sie auf Signer certificates (Unterzeichnerzertifikate) und klicken Sie

auf Add (Hinzufügen).


e. Geben Sie den Pfad WEBGUI_HOME/etc/encrypt und die Datei tipcert.armein.

f. Geben Sie tipcert als Bezeichnung ein.g. Prüfen Sie das Zertifikat und stellen Sie sicher, dass das Attribut CN mit

dem des extrahierten Unterzeichnerzertifikats übereinstimmt.

Nächste Schritte

Zum Testen, ob der WAAPI-Client ausgeführt wird, wechseln Sie in das WAAPI-Verzeichnis bin und führen einen Beispielbefehl aus. Beispiel:runwaapi -props ../etc/waapi.init -file ../etc/samples/list_filter.xml

Prüfen Sie, ob der Befehl ausgeführt wird und die erwartete Ausgabe liefert.

Strikten SP800-131-Modus auf dem WAAPI-Client festlegenWenn die SP800-131-Verschlüsselung auf dem WAAPI-Client verwendet werdensoll, bearbeiten Sie die Datei waapi.init und ändern der Wert des Merkmalswaapi.secure in "sp800-131".

Vorgehensweise1. Melden Sie sich bei der Administrationskonsole an und klicken Sie auf Sicher-

heit > Verwaltung von SSL-Zertifikaten und Schlüsseln. Klicken Sie dann un-ter Zugehörige Elemente auf Keystores und Zertifikate.

2. Klicken Sie auf NodeDefaultKeyStore, klicken Sie auf Persönliche Zertifikateund wählen Sie default (Standard) aus.

3. Klicken Sie auf Extrahieren. Geben Sie auf der Seite Zertifikat extrahieren denWert WEBGUI_HOME/etc/encrypt/tipcert.arm in das Feld Name der Zertifikats-datei ein. Speichern Sie anschließend die Änderungen und melden Sie sich vonDashboard Application Services Hub ab.

4. Entfernen Sie den WAAPI-Truststore, der zuvor für die FIPS 140-2-Verschlüsse-lung verwendet wurde. Beispiel: WEBGUI_HOME/etc/encrypt/waapiTruststore.p12.

5. Wechseln Sie in das Verzeichnis JazzSM_HOME/bin und führen Sie den Befehlikeyman für Ihr Betriebssystem aus. Erstellen Sie einen Truststore und laden Siedas Unterzeichnerzertifikat aus Dashboard Application Services Hub, sodassder WAAPI-Client die Dashboard Application Services Hub-Zertifikaten akzep-tiert.a. Klicken Sie auf KeyDatabaseFile > New und wählen Sie den Schlüsselda-

tenbanktyp PKSC12 aus.b. Geben Sie den Dateinamen WEBGUI_HOME/etc/encrypt/waapiTruststore.p12

ein.c. Geben Sie ein Kennwort an.d. Klicken Sie auf Signer certificates (Unterzeichnerzertifikate) und klicken Sie

auf Add (Hinzufügen).e. Geben Sie den Pfad WEBGUI_HOME/etc/encrypt und die Datei tipcert.arm

ein.f. Geben Sie tipcert als Bezeichnung ein.g. Prüfen Sie das Zertifikat und stellen Sie sicher, dass das Attribut CN mit

dem des extrahierten Unterzeichnerzertifikats übereinstimmt.6. Bearbeiten Sie auf dem WAAPI-Host die Datei waapi.init wie folgt:

a. Ändern Sie den Wert des Merkmals waapi.secure in "sp800-131".


b. Stellen Sie sicher, dass das Merkmal waapi.host denselben Wert wie das At-tribut CN in Schritt 5g hat.

WAAPI-Kennwortverschlüsselung aktivierenSie haben die Möglichkeit, WAAPI-Kennwörter in verschlüsseltem Format in derDatei waapi.init zu speichern.


Zur Kennwortverschlüsselung für SSL- und Nicht-SSL-Verbindungen wird dieAES-Verschlüsselung verwendet. Für FIPS 140-2-Verbindungen wird die Verschlüs-selung im FIPS 140–2-Modus verwendet. Verschlüsselungstypen und erforderlicheTools zu deren Aktivierung:

Nicht-SSL-Verbindungen (HTTP)Kennwörter können unter Verwendung des Tools ncw_aes_crypt mit AESverschlüsselt werden.

SSL-Verbindungen (HTTPS)Kennwörter können unter Verwendung des Tools ncw_aes_crypt mit AESverschlüsselt werden.

SSL-Verbindungen (HTTPS), FIPS 140–2 aktiviertKennwörter können unter Verwendung des Tools ncw_fips_crypt ver-schlüsselt werden.

WAAPI-Kennwörter müssen mit dem Script ncw_fips_crypt inWEBGUI_HOME/waapi/bin verschlüsselt werden. Dieses Script verwendet denVaultschlüssel in waapi-installationsverzeichnis/etc/encrypt. Wenn sienicht vorhanden ist, wird die Datei vault.key bei der ersten Ausführungdes Scripts automatisch erstellt.

WAAPI-Kennwörter mit AES verschlüsselnZur Verschlüsselung von WAAPI-Kennwörtern für SSL- und Nicht-SSL-Verbindun-gen können Sie das Tool ncw_aes_crypt verwenden. Sie können die WAAPI-Kenn-wortverschlüsselung für WAAPI-Clients konfigurieren, die auf demselben Serverwie Dashboard Application Services Hub oder auf einem anderen Server installiertsind.

Vorbereitende Schritte

Sie können die AES-Kennwortverschlüsselung nur dann verwenden, wenn derFIPS 140–2-Modus nicht aktiviert wurde.


Das Kennwort für den Standard-Truststore lautet WebAS.

Die Position der Datei waap.init, in die Sie das verschlüsselte Kennwort eingebenmüssen, variiert in Abhängigkeit von der Installationsposition des WAAPI-Clients.Wenn der WAAPI-Client auf demselben Server wie Dashboard Application ServicesHub installiert ist, befindet sich die Datei in WEBGUI_HOME/waapi/etc/waapi.init.Wenn der WAAPI-Client auf einem anderen Server als Dashboard Application Ser-vices Hub installiert ist, befindet sich die Datei in waapi-installationsverzeichnis/etc/waapi.init.


Vorgehensweise1. Verschlüsseln Sie das WAAPI-Kennwort:

a. Führen Sie WEBGUI_HOME/waapi/bin/ncw_aes_crypt aus.b. Geben Sie das standardmäßig definierte Dashboard Application Services

Hub-Truststore-Kennwort WebAS ein.Es wird ein verschlüsseltes Kennwort generiert.

c. Kopieren Sie das verschlüsselte Kennwort.2. Fügen Sie das verschlüsselte Kennwort hinzu:

a. Öffnen Sie die Datei waapi.init.b. Geben Sie für das Merkmal waapi.password.encryption den Wert aes an.c. Geben Sie für das Merkmal waapi.ssl.trustStorePassword das in Schritt 1

verschlüsselte Kennwort an.3. Wiederholen Sie die Schritte 2b und 2c für die folgenden Merkmale:

v waapi.password

v waapi.ssl.keyStorePassword

WAAPI-Kennwörter mit dem FIPS 140–2-Modus verschlüsselnZur Verschlüsselung von WAAPI-Kennwörtern für SSL- und Nicht-SSL-Verbindun-gen im FIPS 140–2-Modus können Sie das Tool ncw_fips_crypt verwenden. Siekönnen die WAAPI-Kennwortverschlüsselung unabhängig davon konfigurieren, obder WAAPI-Client auf demselben Server wie Dashboard Application Services Huboder auf einem anderen Server installiert ist.

Vorbereitende Schritte

Wenn der FIPS 140–2-Modus aktiviert wurde, können Sie nur die Kennwortver-schlüsselung im FIPS 140–2-Modus verwenden. Zur Verwendung des Toolsncw_fips_crypt muss IBM® JRE installiert sein.


Das Kennwort für den Standard-Truststore lautet WebAS.

Der standardmäßig definierte WAAPI-Vaultschlüssel (geheimer Schlüssel) befindetsich in WEBGUI_HOME/waapi/etc/encrypt/vault.key. Der Vaultschlüssel wird bei derersten Verwendung des Tools ncw_fips_crypt automatisch generiert und in der Da-tei waapi-installationsverzeichnis/etc/encrypt/vault.key gespeichert.

Die Position der Datei waap.init, in die Sie das verschlüsselte Kennwort eingebenmüssen, variiert in Abhängigkeit von der Installationsposition des WAAPI-Clients.Wenn der WAAPI-Client auf demselben Server wie Dashboard Application ServicesHub installiert ist, befindet sich die Datei in WEBGUI_HOME/waapi/etc/waapi.init.Wenn der WAAPI-Client auf einem anderen Server als Dashboard Application Ser-vices Hub installiert ist, befindet sich die Datei in waapi-installationsverzeichnis/etc/waapi.init.

Vorgehensweise1. Verschlüsseln Sie das WAAPI-Kennwort:

a. Geben Sie den folgenden Befehl ein:WEBGUI_HOME/waapi/bin/ncw_fips_crypt –password WebAS -keyWEBGUI_HOME/waapi/etc/encrypt/vault.key


Wenn Sie den standardmäßig definierten Vaultschlüssel verwenden, könnenSie den Parameter key übergehen. Es wird ein verschlüsseltes Kennwort ge-neriert.

b. Kopieren Sie das verschlüsselte Kennwort.2. Fügen Sie das verschlüsselte Kennwort hinzu:

a. Öffnen Sie die Datei waapi.init.b. Geben Sie für das Merkmal waapi.password.encryption den Wert fips an.c. Geben Sie für das Merkmal waapi.ssl.trustStorePassword das in Schritt 1

auf Seite 126 generierte Kennwort an.3. Wiederholen Sie die Schritte 2b und 2c für die folgenden Merkmale:

v waapi.password

v waapi.ssl.keyStorePassword

Nächste Schritte

Zum Generieren eines neuen Vaultschlüssels müssen Sie den Parameter -genkeyverwenden. Geben Sie den folgenden Befehl ein: WEBGUI_HOME/waapi/bin/ncw_fips_crypt –genkey <locationofvaultkeyfile>. Kopieren Sie die neue Vault-schlüsseldatei nach Ausführung des Befehls in das Verzeichnis waapi-installationsverzeichnis/etc/encrypt/.

Merkmaldatei 'waapi.init' schützenSchützen Sie die Merkmaldatei waapi.init gegen Zugriff durch nicht berechtigteBenutzer.

Vorgehensweise

Verwenden Sie die Einrichtungen des Betriebssystems, um die Zugriffsberechtigun-gen für die Datei waapi.init festzulegen. Stellen Sie sicher, dass die Datei nur fürberechtigte Administratoren des Web-GUI-Servers zugänglich ist. Dies ist insbeson-dere wichtig, wenn die Datei den Benutzernamen und das Kennwort des Web-GUI-Administrators enthält.



Bemerkungen

Die vorliegenden Informationen wurden für Produkte und Services entwickelt, dieauf dem deutschen Markt angeboten werden.

Möglicherweise bietet IBM die in dieser Dokumentation beschriebenen Produkte,Services oder Funktionen in anderen Ländern nicht an. Informationen über die ge-genwärtig im jeweiligen Land verfügbaren Produkte und Services sind beim zu-ständigen IBM Ansprechpartner erhältlich. Hinweise auf IBM Lizenzprogrammeoder andere IBM Produkte bedeuten nicht, dass nur Programme, Produkte oderServices von IBM verwendet werden können. An Stelle der IBM Produkte, Pro-gramme oder Services können auch andere, ihnen äquivalente Produkte, Program-me oder Services verwendet werden, solange diese keine gewerblichen oder ande-ren Schutzrechte der IBM verletzen. Die Verantwortung für den Betrieb vonProdukten, Programmen und Services anderer Anbieter liegt beim Kunden.

Für in diesem Handbuch beschriebene Erzeugnisse und Verfahren kann es IBM Pa-tente oder Patentanmeldungen geben. Mit der Auslieferung dieses Handbuchs istkeine Lizenzierung dieser Patente verbunden. Lizenzanforderungen sind schriftlichan folgende Adresse zu richten (Anfragen an diese Adresse müssen auf Englischformuliert werden):

IBM Director of LicensingIBM Europe, Middle East & AfricaTour Descartes2, avenue Gambetta92066 Paris La DefenseFrance

Trotz sorgfältiger Bearbeitung können technische Ungenauigkeiten oder Druckfeh-ler in dieser Veröffentlichung nicht ausgeschlossen werden. Die Angaben in diesemHandbuch werden in regelmäßigen Zeitabständen aktualisiert. Die Änderungenwerden in Überarbeitungen oder in Technical News Letters (TNLs) bekannt gege-ben. IBM kann jederzeit Verbesserungen und/oder Änderungen an den in dieserVeröffentlichung beschriebenen Produkten und/oder Programmen vornehmen.

Verweise in diesen Informationen auf Websites anderer Anbieter werden lediglichals Service für den Kunden bereitgestellt und stellen keinerlei Billigung des Inhaltsdieser Websites dar. Das über diese Websites verfügbare Material ist nicht Bestand-teil des Materials für dieses IBM Produkt. Die Verwendung dieser Websites ge-schieht auf eigene Verantwortung.

Werden an IBM Informationen eingesandt, können diese beliebig verwendet wer-den, ohne dass eine Verpflichtung gegenüber dem Einsender entsteht.

Lizenznehmer des Programms, die Informationen zu diesem Produkt wünschenmit der Zielsetzung: (i) den Austausch von Informationen zwischen unabhängigvoneinander erstellten Programmen und anderen Programmen (einschließlich desvorliegenden Programms) sowie (ii) die gemeinsame Nutzung der ausgetauschtenInformationen zu ermöglichen, wenden sich an eine der folgenden Adressen:


IBM Corporation958/NH04IBM Centre, St Leonards601 Pacific HwySt Leonards, NSW, 2069Australia

IBM Corporation896471/H128B76 Upper GroundLondon SE1 9PZUnited Kingdom

IBM CorporationJBFA/SOM1294 Route 100Somers, NY, 10589-0100United States of America

Die Bereitstellung dieser Informationen kann unter Umständen von bestimmtenBedingungen - in einigen Fällen auch von der Zahlung einer Gebühr - abhängigsein.

Die Lieferung des im Dokument aufgeführten Lizenzprogramms sowie des zuge-hörigen Lizenzmaterials erfolgt auf der Basis der IBM Rahmenvereinbarung bzw.der Allgemeinen Geschäftsbedingungen von IBM, der IBM Internationalen Nut-zungsbedingungen für Programmpakete oder einer äquivalenten Vereinbarung.

Alle in diesem Dokument enthaltenen Leistungsdaten stammen aus einer kontrol-lierten Umgebung. Die Ergebnisse, die in anderen Betriebsumgebungen erzielt wer-den, können daher erheblich von den hier erzielten Ergebnissen abweichen. EinigeDaten stammen möglicherweise von Systemen, deren Entwicklung noch nicht ab-geschlossen ist. Eine Gewährleistung, dass diese Daten auch in allgemein verfügba-ren Systemen erzielt werden, kann nicht gegeben werden. Darüber hinaus wurdeneinige Daten unter Umständen durch Extrapolation berechnet. Die tatsächlichen Er-gebnisse können davon abweichen. Benutzer dieses Dokuments sollten die entspre-chenden Daten in ihrer spezifischen Umgebung prüfen.

Alle Informationen zu Produkten anderer Anbieter stammen von den Anbieternder aufgeführten Produkte, deren veröffentlichten Ankündigungen oder anderenallgemein verfügbaren Quellen. IBM hat diese Produkte nicht getestet und kanndaher keine Aussagen zu Leistung, Kompatibilität oder anderen Merkmalen ma-chen. Fragen zu den Leistungsmerkmalen von Produkten anderer Anbieter sind anden jeweiligen Anbieter zu richten.

Aussagen über Pläne und Absichten von IBM unterliegen Änderungen oder kön-nen zurückgenommen werden und repräsentieren nur die Ziele von IBM.

Alle von IBM angegebenen Preise sind empfohlene Richtpreise und können jeder-zeit ohne weitere Mitteilung geändert werden. Händlerpreise können u. U. vonden hier genannten Preisen abweichen.


Diese Veröffentlichung dient nur zu Planungszwecken. Die in dieser Veröffentli-chung enthaltenen Informationen können geändert werden, bevor die beschriebe-nen Produkte verfügbar sind.

Diese Veröffentlichung enthält Beispiele für Daten und Berichte des alltäglichenGeschäftsablaufes. Sie sollen nur die Funktionen des Lizenzprogramms illustrieren;sie können Namen von Personen, Firmen, Marken oder Produkten enthalten. Allediese Namen sind frei erfunden; Ähnlichkeiten mit tatsächlichen Namen und Ad-ressen sind rein zufällig.

COPYRIGHTLIZENZ:

Diese Veröffentlichung enthält Musteranwendungsprogramme, die in Quellenspra-che geschrieben sind und Programmiertechniken in verschiedenen Betriebsumge-bungen veranschaulichen. Sie dürfen diese Musterprogramme kostenlos kopieren,ändern und verteilen, wenn dies zu dem Zweck geschieht, Anwendungsprogram-me zu entwickeln, zu verwenden, zu vermarkten oder zu verteilen, die mit derAnwendungsprogrammierschnittstelle für die Betriebsumgebung konform sind, fürdie diese Musterprogramme geschrieben werden. Diese Beispiele wurden nicht un-ter allen denkbaren Bedingungen getestet. Daher kann IBM die Zuverlässigkeit,Wartungsfreundlichkeit oder Funktion dieser Programme weder zusagen noch ge-währleisten.

Teile dieses Produkts enthalten Software, die von Daniel Veillard entwickelt wurde.v libxml2-2.7.8

Die Software libxml2-2.7.8 wird auf der Grundlage der folgenden Lizenzverein-barung zur Verfügung gestellt:© Copyright 1998-2003 Daniel Veillard.Alle Rechte vorbehalten. Hiermit wird jeder Person, die eine Kopie dieser Softwareund der zugehörigen Dokumentationsdateien (die „Software”) erhält, die kostenlo-se Genehmigung erteilt, uneingeschränkt mit der Software zu handeln. Dazu ge-hört ohne Einschränkung das Recht, Kopien der Software zu nutzen, zu kopieren,zu ändern, zusammenzufügen, zu veröffentlichen, zu verteilen, zu verkaufen und/oder Unterlizenzen zu erteilen und den Personen, denen die Software zur Verfü-gung gestellt wird, das gleiche Recht einzuräumen, vorausgesetzt, die folgendenBedingungen werden erfüllt:Der obige Copyrightvermerk, dieser Genehmigungsnachweis und die obige Pro-duktinformation müssen in allen Kopien oder wesentlichen Teilen der Softwareenthalten sein.Die Software wird ohne Wartung (auf „as-is”-Basis) und ohne Gewährleistung(ausdrücklich oder stillschweigend) zur Verfügung gestellt, einschließlich der Ge-währleistung für die Handelsüblichkeit, die Verwendungsfähigkeit für einen be-stimmten Zweck und die Freiheit von Rechten Dritter. Unter keinen Umständen istDaniel Veillard haftbar für Forderungen, Schäden oder andere Verpflichtungen, sei-en sie verschuldensabhängig oder verschuldensunabhängig, die in irgendeinerForm auf die Nutzung oder den Umgang mit der Software zurückzuführen wären.Mit Ausnahme der Verwendung in diesem Hinweis darf der Name von DanielVeillard ohne seine vorherige schriftliche Genehmigung nicht zu Werbezwecken,anderen Arten der Verkaufsförderung oder zur Nutzung in dieser Software ver-wendet werden.

Bemerkungen 131

MarkenIBM, das IBM Logo, ibm.com, Netcool, Netcool/OMNIbus, Tivoli und WebSpheresind Marken oder eingetragene Marken der IBM Corporation in den USA und/oder anderen Ländern.

Adobe, Acrobat, Portable Document Format (PDF), PostScript und alle auf Adobebasierenden Marken sind Marken oder eingetragene Marken der Adobe SystemsIncorporated in den USA und/oder anderen Ländern.

Java und alle auf Java basierenden Marken und Logos sind Markenoder eingetragene Marken von Sun Microsystems, Inc. in den USAund/oder anderen Ländern.

Linux ist eine eingetragene Marke von Linus Torvalds in den USA und/oder ande-ren Ländern.

Microsoft, Windows, Windows NT und das Windows-Logo sind Marken der Mi-crosoft Corporation in den USA und/oder anderen Ländern.

UNIX ist eine eingetragene Marke von The Open Group in den USA und anderenLändern.

Weitere Unternehmens-, Produkt- oder Servicenamen können Marken oder Service-marken anderer Hersteller sein.


Index

Sonderzeichen<filterCollection> 90<icon> 41<menu> 57<metric:metric> 95<relationship:relationship> 102<resource> 52<resources> 52<separator> 57<supermenu> 57<tool:access> 62<tool:cgiurl> 62<tool:cmdline> 62<tool:criterion> 62<tool:equals> 62<tool:fieldlist> 62<tool:journal> 62<tool:osfield> 62<tool:script> 62<tool:security> 62<tool:sql> 62<tool:tool> 62<user> 14

AAnforderung 9

Benutzer 13Beziehung 102CGI 80Datei 54Eingabeaufforderung 71Filter 83Filterobjektgruppe 90Map 30Menü 57Messwert 95Ressource 52Sicht 22sonstige 107Struktur 9Tool 62

Anforderung für Eingabeaufforde-rung 71

ändern 80auflisten 79erstellen oder ersetzen 72löschen 79

Anforderung für visuelle Mapelementeändern 51hinzufügen 50hinzufügen oder ersetzen 50löschen 51

AuthentifizierungClient/Server 117

FIPS 140-2 121nur Server 116

FIPS 140-2 119

BBefehle

runwaapiBefehlszeilenoptionen 109

Behindertengerechte Bedienung viiBenutzeranforderung 13

ändern 13auflisten 22verwalten 13

Beziehungsanforderung 102ändern 106auflisten 106erstellen 102erstellen oder ersetzen 105löschen 106

CCGI-Anforderung 80

ändern 82erstellen oder ersetzen 82registrieren 81Registrierung zurücknehmen 82

Client/ServerSicherheit 117

FIPS 140-2 121

DDateianforderung 54

Datei erstellen oder ersetzen 56Datei hinzufügen 55Datei löschen 56Verzeichnis entfernen 56Verzeichnis hinzufügen 54Verzeichnis rekursiv entfernen 57

Dateienwaapi.init 109, 116, 117, 119, 121, 125,

126, 127Dienstprogramme

ncw_aes_crypt 125ncw_fips_crypt 126

Dokumenttypdefinition 11DTD

siehe Dokumenttypdefinition

EElement

<filterCollection> 90<icon> 41<menu> 57<metric:metric> 95<relationship:relationship> 102<resource> 52<resources> 52<separator> 57<supermenu> 57<tool:access> 62

Element (Forts.)<tool:cgiurl> 62<tool:cmdline> 62<tool:criterion> 62<tool:equals> 62<tool:fieldlist> 62<tool:journal> 62<tool:osfield> 62<tool:script> 62<tool:security> 62<tool:sql> 62<tool:tool> 62<user> 14

FFerner Host

InstallationWAAPI-Client 113

Filteranforderung 83ändern 89auflisten 88erstellen oder ersetzen 87hinzufügen 83löschen 88Standardsicht festlegen 90

Filterobjektgruppenanforderung 90ändern 94auflisten 93erstellen 90erstellen oder ersetzen 92Filter hinzufügen 91Filter löschen 93löschen 92Sicht festlegen 94

FIPS 140-2Client/Server 121nur Server 119

HHandbücher v

IInformationen zur Unterstützung vii

KKennwort

VerschlüsselungAES 125FIPS 140–2 126

KennwörterVerschlüsselung 4, 125

Kommunikation 3Konventionen, Schriftbild viii


LLastausgleich

Knoten entfernen 108

MMapanforderung 30

ändern 49auflisten 49erstellen 30erstellen oder ersetzen 48löschen 49

Menüanforderung 57ändern 61auflisten 61erstellen 57erstellen oder ersetzen 60löschen 60

Messwertanforderung 95ändern 101aufrufen 101erstellen 95erstellen oder ersetzen 100löschen 101

OOnlineveröffentlichungen v

RRessourcenanforderung 52

auflisten 54entfernen 53erstellen oder ersetzen 53hinzufügen 52

SSchriftbildkonventionen viiiSchulung

siehe Tivoli-Schulungen viiSchulungen, Tivoli viiServer

Sicherheit 116FIPS 140-2 119

Sicherheit 115FIPS 140-2

Client/Server 121serverseitig 119

Kennwortverschlüsselung 4, 125AES 125FIPS 140-2 126

WAAPIClient/Server 117serverseitig 116Übersicht 4, 115

Sichtanforderung 22ändern 28auflisten 29erstellen 22erstellen oder ersetzen 27löschen 29

Sonstige Anforderungen 107Cache resynchronisieren 108

Sonstige Anforderungen (Forts.)Filter und Sichten erneut laden 108Knoten aus einem Cluster entfer-

nen 108Systemstatusbericht 107

SSLKennwortverschlüsselung

AES 125

TTivoli-Schulungen viiTivoli Software Information Center vToolanforderung 62

ändern 70auflisten 70erstellen 62erstellen oder ersetzen 69löschen 70

TruststoreWAAPI

Unterzeichnerzertifikat 116, 117,119, 121

UUmgebungsvariablen, Schreibweise viii

VVariablen, Schreibweise viiiVergleich

WAAPI- und Web-GUI-Prozedur 3Veröffentlichungen vVeröffentlichungen bestellen v

WWAAPI

Befehlszeilenoptionen 109Installation

ferner Host 113Kennwortverschlüsselung 4, 125

AES 125FIPS 140–2 126

Kommunikation mit Server 3Merkmale 109, 127Sicherheit 115

Übersicht 4, 115Truststore

Unterzeichnerzertifikat 116, 117,119, 121

Vergleich mit Web-GUI 3verwenden 7

WAAPI-Anforderung 9Benutzer 13Beziehung 102CGI 80Datei 54Dokumenttypdefinition 11Eingabeaufforderung 71Elementreihenfolge 11Filter 83Filterobjektgruppe 90Groß-/Kleinschreibung 11

WAAPI-Anforderung (Forts.)Inhalts- und Werteinschränkun-

gen 11Kommentare 11Map 30Menü 57Merkmale 11Messwert 95Ressource 52Sicht 22sonstige 107Stammelement 9Struktur 9Tool 62XML-Deklaration 9

ZZielgruppe v


��

SC43-2385-01

Documents

Web GUIAdministrationAPI (WAAPI) Benutzerhandbuch · 2020. 12. 10. · Kapitel 1. Web GUI Administration API (WAAPI ... IBM Support Assistant (ISA) ist eine kostenlose lokale Arbeitsumgebung