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ユーザーからの回答を見つける
サポート サービス
お使いのデバイスがサポート サービスの対象かどうかを確認してください。