NetWorker: How to Enable REST API Debugging

摘要: This article provides instructions on how to enable debugging for Representational State Transfer (REST) Application Programming Interface (API) calls performed in NetWorker.

本文章適用於 本文章不適用於 本文無關於任何特定產品。 本文未識別所有產品版本。
查看其他資源

說明

  1.  Log in to the NetWorker server.
  2.  Make a copy of the logback.xml file: 
Linux: 
/nsr/authc/webapps/nwrestapi/WEB-INF/classes/logback.xml
Windows:  
C:\Program Files\EMC NetWorker\nsr\authc-server\tomcat\webapps\nwrestapi\WEB-INF\classes\logback.xml
  1. Open the logback.xml file with a text editor and make the below change:
<!-- Note: Supported levels are "error", "warn", "info", "debug", and "trace". -->
  <logger name="com.emc.nw.webapi" level="info"/>
  <logger name="com.emc.nw.comm" level="info"/>
  <logger name="com.emc.nw.util" level="info"/>
  <!-- Note: For API call logging, enable the following trace settings.
  <logger name="com.emc.nw.webapi.WebApiRequest" level="trace"/>
  <logger name="com.emc.nw.webapi.WebApiResponse" level="trace"/>
  -->

  <logger name="org.springframework" level="warn"/>
  <logger name="org.apache.cxf.jaxrs.provider" level="error"/>

  <root level="warn">

To:

<!-- Note: Supported levels are "error", "warn", "info", "debug", and "trace". -->
 <logger name="com.emc.nw.webapi" level="debug"/>
 <logger name="com.emc.nw.comm" level="debug"/>
 <logger name="com.emc.nw.util" level="debug"/>
 <!-- Note: For API call logging, enable the following trace settings. -->
 <logger name="com.emc.nw.webapi.WebApiRequest" level="trace"/>
 <logger name="com.emc.nw.webapi.WebApiResponse" level="trace"/>
		  
 <logger name="org.springframework" level="debug"/>
 <logger name="org.apache.cxf.jaxrs.provider" level="debug"/>

 <root level="debug">
NOTE: change the highlighted level values from "warn" to "debug." Move the --> from the end of the WebApi lines to the end of the comment line. Data within "<!-- -->" is commented in XML and not read by the service settings.
  1. No service restart is required. Reproduce issue requiring REST API debugging. To disable debug, revert the changes or remove the modified logback.xml and put the copy back in its place.
  2. Collect the restapi.log:
Linux: 
/nsr/logs/restapi/restapi.log
Windows: 
C:\Program Files\EMC NetWorker\nsr\logs\restapi\restapi.log
  1. The NetWorker authc logs are also useful in troubleshooting REST API-related issues:
Linux: 
/nsr/authc/logs
Windows: 
C:\Program Files\EMC NetWorker\nsr\authc-server\tomcat\logs

其他資訊

受影響的產品

NetWorker

產品

NetWorker Family, NetWorker Series
文章屬性
文章編號: 000206441
文章類型: How To
上次修改時間: 12 8月 2025
版本:  5
向其他 Dell 使用者尋求您問題的答案
支援服務
檢查您的裝置是否在支援服務的涵蓋範圍內。