HP OneView - Manual (Página 65)

6 Acceso a la documentación y la ayuda
En este capítulo se describe cómo acceder a la ayuda desde el dispositivo, cómo acceder a la
biblioteca de información en línea a disposición del público y dónde encontrar ayuda y
documentación de referencia sobre la API de REST.
6.1 Ayuda en línea: información conceptual y sobre tareas siempre que
la necesite
La ayuda en línea documenta tanto la interfaz de usuario como las API de REST, e incluye:
•
Información general sobre el dispositivo y sus características
•
Descripciones de los recursos y las pantallas de la interfaz de usuario
•
Instrucciones de inicio rápido para incluir en la gestión el centro de datos
•
Instrucciones detalladas para usar la interfaz de usuario para realizar tareas
•
Información sobre el uso de secuencias de comandos de la API de REST para realizar tareas
•
La HP OneView REST API Reference (Referencia de la API de REST de HP OneView)
•
Información sobre el uso del bus SCMB (State-Change Message Bus) para suscribirse a los
mensajes de cambio de estado
Diseño de la ayuda de la API de REST
La ayuda de la API de REST está diseñada de manera que:
•
Cada recurso está documentado en su propio capítulo.
•
Cada capítulo sobre secuencias de comandos de la API de REST identifica las llamadas a la
API de REST que se deben realizar para completar las tareas.
•
Cada llamada a la API de REST contiene enlaces a la HP OneView REST API Reference
(Referencia de la API de REST de HP OneView) para obtener más información acerca de la
API, como atributos y parámetros, el esquema del modelo de recursos y ejemplos de JSON
(JavaScript Object Notation).
Diseño de la ayuda de la interfaz de usuario
La ayuda en línea de la interfaz de usuario está diseñada de forma que cada recurso está
documentado en su propio capítulo. En la parte superior de cada capítulo de la ayuda hay un
cuadro de navegación que da acceso a:
•
Las tareas que se pueden realizar con la interfaz de usuario
•
Una sección About (Acerca de) que proporciona información conceptual sobre el recurso
•
Una sección de detalles de la pantalla para cada pantalla, que proporciona definiciones de
los componentes de la pantalla para ayudarle en la entrada de datos y la toma de decisiones
•
Información de solución de problemas por si le surge algún problema
•
Enlaces a la ayuda sobre las API de REST relacionadas por si prefiere utilizar las secuencias
de comandos de la API de REST para realizar una tarea
6.2 Esta guía de usuario es un complemento de la ayuda en línea
Esta guía de usuario ofrece:
•
Información conceptual y descripciones de las tareas que se pueden realizar con la interfaz
de usuario o las API de REST. No duplica las instrucciones paso a paso proporcionadas por
6.1 Ayuda en línea: información conceptual y sobre tareas siempre que la necesite 65