5.10. NETCONF Show and Debug Command Reference

5.10.1. Command Hierarchies

5.10.1.1. Show Commands

show
— system
datastore-locks [detail]

5.10.1.2. Debug Commands

debug
— system
info

5.10.2. Command Descriptions

5.10.2.1. Show Commands

Command outputs shown in this section are examples only; actual displays may differ depending on supported functionality and user configuration.

5.10.2.1.1. System Commands

management-interface

Syntax 
management-interface
Context 
show>system
Description 

This command enters the context to display management interface information.

datastore-locks

Syntax 
datastore-locks [detail]
Context 
show>system>management-interface
Description 

This command displays datastore locks information.

Parameters 
detail—
Displays session-specific information.
Output 

The following output displays general datastores’ locking status information. Table 64 describes the output fields.

Sample Output
# show system management-interface datastore-locks
-------------------------------------------------------------------------------
Region      Datastore                     Lock State     
-------------------------------------------------------------------------------
configure   running                       locked         
configure   candidate                     unlocked
-------------------------------------------------------------------------------

The following outputs displays detail datastore locks information for all datastores. Table 64 describes the output fields.

Sample Output
# show system management-interface datastore-locks detail 
-------------------------------------------------------------------------------
Session ID  Region      Datastore                     Lock State     
  Username             From                 Session Type    Session Mode
-------------------------------------------------------------------------------
23          configure   running                       locked 
  admin                192.168.255.255          netconf         exclusive
26          configure   candidate                     unlocked
  test1                192.168.255.255          md-cli          global
-------------------------------------------------------------------------------

The following outputs displays detail datastore locks information for all datastores. Table 64 describes the output fields.

Sample Output
# show system management-interface datastore-locks detail 
-------------------------------------------------------------------------------
Session ID  Region      Datastore                     Lock State     
  Username             From                 Session Type    Session Mode
-------------------------------------------------------------------------------
45          configure   running, candidate            locked 
  admin                192.168.255.255          md-cli          exclusive
-------------------------------------------------------------------------------

The following outputs displays detail datastore locks information for all datastores. Table 64 describes the output fields.

Sample Output
# show system management-interface datastore-locks detail 
-------------------------------------------------------------------------------
Session ID  Region      Datastore                     Lock State     
  Username             From                 Session Type    Session Mode
-------------------------------------------------------------------------------
45          configure   running, candidate            locked 
  admin                192.168.255.255          grpc            exclusive
-------------------------------------------------------------------------------

The following outputs displays detail datastore locks information for all datastores. Table 64 describes the output fields.

Sample Output
# show system management-interface datastore-locks detail 
-------------------------------------------------------------------------------
Session ID  Region                 Datastore                     Lock State    
  Username                         From                 
  Session Type                     Session Mode
-------------------------------------------------------------------------------
23          configure              candidate                     locked
  admin                            192.168.255.255         
  netconf                          exclusive
 
-------------------------------------------------------------------------------
Table 64:  Datastore-locks Output Fields 

Label

Description  

Session ID

The NETCONF session ID.

Region

The region or scope that the datastore belongs to.

Datastore

Datastores that can be locked. For example: <running> and <candidate>.

Username

The name of the user.

Session Type

netconf — Indicates a NETCONF session is running.

md-cli — Indicates an MD-CLI session is running.

Lock State

locked — Indicates the session is in a locked state.

unlocked — Indicates the session is in an unlocked state.

Session Mode

global — A shared MD-CLI session.

exclusive — An exclusive MD-CLI session.

netconf

Syntax 
netconf
Context 
show>system
Description 

This command displays NETCONF SSH sessions.

Output 

The following displays NETCONF information.

Table 65 describes the NETCONF output fields.

Sample Output
# show system netconf
===============================================================================
NETCONF Server
===============================================================================
Administrative State      : Enabled
Operational State         : Up
-------------------------------------------------------------------------------
Connection          Username       Session Status         Running    Candidate
                                   Id                     Locked?    Locked?
-------------------------------------------------------------------------------
10.224.26.145      admin          17      connected      no         no
10.224.26.145      admin          15      connected      no         no
-------------------------------------------------------------------------------
Number of NETCONF sessions : 2
===============================================================================
Table 65:  Show System NETCONF Output Fields 

