NetWorker REST API Triage Guide

Kijk op YouTube

Aan de slag

Verbinding maken met NetWorker:

• Inhoudstype: application/json
• Accepteren: application/json
• Authenticatie: Basic met Base 64-gecodeerde gebruikersnaam en wachtwoord

In omgevingen waar meerdere NetWorker-datazones worden geverifieerd via één NetWorker AUTHC-server, is een extra header vereist:

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

De NetWorker REST API wordt weergegeven in de volgende basis-URI:

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

Het volledige json-schema is beschikbaar op

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

REST API-functies

Enkele voorbeelden:

GET

Maak een lijst van alle clients.                                            

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

Slechts één client, met slechts drie velden (hostname, saveSets en protectionGroups)      

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

Maak een lijst van de beveiligingsgroepen waarin een client zich bevindt.     

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

Huidige waarschuwingen weergeven.                                     

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

Recente mislukte taken weergeven.                               

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

Geef de werkstromen weer in één beleid (in dit voorbeeld WinFS genoemd).                   

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

Geef de eigenschappen van slechts één saveset-instantie weer (zoals gedefinieerd door de hostnaam van de client en de opslagset).      

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

VERZENDEN:

Start een workflowactie.                                 

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

Maak een nieuwe clientinstantie (met standaardwaarden voor alle eigenschappen behalve de vier vermelde).           

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

Vereiste informatie voor support

Omgeving:

• NetWorker-servernaam
• Versie en buildnummer van NetWorker
• Type en versie van besturingssysteem van NetWorker serverhost

Linux:

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

Windows:

nsrwatch

• Leg uit welke REST API-bewerking wordt uitgevoerd (GET, POST, PUT, DELETE), de gebruikte URI en eventuele JSON-body-inhoud (indien van toepassing). 
• REST API-antwoordcode en eventuele verstrekte foutmeldingen.
• Is de initiële verbinding en autorisatie tussen de REST API-client en NetWorker geslaagd?

• Gerenderde daemon.raw logbestand van de NetWorker-server:
  • Linux: /nsr/logs/daemon.raw
  • Windows: C:\Program Files\EMC NetWorker\nsr\logs\daemon.raw
  • NetWorker: Hoe nsr_render_log te gebruiken
• REST API-logboeken van de NetWorker-server:  /nsr/logs/restapi (Linux) of EMC NetWorker\nsr\logs\restapi (Windows)
• Zie voor authenticatieproblemen de standaard NetWorker-authenticatielogging in /nsr/authc/logs (linux) of .. \EMC NetWorker\nsr\authc-server\tomcat\logs (Windows)

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

Deze uitvoer toont standaard topuitvoer, maar met door mensen leesbare tijdstempels. Dit kan worden gebruikt om het CPU- en geheugenverbruik per proces te bekijken en hoe lang het in een bepaalde status bleef toen een REST-aanroep werd gedaan. Dit kan worden vergeleken met de restapi.log- en AUTHC-logboeken om te zien welke oproepen zijn gedaan en hoe vaak.
 

Windows: Voor Windows-servers moet u iets installeren als "Performance Monitor:

1. Open Performance Monitor als administrator.
2. Vouw in het linkerdeelvenster Controletools uit en selecteer Prestatiemonitor.
3. Klik met de rechtermuisknop in het rechterdeelvenster en selecteer Alle tellers verwijderen.
4. Klik met de rechtermuisknop in het rechterdeelvenster en selecteer Tellers toevoegen.
5. Vouw onder Beschikbare tellers Geheugen uit, selecteer % commit-bytes en klik op Toevoegen.6
. Selecteer onder Memory de optie Available Bytes en klik op Add.
7. Vouw onder Beschikbare tellersProces uit en selecteer % processortijd en selecteer onder Instanties van geselecteerd object het eerste Java-item. Klik op Toevoegen.
8. Vouw onder Beschikbare tellersProcessorinformatie uit en selecteer % processorhulpprogramma en klik op Toevoegen.
9. De toegevoegde tellers in het rechterdeelvenster zouden het volgende moeten weergeven:

10. Klik op OK. Klik met de rechtermuisknop op Prestatiemeter en klik op Nieuwe> dataverzamelaarset.
11. Geef een naam op, bijvoorbeeld: RESTAPI_MON.
12. Klik in het locatiescherm op Volgende,  tenzij u ervoor kiest om een alternatieve uitvoerlocatie op te geven.
13. Selecteer Opslaan en sluiten en klik op Voltooien.
14. Open in het linkerdeelvenster onder Data Collector Sets-User> Defined de RESTAPI_MON properties en selecteer Comma Separated voor de logboekindeling. Klik op OK.

15. Selecteer in het linkerdeelvenster onder Data Collector Sets-User> Defined de RESTAPI_MON data collector set en klik op Start (knop Afspelen).
16. Als de standaarduitvoerlocatie is gebruikt, wordt het .csv bestand weergegeven onder C:\PerfLogs\Admin\RESTAPI_MON.
17. Zodra het probleem is waargenomen en vastgelegd in het uitvoerbestand, kunt u de bewaking stoppen door te klikken op Stoppen onder Data Collector Sets-User Defined.

Verdere bronnen

Alle ondersteunde REST API-eindpunten en gebruiksvoorbeelden zijn beschikbaar in: Naslaggids voor NetWorker REST API