debugging netconf

Function

The debugging netconf command enables the debugging flag of NETCONF module.

The undo debugging netconf command disables the debugging flag of NETCONF module.

By default, The debugging flag of NETCONF module is disabled.

Format

debugging netconf { switch } [ session sessionId ]

undo debugging netconf switch

Parameters

Parameter	Description	Value
switch	Specifies the type of debug functions.	The value is: tree message rpc cfg-message state-transition error authorization sync-config all
session sessionId	Displays debugging information about NETCONF session.	It is an integer ranging from 1 to 65535.

Parameter

Description

Value

switch

Specifies the type of debug functions.

The value is:

tree
message
rpc
cfg-message
state-transition
error
authorization
sync-config
all

session sessionId

Displays debugging information about NETCONF session.

It is an integer ranging from 1 to 65535.

Views

User view

Default Level

3: Management level

Task Name and Operations

Task Name	Operations
netconf	debug

Usage Guidelines

When a NETCONF module becomes faulty, the network administrator cannot perform local management using NETCONF to start, modify or delete configurations on the remote device. You can run this command to start the debugging information on the NETCONF module and rapidly locate faults based on the obtained information.

Example

# Enable NETCONF module message exchange information.

<HUAWEI> debugging netconf message
Sent Control Message of Type %lu with Trans No = %lu and Length = %lu to Interface %lu + Sub Interface %lu
Aug  9 2011 03:47:26 HUAWEI %%01NETCONF/7/NCA_CTRL_MSG_SND(d):CID=0x972724;Sent Control Message of Type 8 with Trans No = 1 and Length = 180 to Interface 1 + Sub Interface 6

Sent Data Message of Type %lu with Packet Id = %lu and Ack Id = %lu and Length = %lu to Interface %lu + Sub Interface %lu
Aug  9 2011 03:47:26 HUAWEI %%01NETCONF/7/NCA_DATA_MSG_SND(d):CID=0x972724;Sent Data Message of Type 2 with Packet Id = 0 and Acknowledgement Id = 0 and Length = 1074 to Interface 1 + Sub Interface 7

Sent Message of Length %lu to PID %lu
Aug  8 2011 08:41:59 HUAWEI %%01NETCONF/7/NCA_NON_REL_MSG_SND(d):CID=0x972724;Sent Message of Length 20 to PID 9643811

# Enable NETCONF-CFG message interaction information.

<HUAWEI> debugging netconf cfg-message
CFG Infocode Block: Return Code = [0x%x], Atom Seq Num = [0x%x], Info Code Num = [0x%x]
Aug  9 2011 03:54:31 HUAWEI %%01NETCONF/7/INFOCODE_BLOCK_INFO(d):CID=0x972724;CFG Infocode Block: Return Code = [0x0], Atom Seq Num = [0x0], Info Code Num = [0x0]

CFG Infocode Item: Info code = [%u], Item Size = [%u], Info Type = [%u], Field Num = [%u]
Aug  9 2011 05:30:02 HUAWEI %%01NETCONF/7/INFOCODE_ITEM(d):CID=0x972724;CFG Infocode Item: Info code = [17], Item Size = [18], Info Type = [6], Field Num = [1]

CFG Infocode Item Field: Field Type = [%u], Field Length = [%u], Field Data = [%s]
Aug  9 2011 05:30:02 HUAWEI %%01NETCONF/7/INFOCODE_ITEM_FIELD(d):CID=0x972724;CFG Infocode Item Field: Field Type = [25], Field Length = [14], Field Data = [NtpAuthKeyCfg]

CFG Block Header: Block Index = [%u], Operation Type = [%s], Operation Length = [%u]
Aug  9 2011 03:54:31 HUAWEI %%01NETCONF/7/CFG_BLOCK_HEADER(d):CID=0x972724;CFG Block Header: Block Index = [1], Operation Type = [Unknown], Operation Length = [16]

CFG Object Block: Class Id. = [0x%x], Object Sequence Num = [%u], Field Num = [%u]
Aug  9 2011 03:54:31 HUAWEI %%01NETCONF/7/EDIT_CFG_OBJ_BLOCK(d):CID=0x972724;CFG Object Block: Class Id. = [0x8770195], Object Sequence Num = [1], Field Num = [2]