Label

Description  

Administrative State

Enabled — Displays that NETCONF is enabled.

Disabled — Displays that NETCONF is disabled.

Operational State

Up — Displays that NETCONF is operational.

Down — Displays that NETCONF is not operational.

Connection

The IP address of the connected router(s) (remote client).

Username

The name of the user.

Session ID

The NETCONF session ID.

Status

Connected or not connected.

Number of NETCONF sessions

Total NETCONF sessions

Running Locked?

Yes — Displays that the <running> datastore is locked.

No — Displays that the <running> datastore is not locked.

Candidate Locked?

Yes — Displays that the <candidate> datastore is locked.

No — Displays that the <candidate> datastore is not locked.

counters

Syntax 
counters
Context 
show>system>netconf
Description 

This command displays NETCONF counters.

Output 

The following displays NETCONF counter information.

Table 66 describes the NETCONF counter output fields.

Sample Output
# show system netconf counters
==============================================================================
NETCONF counters:
==============================================================================
    Rx Messages
------------------------------------------------------------------------------
      in gets            : 23
      in get-configs     : 19
      in edit-configs    : 35
      in copy-configs    : 0
      in delete-configs  : 0
      in validates       : 0
      in close-sessions  : 0
      in kill-sessions   : 0
      in locks           : 0
      in unlocks         : 0
      in commits         : 2
      in discards        : 1
-------------------------------------------------------------------------------
      Rx Total           : 80
==============================================================================
    Tx Messages
------------------------------------------------------------------------------
      out rpc-errors     : 4
------------------------------------------------------------------------------
      Tx Total           : 9
==============================================================================
    Failed requests due to lock being taken by other sessions 
------------------------------------------------------------------------------
      failed edit-configs: 1
      failed locks       : 0
==============================================================================
Table 66:  NETCONF Counters Output Fields 

Label

Description  

RX Messages

Types and numbers of received messages

RX Total

Total of all received messages

TX Messages

Types and numbers of sent messages

TX Total

Total of all sent messages

failed edit-configs

Number of failed <edit-config> requests due to a lock (including implicit ones) being taken by other netconf sessions

failed locks

Number of failed <lock> requests due to a lock (including implicit ones) being taken by other netconf sessions

5.10.3. Debug Commands

Command outputs shown in this section are examples only; actual displays may differ depending on supported functionality and user configuration.

5.10.3.1. NETCONF Debug Commands

netconf

Syntax 
netconf
Context 
debug>system
Description 

This command enters the debug NETCONF context.

info

Syntax 
info
Context 
debug>system>netconf
Description 

This command displays debug information for NETCONF sessions.

Output 

The following displays debug information for NETCONF sessions.

Sample Output
17 2018/03/17 12:29:54.785 UTC minor: DEBUG #2001 Base NETCONF
“NETCONF: INFO user: ncuser session 36: 
session started”
 
“18 2018/03/17 12:29:54.785 UTC minor: DEBUG #2001 Base NETCONF
NETCONF: INFO user: ncuser session 36: 
received <hello>”
 
19 2018/03/17 12:29:54.785 UTC minor: DEBUG #2001 Base NETCONF
“NETCONF: INFO user: ncuser session 36: setting 1.1 capability, chunk framing mode enabled”
 
20 2018/03/17 12:29:54.785 UTC minor: DEBUG #2001 Base NETCONF
“NETCONF: INFO user: ncuser session 36: 
successfully processed <hello> message”
 
21 2018/03/17 12:29:54.844 UTC minor: DEBUG #2001 Base NETCONF
“NETCONF: INFO user: ncuser session 36: 
received <edit-config>”
 
22 2018/03/17 12:29:54.848 UTC minor: DEBUG #2001 Base NETCONF
“NETCONF: INFO user: ncuser session 36: 
error occurred while processing <edit-config> RPC”
 
23 2018/03/17 12:29:54.892 UTC minor: DEBUG #2001 Base NETCONF
“NETCONF: INFO user: ncuser session 36: 
successfully processed <edit-config> RPC”
 
24 2018/03/17 12:29:54.893 UTC minor: DEBUG #2001 Base NETCONF
“NETCONF: INFO user: ncuser session 36: 
session terminated”