4.8. NETCONF Command Reference

4.8.1. Command Hierarchies

  1. Configuration Commands
    1. Netconf System Commands
    2. Netconf Security Commands
  2. Show Commands

4.8.1.1. Configuration Commands

4.8.1.1.1. Netconf System Commands

config
— system
— netconf
— [no] shutdown

4.8.1.1.2. Netconf Security Commands

config
— system
— security
— profile profile-id
— netconf
— base-op-authorization
— [no] kill-session

4.8.1.2. Show Commands

show
— system
— netconf
— counters

4.8.1.3. Configuration Commands

  1. NETCONF System Commands
  2. NETCONF Security Commands
Note:

NETCONF is only supported on 7210 SAS-K 2F1C2T and 7210 SAS-K 2F6C4T.

4.8.1.3.1. NETCONF System Commands

shutdown

Syntax 
[no] shutdown
Context 
config>system>netconf
Supported Platforms 

7210 SAS-K 2F1C2T and 7210 SAS-K 2F6C4T

Description 

This command disables the NETCONF server. The shutdown command is blocked if there are any active NETCONF sessions. The user should use the admin disconnect command to disconnect all NETCONF sessions before shutting down the NETCONF service.

4.8.1.3.2. NETCONF Security Commands

netconf

Syntax 
netconf
Context 
config>system>security>profile
Supported Platforms 

7210 SAS-K 2F1C2T and 7210 SAS-K 2F6C4T

Description 

This command authorizes NETCONF capability for the user.

base-op-authorization

Syntax 
base-op-authorization
Context 
config>system>security>profile>netconf
Supported Platforms 

7210 SAS-K 2F1C2T and 7210 SAS-K 2F6C4T

Description 

This command enables the context where permission to use various NETCONF operations is controlled.

kill-session

Syntax 
[no] kill-session
Context 
config>system>security>profile>netconf>base-op-authorization
Supported Platforms 

7210 SAS-K 2F1C2T and 7210 SAS-K 2F6C4T

Description 

This command authorizes a user associated with the profile to send a kill session NETCONF operation. This kill session operation allows a NETCONF client to kill another NETCONF session, but not the session in which the operation is requested.

Default 

no kill-session

4.8.1.4. Show Commands

netconf

Syntax 
netconf
Context 
show>system
Supported Platforms 

7210 SAS-K 2F1C2T and 7210 SAS-K 2F6C4T

Description 

This command displays NETCONF SSH sessions.

Output 

The following output is an example of NETCONF SSH session information, and Table 37 describes the output fields.

Sample Output
7210SAS>show>system# netconf
 
===============================================================================
NETCONF Server
===============================================================================
Administrative State      : Disabled
Operational State         : Down
===============================================================================
7210SAS>show>system#
Table 37:  Output Fields: System NETCONF 

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 or routers (remote client)

counters

Syntax 
counters
Context 
show>system>netconf
Supported Platforms 

7210 SAS-K 2F1C2T and 7210 SAS-K 2F6C4T

Description 

This command displays NETCONF counters.

Output 

The following output is an example of NETCONF counter information, and Table 38 describes the output fields.

Sample Output
7210SAS>show>system# netconf counters
==============================================================================
NETCONF counters:
==============================================================================
    Rx Messages
------------------------------------------------------------------------------
      in gets            : 0
      in get-configs     : 0
      in edit-configs    : 0
      in copy-configs    : 0
      in delete-configs  : 0
      in validates       : 0
      in close-sessions  : 0
      in kill-sessions   : 0
------------------------------------------------------------------------------
      Rx Total           : 0
==============================================================================
    Tx Messages
------------------------------------------------------------------------------
      out rpc-errors     : 0
------------------------------------------------------------------------------
      Tx Total           : 0
==============================================================================
 
Table 38:  Output Fields: NETCONF Counters  

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