4.8. NETCONF Command Reference

4.8.1. Command Hierarchies

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.1.3. Show commands

show
— system
— netconf
— counters

4.8.2. Command Descriptions

4.8.2.1. Configuration Commands

This section provides NETCONF configuration command descriptions.

4.8.2.2. NETCONF System Commands

shutdown

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

7210 SAS-R6 and 7210 SAS-R12

Description 

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

4.8.2.3. NETCONF Security Commands

netconf

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

7210 SAS-R6 and 7210 SAS-R12

Description 

This command enables the context to authorize various NETCONF capabilities for the user.

base-op-authorization

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

7210 SAS-R6 and 7210 SAS-R12

Description 

This command enables the context to configure 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-R6 and 7210 SAS-R12

Description 

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

The no form of this command disables the configuration.

Default 

no kill-session

4.8.2.4. Show Command

netconf

Syntax 
netconf
Context 
show>system
Supported Platforms 

7210 SAS-R6 and 7210 SAS-R12

Description 

This command displays active NETCONF SSH sessions.

Output 

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

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

Label

Description

Administrative State

Enabled — Indicates that NETCONF is enabled

Disabled — Indicates that NETCONF is disabled

Operational State

Up — Indicates that NETCONF is operational

Down — Indicates that NETCONF is not operational

Connection

Displays the IP address of the connected routers (remote client)

counters

Syntax 
counters
Context 
show>system>netconf
Supported Platforms 

7210 SAS-R6 and 7210 SAS-R12

Description 

This command displays NETCONF counters.

Output 

The following output is an example of NETCONF counter information, and Table 40 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
==============================================================================
 
7210SAS>show>system#
Table 40:  Output Fields: NETCONF Counters 

Label

Description

RX Messages

Displays the types and numbers of received messages

RX Total

Displays the total of all received messages

TX Messages

Displays the types and numbers of sent messages

TX Total

Displays the total of all sent messages

failed edit-configs

Displays the number of failed <edit-config> requests due to a lock (including implicit ones) being taken by other NETCONF sessions

failed locks

Displays the number of failed <lock> requests due to a lock (including implicit ones) being taken by other NETCONF sessions