CFG Conditional Field Info: Field Id = [%u], Field Relation = [%u], Field Condition = [%u], Field Type = [%u], Field Length = [%u]
Aug  9 2011 03:54:31 HUAWEI %%01NETCONF/7/CONDITION_FIELD_INFO(d):CID=0x972724;CFG Conditional Field Info: Field Id = [6], Field Relation = [2], Field Condition = [0], Field Type = [25], Field Length = [8]

CFG Target Info: Source Target Id = [%u], Destination Target Id = [%u], Query Type = [%s]
Aug  9 2011 05:37:24 HUAWEI %%01NETCONF/7/QUERY_TARGET_INFO(d):CID=0x972724;CFG Target Info: Source Target Id = [14], Destination Target Id = [0], Query Type = [CFG_QUERY_TYPE_CFGID_DIFF]

CFG sync-increment OR preview start OR end response: DB Id = [%u]
Aug  9 2011 05:37:24 HUAWEI %%01NETCONF/7/SYNC_INC_PREVIEW_START_END_RSP(d):CID=0x972724;CFG sync-increment OR preview start OR end response: DB Id = 0

CFG Query Field Info: Query Field Id = [%u]
Aug  9 2011 03:54:48 HUAWEI %%01NETCONF/7/QUERY_REQ_FIELD_INFO(d):CID=0x972724;CFG Query Field Info: Query Field Id = 2

CFG Query Response Block: Class Id = [0x%x], Display Template Id = [%u], Query Type = [%u], Diff Code = [%u], Response Field Num = [%u], Record Num = [%u], Record Length = [%u]
Aug  9 2011 03:54:48 HUAWEI %%01NETCONF/7/QUERY_RSP_BLOCK_INFO(d):CID=0x972724;CFG Query Response Block: Class Id = [0x8770195], Display Template Id = [142049280], Query Type = [5], Diff Code = [0], Response Field Num = [11], Record Num = [1], Record Length = [141]

CFG Query Response Field Info: Field Id = [%u], Field Type = [%u], Field Length = [%u]
Aug  9 2011 03:54:48 HUAWEI %%01NETCONF/7/QUERY_RSP_FIELD_INFO(d):CID=0x972724;CFG Query Response Field Info: Field Id = [1], Field Type = [32], Field Length = [4]

CFG Commit Request: Commit Type. = [%s], Time-out Value = [%u], Commit Mode = [%s]
Aug  9 2011 05:37:43 HUAWEI %%01NETCONF/7/COMIT_REQ_INFO(d):CID=0x972724;CFG Commit Request: Commit Type. = [CFG_COMMIT_TIME_IMMEDIATE], Time-out Value = [0], Commit Mode = [CFG_COMMIT_MODE_ALLORNONE]

Aug  9 2011 03:54:48 HUAWEI %%01NETCONF/7/CFG_MSG_HEADER(d):CID=0x972724;CFG Header: Transaction Num = [13], Session Id = [66], Sender Id = [0x972727], Block Num = [1], Message Type = [MSG_CFGI_QUERY_DATA], Trans Flag = [CFG_MSGTRANS_TYPE_MID_REQ], HA Flag = [CFG_HA_FLAG_ACTIVE], Fragment Flag 
= [CFG_FRAG_FLAG_FALSE], Edit Mode Flag = [Unknown], Sub Sequence Num = [0], Flow Id = [0], Command Flag = [0x0], Data Size = [4]

CFG Query Block: Class Id = [0x%x], Condition Field Num = [%u], Query Field Num = [%u]
Aug  9 2011 03:54:31 HUAWEI %%01NETCONF/7/QUERY_REQ_BLOCK_INFO(d):CID=0x972724;CFG Query Block: Class Id = [0x8770195], Condition Field Num = [2], Query Field Num = [1]

# Enable RPC request and response.

<HUAWEI> debugging netconf rpc
Aug  9 2011 03:52:26 HUAWEI %%01NETCONF/7/NCA_DEBUG_LOG_GENERIC(d):CID=0x972724;<rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
    <get-config>
      <source>
        <url>dummy.db/<url>
      </source>
      <filter type="subtree"/>
    </get-config>
  </rpc>

# Enable NETCONF tree traversal information.

