5.8. NETCONF Configuration Command Reference

This section provides the NETCONF configuration command reference. Topics in this section include:

5.8.1. Command Hierarchies

5.8.1.1. NETCONF System Commands

config
— system
— netconf
— capabilities
[no] candidate
port port
— no port
[no] shutdown

5.8.1.2. NETCONF Security Commands

config
— system
— security
— profile profile-id
[no] kill-session
[no] lock

5.8.2. Configuration Commands

5.8.2.1. NETCONF System Commands

auto-config-save

Syntax 
[no] auto-config-save
Context 
config>system>netconf
Description 

This command controls whether committed changes are automatically persistent (that is, copied to the <startup> datastore) or not, when a commit is successful.

Default 

no auto-config-save

candidate

Syntax 
[no] candidate
Context 
config>system>netconf>capabilities
Description 

This command enables support of the candidate datastore in the SR OS NETCONF server. If the candidate is disabled then requests that reference the candidate datastore return an error, and when a NETCONF client establishes a new session the candidate capability is not advertised in the SR OS <hello>. This command also controls support of the <commit> and <discard-changes> operations.

When management-interface configuration-mode is set to classic, then the candidate capability is disabled, even if candidate is configured.

The no form of the command disables support of the candidate datastore in the SR OS NETCONF server.

Default 

candidate

writable-running

Syntax 
[no] writable-running
Context 
config>system>netconf>capabilities
Description 

This command enables support of the writable-running capability in the SR OS NETCONF server. If writable-running is disabled then requests that reference the running datastore as a target return an error, and when a NETCONF client establishes a new session the writable-running capability is not advertised in the SR OS <hello>.

When management-interface configuration-mode is set to model-driven, then the writable-running capability is disabled, even if writable-running is configured.

The no form of the command disables of the writable-running capability in the SR OS NETCONF server.

Default 

no writable-running

port

Syntax 
port port
no port
Context 
config>system>netconf
Description 

This command specifies the port on which the SR OS NETCONF server listens for new connections. Only one port can be configured for NETCONF management.

The configured port applies to both non-VPRN and VPRN management. New NETCONF connections are able to use the configured port. The SR OS NETCONF server errors if a port, different from the configured port, is used to SSH to the SR OS NETCONF server. For NETCONF connections not using VPRN management, active NETCONF connections are not disconnected if the port used to establish the connections is changed. For NETCONF connections using VPRN management, active NETCONF connections are disconnected if the port used to establish the connections is changed.

The no form of this command resets the port on which the SR OS NETCONF server listens to the default port of 830.

Parameters 
port—
Specifies the port on which NETCONF listens for new connections.
Values—
22, 830

 

Default—
830

shutdown

Syntax 
[no] shutdown
Context 
config>system>netconf
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.

5.8.2.2. NETCONF Security Commands

netconf

Syntax 
netconf
Context 
config>system>security>profile
Description 

This command authorizes various netconf capabilities for the user.

base-op-authorization

Syntax 
base-op-authorization
Context 
config>system>security>profile>netconf
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
Description 

This operation 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.

The no form of the command disables the configuration.

Default 

no kill-session

lock

Syntax 
[no] lock
Context 
config>system>security>profile>netconf>base-op-authorization
Description 

This operation authorizes a user associated with the profile to send a lock NETCONF operation. This lock operation allows a NETCONF client to lock the running datastore or the candidate datastore.

The no form of the command disables the configuration.

Default 

no lock