6 accès à la documentation et à l'aide, Conception de l'aide des api rest, Conception de l'aide de l'interface utilisateur – HP OneView Manuel d'utilisation

Page 65

Advertising
background image

6 Accès à la documentation et à l'aide

Ce chapitre décrit comment accéder à l'aide de l'appareil, comment accéder à la bibliothèque
d'informations en ligne accessible au public, et où trouver l'aide des API REST et la documentation
de référence.

6.1 Aide en ligne — informations conceptuelles et de tâches lorsque vous
en avez besoin

L'aide en ligne documente à la fois l'interface utilisateur et les API REST, et inclut :

Présentation de l'appareil et de ses fonctions

Description des ressources et des écrans de l'interface utilisateur

Instructions de démarrage rapide pour placer votre centre de données sous gestion

Instructions pas-à-pas d'utilisation de l'interface utilisateur pour exécution de tâches

Informations sur l'utilisation de la rédaction de scripts d'API REST pour exécution de tâches

Le document Référence sur les API REST HP OneView

Informations concernant l'utilisation du bus SCMB (State-Change Message Bus) pour
abonnement aux messages de changement d'état

Conception de l'aide des API REST

L'aide des API REST est conçue de sorte que :

Chaque ressource est décrite dans son propre chapitre.

Chaque chapitre de rédaction de scripts d'API REST identifie les appels d'API REST que vous
devez invoquer pour accomplir les tâches.

Chaque appel d'API REST est lié au document Référence sur les API REST HP OneView pour
plus de détails sur l'API, tels que paramètres et attributs, le schéma du modèle de ressource,
ainsi que des exemples JSON (JavaScript Object Notation).

Conception de l'aide de l'interface utilisateur

L'aide en ligne de l'interface utilisateur est conçue de sorte que chaque ressource est documentée
dans son propre chapitre. Au début de chaque chapitre de l'aide se trouve une zone de navigation
qui vous dirige vers les éléments suivants :

Les tâches que vous pouvez effectuer à l'aide de l'interface utilisateur

Une section À propos qui fournit des informations conceptuelles sur la ressource

Une section de détails pour chaque écran, qui fournit la définition des composants de l'écran
afin de vous aider dans la saisie de données et la prise de décision

Informations de résolution de problèmes dans l'éventualité où vous rencontreriez un problème

Liens vers l'aide des API REST associées si vous préférez utiliser la rédaction de scripts d'API
REST pour l'exécution d'une tâche

6.2 Ce manuel de l'utilisateur complète l'aide en ligne

Ce manuel de l'utilisateur fournit les éléments suivants :

Informations conceptuelles et description des tâches que vous pouvez effectuer à l'aide de
l'interface utilisateur ou des API REST. Il ne reproduit pas les instructions pas-à-pas fournies

6.1 Aide en ligne — informations conceptuelles et de tâches lorsque vous en avez besoin

65

Advertising