Guía de triage de API REST de NetWorker

Ver en YouTube

Introducción

Conexión a NetWorker:

• Tipo de contenido: application/json
• Aceptar: application/json
• Autorización: Básico con nombre de usuario y contraseña codificados de base 64

En entornos donde hay varias zonas de datos de NetWorker que se autentican a través de un único servidor AUTHC de NetWorker, se requiere un encabezado adicional:

• X-NW-AUTHC-BASE-URL:AUTHC_HOSTNAME_OR_IP:AUTHC_PORT

La API REST de NetWorker se expone en el siguiente URI base:

https://[nw-server-hostname]:9090/nwrestapi/

https://[nw-server-hostname]:9090/nwrestapi/v1
https://[nw-server-hostname]:9090/nwrestapi/v2
https://[nw-server-hostname]:9090/nwrestapi/v3

El esquema json completo está disponible en

https://[nw-server-hostname]:9090/nwrestapi/v3/schemas/swagger.json

Funciones de API REST

Algunos ejemplos:

GET

Enumere todos los clientes.                                            

https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients

Un solo cliente, que muestra solo tres campos (nombre de host, savesets y grupos de protección)      

https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients?fl=hostname,saveSets,protectionGroups&q=hostname:nwserver121

Enumere los grupos de protección en los que se encuentra un cliente.     

https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients?fl=protectionGroups&q=hostname:nwserver121

Mostrar alertas actuales.                                     

https://[nw-server-hostname]:9090/nwrestapi/v3/global/alerts

Mostrar los trabajos fallidos recientes.                               

https://[nw-server-hostname]:9090/nwrestapi/v3/global/jobs?q=completionStatus:"Failed"&fl=clientHostname,startTime,name,message

Enumere los flujos de trabajo en una política (denominada WinFS en este ejemplo).                   

https://[nw-server-hostname]:9090/nwrestapi/v3/global/protectionpolicies/WinFS/workflows

Muestra las propiedades de una instancia de saveset solamente (según lo definido por el nombre de host del cliente y el saveset).      

https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients?q=hostname:vm-lego-231 and saveSets:"/etc"

EXPONER:

Inicie una acción de flujo de trabajo.                                 

https://[nw-server-hostname]:9090/nwrestapi/v3/global/protectionpolicies/Angela/workflows/WinFS/op/backup
                                                      JSON Body: 
                                                      {
                                                       }

Cree una nueva instancia de cliente (con valores predeterminados para todas las propiedades, excepto las cuatro enumeradas).           

https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients  
                                                     JSON Body 
                                                     {    
            "hostname": "vm-lego-231",
            "backupType": "Filesystem",
            "saveSets": [ "/etc" ],
            "protectionGroups" : [ "LinuxFS" ]
                                                          

Información necesaria para el soporte

Entorno:

• Nombre del servidor de NetWorker
• Versión y número de compilación de NetWorker
• Tipo y versión del sistema operativo host de NetWorker Server

Linux:

hostname
strings /usr/sbin/nsrd | grep -i "(#)"
cat /etc/*release
uname -a

Windows:

nsrwatch

• Explique qué operación de la API REST se está realizando (GET, POST, PUT, DELETE), el URI utilizado y cualquier contenido del cuerpo JSON (cuando corresponda). 
• El código de respuesta de la API REST y cualquier mensaje de error proporcionado.
• ¿La conexión y la autorización iniciales se realizaron correctamente entre el cliente de la API REST y NetWorker?

• Archivo de registro de daemon.raw generado desde NetWorker Server:
  • Linux: /nsr/logs/daemon.raw
  • Windows: C:\Program Files\EMC NetWorker\nsr\logs\daemon.raw
  • NetWorker: Cómo utilizar nsr_render_log
• Registros de API REST desde NetWorker Server:  /nsr/logs/restapi (Linux) o EMC NetWorker\nsr\logs\restapi (Windows)
• Si tiene problemas de autenticación, consulte el registro de autenticación estándar de NetWorker en /nsr/authc/logs (Linux) o... \EMC NetWorker\nsr\authc-server\tomcat\logs (Windows)

top -b | awk '/nsrtomc+/ {print strftime("%Y-%m-%d-%H:%M:%S", systime()), $0}'

Esta salida muestra la salida superior estándar, pero con marcas de tiempo legibles por humanos. Esto se puede utilizar para revisar el consumo de CPU y memoria por parte del proceso y cuánto tiempo permanecía en un estado determinado cuando se realizaba una llamada REST. Esto se puede comparar con los registros de restapi.log y AUTHC para ver qué llamadas se realizaron y con qué frecuencia.
 

Windows: En el caso de los servidores Windows, debe instalar algo como "Performance Monitor:

1. Abra Performance Monitor como administrador.
2. En el panel izquierdo, expanda Herramientas de monitoreo y seleccione Monitor de rendimiento.
3. Haga clic con el botón secundario en el panel derecho y seleccione Eliminar todos los contadores.
4. Haga clic con el botón secundario en el panel derecho y seleccione Add Counters.
5. En Available Counters, expanda Memory, seleccione % Commit Bytes y haga clic en Add.6
. En Memoria,  seleccione Bytes disponibles y haga clic en Agregar.
7. En Available Counters, expanda Process y seleccione % Processor Time y, en Instances of Selected Object, seleccione la primera entrada de Java y haga clic en Add.
8. En Contadores disponibles, expanda Información del procesador, seleccione % Utilidad del procesador y haga clic en Agregar.
9. Los contadores agregados en el panel derecho deben mostrar:

10. Haga clic en Aceptar. Haga clic con el botón secundario en Monitor de rendimiento y, a continuación, haga clic en Conjunto de recopiladores de> datos nuevos.
11. Proporcione un nombre, por ejemplo: RESTAPI_MON.
12. En la pantalla de ubicación, haga clic en Siguiente,  a menos que elija especificar una ubicación de salida alternativa.
13. Seleccione Guardar y cerrar y haga clic en Finalizar.
14. En el panel izquierdo, en Data Collector Sets-User Defined,> abra las propiedades del RESTAPI_MON y seleccione Separados por comas para el formato de registro y haga clic en Ok.

15. En el panel izquierdo, en Data Collector Sets-User Defined,>seleccione el conjunto de Data Collector RESTAPI_MON y haga clic en Start (botón Play).
16. Si se utilizó la ubicación de salida predeterminada, el archivo de .csv aparece en C:\PerfLogs\Admin\RESTAPI_MON.
17. Una vez que el problema se observa y se registra en el archivo de salida, puede detener el monitoreo haciendo clic en Stop en Data Collector Sets-User Defined.

Más recursos

Todos los terminales de la API REST compatibles y los ejemplos de uso se proporcionan en: Guía de referencia de la API REST de NetWorker