HP OneView - Handbuch (Seite 67)

6 Zugreifen auf die Dokumentation und Hilfe
Dieses Kapitel beschreibt, wie über die Appliance Hilfe aufgerufen wird, wie die öffentlich
zugängliche Online-Informationsbibliothek aufgerufen wird und wo REST-API-Hilfe und
Referenzdokumentation zu finden sind.
6.1 Onlinehilfe – bei Bedarf zugängliche Informationen zu Konzepten und
Aufgaben
Die Onlinehilfe dokumentiert die UI und die REST-APIs und enthält Folgendes:
•
Übersicht über die Appliance und ihre Funktionen
•
Näheres zu Ressourcen und UI-Bildschirmen
•
Schnellstartanweisungen zur Aufnahme des Rechenzentrums in die Verwaltung
•
Schrittweise Anweisungen zum Durchführen von Aufgaben über die UI
•
Informationen zum Durchführen von Aufgaben über REST-API-Skripts
•
Die HP OneView REST API-Referenz
•
Informationen zum Abonnieren von Zustandsänderungsmeldungen über den SCMB
(State-Change Message Bus)
Design der REST-API-Hilfe
Die REST-API-Hilfe ist so konzipiert, dass:
•
jede Ressource in einem eigenen Kapitel dokumentiert wird.
•
jedes REST-API-Skript-Kapitel die REST-API-Aufrufe angibt, die zum Durchführen der Aufgaben
aufgerufen werden müssen.
•
jeder REST-API-Aufruf zur Abfrage von Details zur API, wie z. B. Attribute und Parameter,
zum Ressourcen-Modellschema und zu JSON- (JavaScript Object Notation) Beispielen mit der
HP OneView REST API-Referenz verknüpft ist.
Design der UI-Hilfe
Die Onlinehilfe für die UI ist so konzipiert, dass jede Ressource in einem eigenen Kapitel
dokumentiert wird. Am Anfang eines jeden Hilfekapitels befindet sich ein Navigationsfeld, über
das Sie an die folgenden Stellen geleitet werden:
•
Aufgaben, die Sie über die UI durchführen können
•
Den Abschnitt About (Beschreibung) mit begrifflichen Informationen zur Ressource
•
Einen Detailbereich für jeden Bildschirm mit Definitionen der Bildschirmkomponenten, um
Ihnen die Dateneingabe und das Treffen von Entscheidungen zu erleichtern
•
Informationen zur Fehlerbehebung, sollte ein Problem auftreten
•
Links zur Hilfe verknüpfter REST-APIs, falls Sie eine Aufgabe lieber über REST-API-Skripts
ausführen möchten
6.2 Dieses Benutzerhandbuch ergänzt die Onlinehilfe
Dieses Benutzerhandbuch stellt Folgendes zur Verfügung:
•
Begriffliche Informationen und eine Beschreibung der Aufgaben, die über die UI oder REST-APIs
ausgeführt werden können. Die schrittweisen Anweisungen der Onlinehilfe werden nur dann
6.1 Onlinehilfe – bei Bedarf zugängliche Informationen zu Konzepten und Aufgaben 67