display netconf capability

Function

The display netconf capability command displays the capabilities that the NETCONF supports.

Format

display netconf capability

Parameters

None

Views

All views

Default Level

3: Management level

Task Name and Operations

Task Name Operations
netconf debug

Usage Guidelines

NETCONF defines base and standard capabilities. Huawei defines private capabilities. Operations are defined in various capabilities.

To view operations supported by capabilities, run the display netconf capability command. This command improves maintainability.

Hello messages exchanged between the server and client describe the public and private capabilities supported by a NETCONF session.

Example

The actual command output varies according to the device. The command output here is only an example.

# Display server capabilities supported.
<HUAWEI> display netconf capability
--------------------------------------------------
Capability                                        
--------------------------------------------------
urn:ietf:params:netconf:base:1.0                  
urn:ietf:params:netconf:base:1.1                  
urn:ietf:params:netconf:capability:writable-running:1.0
urn:ietf:params:netconf:capability:candidate:1.0  
urn:ietf:params:netconf:capability:confirmed-commit:1.0
urn:ietf:params:netconf:capability:confirmed-commit:1.1
urn:ietf:params:netconf:capability:rollback-on-error:1.0
urn:ietf:params:netconf:capability:validate:1.0   
urn:ietf:params:netconf:capability:validate:1.1   
urn:ietf:params:netconf:capability:startup:1.0    
urn:ietf:params:netconf:capability:url:1.0?scheme=file,ftp,sftp
urn:ietf:params:netconf:capability:xpath:1.0      
urn:ietf:params:netconf:capability:notification:1.0
urn:ietf:params:netconf:capability:interleave:1.0 
urn:ietf:params:netconf:capability:with-defaults:1.0?basic-mode=report-all&also-supported=report-all-tagged,trim
urn:ietf:params:netconf:capability:yang-library:1.0?revision=2016-06-21&module-set-id=1903662584
--------------------------------------------------
Table 1 Description of the display netconf capability command output
Item Description
Capability

urn:ietf:params:netconf:base:X" uniquely identifies a base capability defined by NETCONF. "X" indicates the capability version supported.

  • Base: NETCONF basic capabilities are used to run a basic set of operations:
    • get-config: obtains a specified portion of or all configuration data running, candidate, and startup configuration databases.
    • get: obtains some or all running configuration data and status data from running, candidate, or startup configuration database.
    • edit-config: creates, modifies, or deletes configuration data.
    • lock: locks a configuration database. A locked configuration database cannot be modified by other users. Locking a configuration database ensures that the configuration of a database is not affected by the configuration of the client, Simple Network Management Protocol (SNMP), or command-line interface (CLI) script, preventing a conflict.
    • unlock: unlocks a locked configuration database. Users can unlock only the configuration databases they have locked.
    • copy-config: replaces the target configuration database with the source configuration database. If no target configuration database has been created, this operation creates a configuration database. If a target configuration database has been created, the source configuration database replaces the target configuration database.
    • delete-config: deletes a configuration database. The running configuration database cannot be deleted.
    • close-session: closes the current NETCONF session.
    • kill-session: forcibly closes another NETCONF session. Only an administrator is authorized to perform this operation.

"urn:ietf:params:netconf:capability:X" uniquely identifies a standard capability defined by NETCONF. "X" indicates the capability version supported.

  • Writable-Running: enables a device to access the running configuration database. The device supports edit-config and copy-config operations to run configuration data.
  • Candidate: supports the candidate configuration database. This capability enables a device to perform operations on configuration data without affecting configuration data that is being used.
  • Confirmed Commit: updates the data to the running database if the configuration is committed before the confirm-timeout period elapses.
  • Distinct Startup: enables a device to perform a distinct startup. The server checks parameter availability and consistency.
  • Rollback on Error: enables a device to perform rollback when an error occurs. If an error occurs and the rpc-error element is generated, the server stops performing the edit-config operation and restores the specified configuration used before the edit-config operation is performed.
  • Sync: This capability enables a device to perform data synchronization. The client sends a request to the server to update the local data set of the client. A file transfer protocol is used to synchronize server data to a destination folder.
  • Exchange: enables a device to exchange information. If a NETCONF session has the exchange capability, it supports the get-next operation.
  • Active: enables a client to receive active messages during operations, which takes a long time to produce responses if the NETCONF session has active capability.

    NETCONF supports the active capability to exchange Hello message between the client and server.

  • Action: enables a server to support the action capability to provide a new operation, which is used by a client to send any executable request to CFG in XML encoded format. CFG performs the requested operation and sends the response to the client in XML encoded format.
  • Discard Commit: cancels or ends a confirmed-commit operation.
  • Execute CLI: enables a device to interact with the request sender in request processing. Only a device with exchange capability supports the execute CLI operation. Execute a CLI operation is used to execute CLI commands using NETCONF. A maximum of 60 commands are allowed in a single remote procedure call (RPC) request.
  • Update: enables a device to update configuration data. Updates configuration data in the candidate configuration database to the running configuration database when a conflict occurs during data commitment.
  • Commit-Description: When the data in the candidate configuration database are updated to the running configuration database, the carried information in the data can be configured.
  • Notification: allows traps or events to be sent in notification messages to an NMS.
  • Interleave: allows multiple functions to be performed for a NETCONF session on a device. A user can maintain a device and manage traps and events using the same NETCONF session.
  • url: allows the device to import a configuration set from a URL to the device or export a configuration set from the device to a URL.
  • xpath: allows the device to use XPath expressions to filter out specified data in get and get-config operations.
  • validate: supports the validate operation and syntax verification.
  • with-defaults: allows the get/get-config/copy-config operation to carry the with-defaults node, which includes:
    • report-all: queries nodes with default values as well as nodes without default values.
    • report-all-tagged: queries nodes with default values as well as nodes without default values, and tag the nodes with default values.
    • trim: queries nodes without default values.
Copyright © Huawei Technologies Co., Ltd.
Copyright © Huawei Technologies Co., Ltd.
< Previous topic Next topic >