<HUAWEI> debugging netconf tree
Node Type = %s, Node Name = %s
Aug  9 2011 03:54:31 HUAWEI %%01NETCONF/7/NCA_TRAVERSE_NODE_INFO(d):CID=0x972724;Node Type = Service Node, Node Name = radius

Traversal Type = %s
Aug  9 2011 03:54:31 HUAWEI %%01NETCONF/7/NCA_TRAVERSE_TYPE(d):CID=0x972724;Traversal Type = EN_NCA_TRAVERSE_CHILD

# Enable NETCONF state transition information.

<HUAWEI> debugging netconf state-transition
Session state changed.(session-id=%hu, current-state=%s, next-state=%s.)
Aug  9 2011 03:54:31 HUAWEI %%01NETCONF/7/NCA_SESS_STATE_TRANSITION(d):CID=0x972724;Session state changed.(session-id=66, current-state=READY, next-state=WAIT_OP_RESP.)

Transaction state changed.(session-id=%hu, current-state=%s, next-state=%s.)
Aug  9 2011 03:54:31 HUAWEI %%01NETCONF/7/NCA_TRANS_STATE_TRANSITION(d):CID=0x972724;Transaction state changed.(session-id=66, current-state=NEUTRAL, next-state=WAIT_CREATE_TRANS_RSP.)

Session query state changed.(session-id=%hu, current-state=%s, next-state=%s.)
Aug  9 2011 03:54:31 HUAWEI %%01NETCONF/7/NCA_SESS_QUERY_STATE_TRANSIT(d):CID=0x972724;Session query state changed.(session-id=66, current-state=QUERY, next-state=QUERY_AUTO_KEY.)

Pipeline query state changed.(session-id=%hu, current-state=%s, next-state=%s.)
Aug  9 2011 03:47:29 HUAWEI %%01NETCONF/7/NCA_OP_QUERY_STATE_TRANSIT(d):CID=0x972724;Pipeline query state changed.(session-id=66, current-state=QUERY, next-state=SYNC_START.)

# Enable NETCONF internal error information.

<HUAWEI> debugging netconf error
Error Location: File: %s, Line: %u, Error Code: 0x%x.
Aug  9 2011 03:54:48 HUAWEI %%01NETCONF/7/NCA_INTERNAL_ERROR(d):CID=0x972724;Error Location: File: nca_bsc_op_data.c, Line: 3524, Error Code: 0x800a62.

# Enable debugging for NETCONF authorization.

<HUAWEI> debugging netconf authorization
Feb 16 2013 06:47:53.603 HUAWEI %%01NETCONF/7/NCA_AUTH_RULE_FOUND(d):CID=0x970404;Authorization rule exists, operation get is 2 (1-permit/2-deny)for user-group 5

Feb 16 2013 06:50:05.967 HUAWEI %%01NETCONF/7/NCA_AUTH_RULE_FOUND(d):CID=0x970404;Authorization rule exists, module name ntp is 1 (1-permit/2-deny)for user-group 1

**Table 1** Description of the **debugging netconf** command output
Item	Description
CFG Infocode Block	Indicates the configuration infocode block that includes return code, atom sequence number and info code number information.
CFG Infocode Item	Indicates the configuration infocode item that includes info code, item size, info type and field number information.
CFG Infocode Item Field	Indicates the configuration infocode item field that includes field type, length and data information.
CFG Block Header	Indicates the configuration block header that includes block index, operation type and length information.
CFG Object Block	Indicates the configuration object block that includes class ID, object sequence number and field number information.
CFG Conditional Field Info	Indicates the configuration conditional field information that includes field ID, relation, condition, type and length information.
CFG Target Info	Indicates the configuration target information that includes source target, destination target and query type information.
CFG sync-increment OR preview start OR end response	Indicates the configuration sync-increment, preview start or end response information.
CFG Query Field Info	Indicates the configuration query field ID information.
CFG Query Response Block	Indicates the configuration query response block that includes class ID, display template ID, query type, diff code, response field number, record number and record length information.
CFG Query Response Field Info	Indicates the configuration query response field information that includes field ID, type and length information.
CFG Commit Request	Indicates the configuration commit request that includes commit type, time-out value and commit mode information.
CFG Query Block	Indicates the configuration query that includes class ID, condition field number and query field number information.
Node Type	Indicates the type of node.
Node Name	Indicates the name of node.
Error Location	Indicates the error location that includes file, line and error code information.