Capabilities
This section defines a set of capabilities that AsterNOS has implemented.
AsterNOS NETCONF capability is identified with a URI. The base capabilities are defined using URNs following the method described in RFC 3553[RFC3553]. Capabilities defined in this document have the following format:
urn:ietf:params:netconf:capability:{name}:1.xwhere {name} is the name of the capability.
Capabilities Exchange
AsterNOS NETCONF Capabilities are advertised in messages sent by each peer during session establishment. When the NETCONF session is opened, AsterNOS Netconf Server will send a <hello> element containing a list of peer’s capabilities. For example:
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:rollback-on-error:1.0
urn:ietf:params:netconf:capability:validate:1.1
urn:ietf:params:netconf:capability:startup:1.0
urn:ietf:params:xml:ns:yang:ietf-yang-metadata?module=ietf-yang-metadata&revision=2016-08-05
urn:ietf:params:xml:ns:yang:1?module=yang&revision=2021-04-07
urn:ietf:params:xml:ns:yang:ietf-inet-types?module=ietf-inet-types&revision=2013-07-15
urn:ietf:params:xml:ns:yang:ietf-yang-types?module=ietf-yang-types&revision=2013-07-15
urn:ietf:params:netconf:capability:yang-library:1.1?revision=2019-01-04&content-id=27
urn:ietf:params:xml:ns:netconf:base:1.0?module=ietf-netconf&revision=2013-09-29&features=writable
running,candidate,confirmed-commit,rollback-on-error,validate,startup,url,xpath
urn:ietf:params:xml:ns:yang:ietf-netconf-acm?module=ietf-netconf-acm&revision=2018-02-14
urn:ietf:params:netconf:capability:with-defaults:1.0?basic-mode=explicit&also-supported=trim,report-all
urn:ietf:params:xml:ns:yang:ietf-netconf-notifications?module=ietf-netconf-notifications&revision=2012-02-06
urn:ietf:params:xml:ns:netmod:notification?module=nc-notifications&revision=2008-07-14
urn:ietf:params:xml:ns:netconf:notification:1.0?module=notifications&revision=2008-07-14If no protocol version capability in common is found, the Netconf Server will not continue the session.
Writable-Running Capability
Description
The: writable-running capability indicates that the AsterNOS device supports direct writes to the <running> configuration datastore.
In other words, the device supports <edit-config> and <copy-config> operations where the <running> configuration is the target.
Capability Identifier
The :writable-running capability is identified by the following capability string:
urn:ietf:params:netconf:capability:writable-running:1.0Rollback-on-Error Capability
Description
AsterNOS support an internal-integrated rollback-on-error mechanism, Where when any node in a user request fails, all modifications made to that request will be rolled back, meaning that any failed request will not have any actual impact on the device state.
Dependencies
None.
Capability Identifier
The :rollback-on-error capability is identified by the following capability string:
urn:ietf:params:netconf:capability:rollback-on-error:1.0NOTE: Users do not need to specify <error option> rollback on error</error option> in edit config, as the server will force the cancellation of all changes in this request.
Validate Capability
Description
Validation consists of checking a complete configuration for syntactical and semantic errors before applying the configuration to the device.
AsterNOS support an internal-integrated validate operation and checks syntax errors and business logic verification.
NOTE: AsterNOS DON'T supports the <validate> rpc and <test-option> parameter to the <edit-config> operation, as the server will perform validation automatically before applying the configuration to the device.
Capability Identifier
The :validate:1.1 capability is identified by the following capability string:
urn:ietf:params:netconf:capability:validate:1.1Distinct Startup Capability
Description
AsterNOS supports separate running and startup configuration datastores. The startup configuration is loaded by the device when it boots. Operations that affect the running configuration will not be automatically copied to the startup configuration.
IMPORTANT: An explicit <copy-config> operation from the <running> to the <startup> is used to update the startup configuration to the current contents of the running configuration.
Capability Identifier
The :startup capability is identified by the following capability string:
urn:ietf:params:netconf:capability:startup:1.0URL Capability
Description
AsterNOS support to use URL as source or target in <copy-config> operation with some limitations. Also, <edit-config> with a <uri> as config is supported.
Capability Identifier
The :url capability is identified by the following capability string:
NETCONF Monitoring Capability
Description
AsterNOS partly support RFC6022 netconf monitoring. Currently, only part of this module is supported:
Type | Description |
|---|---|
/netconf-state/capabilities | Support to get capabilities via <get>. |
/netconf-state/datastores | Support to get all supported datastores name via <get>. |
/netconf-state/schemas | Support to get all supported and valid schemas via <get>. return a list of schemas, contain: 'identifier', 'version', 'format', 'location' |
RPC <get-schema> | Support to get schema content via <get-schema> rpc, need to specify 'identifier', 'version', 'format'. |
Capability Identifier
The :ietf-netconf-monitoring capability is identified by the following capability string:
urn:ietf:params:xml:ns:yang:ietf-netconf-monitoringFor more details about NETCONF on AsterNOS, please refer to document NETCONF Examples and NETCONF YANG API Reference.