Diagnosis

This chapter provides examples on how to use Netconf to manage diagnosis tools on AsterNOS devices.

Enable sdk-shell

Caution

NOTE: Enable sdk-shell in debug mode.

Request example to enable sdk-shell in debug mode via rpc sdk-shell-enable

<sdk-shell-enable>
  <enable>true</enable>
</sdk-shell-enable>

Response example

<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:4cba3f31-61e4-400a-ba1c-f7daff32ec01">
  <ok/>
</rpc-reply>

Disable sdk-shell

Caution

NOTE: Disable sdk-shell in debug mode.

Request example to disable sdk-shell in debug mode via rpc sdk-shell-enable

<sdk-shell-enable>
  <enable>false</enable>
</sdk-shell-enable>

Response example

<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:7b04a019-b101-42ef-8b89-bb9777103aa6">
  <ok/>
</rpc-reply>

Get diagnostic information

Caution

NOTE: Retrieve diagnostic information and save it to the /var/dump directory. After Executing the rpc command, please wait for about 60 seconds. You can find the file sonic_dump_sonic_*.tar in the /var/dump directory.

Request example to retrieve diagnostic information via rpc show-diagnostic-information

<show-diagnostic-information/>

Response example

<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:d7e66a33-a219-4193-a3a8-e29236fef1c3">
  <ok/>
</rpc-reply>

Get diagnostic information from a specific time

Caution

NOTE: Retrieve diagnostic information from a specific time and save it to the /var/dump directory. After Executing the rpc command, please wait for about 60 seconds. You can find the file sonic_dump_sonic_*.tar in the /var/dump directory.

Request example to retrieve diagnostic information from a specific time via rpc show-diagnostic-information

<show-diagnostic-information>
  <start-date>2025-9-27</start-date>
</show-diagnostic-information>

Response example

<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:9a106f89-542c-4bc9-baf6-2b8e546daddd">
  <ok/>
</rpc-reply>

Get diagnostic information with a specified number of logs

Caution

NOTE: Retrieve diagnostic information with a specified number of logs and save it to the /var/dump directory. After Executing the rpc command, please wait for about 60 seconds. You can find the file sonic_dump_sonic_*.tar in the /var/dump directory.

Request example to retrieve diagnostic information with a specified number of logs via rpc show-diagnostic-information

<show-diagnostic-information>
  <log-count>3</log-count>
</show-diagnostic-information>

Response example

<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:90ead5c6-f57f-4e14-b9b2-c65422997015">
  <ok/>
</rpc-reply>