Skip to content

Releases: clicon/clixon

Clixon 7.0.1

03 Apr 09:40
@olofhagsand olofhagsand
7.0.1
500010f
Compare
Choose a tag to compare
Clixon 7.0.1 Latest
Latest

7.0.1

3 April 2024

Three issues detected in post-testing of 7.0.0 are fixed in the 7.0.1 release

Corrected Bugs

Assets 2

Clixon 7.0.0

08 Mar 08:51
@olofhagsand olofhagsand
7.0.0
28050f4
Compare
Choose a tag to compare
Clixon 7.0.0

7.0.0

8 March 2024

Clixon 7.0.0 is a major release with changes to the debug/log/error API, other APIs,
standardized internal framing protocol and many other changes.
It also supports the 1.0 clixon controller release.

Features

  • Changed framing between backend and frontend to RFC6242 "chunked-encoding"
    • Previous a propriatary framing method was used
  • Added micro-second resolution to logs via stderr/stdout
  • New command-line debug mechanism
  • Made coverity analysis and fixed most of them
    • Some were ignored being for generated code (eg lex) or not applicable
  • Feature: Add support for -V option to give version
    • All clixon applications added command-line option -V for printing version
    • New ca_version callback for customized version output
  • Optimization:
    • Removed reply sanity if CLICON_VALIDATE_STATE_XML not set
    • Improved performance of GET and PUT operations
    • Optimized datastore access by ensuring REPORT_ALL in memory and EXPLICIT in file
    • Added mountpoint cache as yang flag YANG_FLAG_MTPOINT_POTENTIAL
    • Optimized yang_find, especially namespace lookup
    • Filtered state data if not match xpath
  • Added reference count for shared yang-specs (schema mounts)
    • Allowed for sharing yspec+modules between several mountpoints
  • Added "%k" as extra flag character to api-path-fmt

API changes on existing protocol/config features

Users may have to change how they access the system

  • Changed framing between backend and frontend to RFC6242 "chunked-encoding"
    • Should only affect advanced usage between clixon frontend and backend
    • This should allow standard netconf utilities to be used as frontend (may be some caveats)
  • Revert the creators attribute feature introduced in 6.2. It is now obsoleted.
    It is replaced with a configured creators and user/application semantics
  • New clixon-lib@2024-01-01.yang revision
    • Replaced container creators to grouping/uses
  • New clixon-config@2024-01-01.yang revision
    • Changed semantics:
      • CLICON_VALIDATE_STATE_XML - disable return sanity checks if false
    • Marked as obsolete:
      • CLICON_DATASTORE_CACHE Replaced with enhanced datastore read API
      • CLICON_NETCONF_CREATOR_ATTR reverting 6.5 functionality

C/CLI-API changes on existing features

Developers may need to change their code

  • Rename function xml_yang_minmax_recurse() -> xml_yang_validate_minmax()
  • Modified msg functions for clearer NETCONF 1.0 vs 1.1 API:
    • clicon_rpc1 --> clixon_rpc10
    • clicon_msg_send1 --> clixon_msg_send10
    • clicon_msg_rcv and clicon_msg_decode --> clixon_msg_rcv11
      • Rewrite by calling clixon_msg_rcv11 and explicit xml parsing
    • clicon_msg_rcv1 --> clixon_msg_rcv10
  • Added yspec parameter to api_path_fmt2api_path():
    • api_path_fmt2api_path(af, c, a, c) --> api_path_fmt2api_path(af, c, yspec, a, c)
  • Added flags parameter to default functions:
    • xml_default_recurse(...) -> xml_default_recurse(..., 0)
    • xml_defaults_nopresence(...) -> xml_default_nopresence(..., 0)
      • Also renamed (defaults -> default)
  • Changed function name: choice_case_get() -> yang_choice_case_get()
  • New clixon-lib@2024-01-01.yang revision
    • Removed container creators, reverted from 6.5
  • Changed ca_errmsg callback to a more generic variant
  • Refactoring basic clixon modules and some API changes
    • Changes marked in code with COMPAT_6_5
      • Most common functions have backward compatible macros through the 6.6 release
    • Handle API
      • Renamed clicon_handle -> clixon_handle
      • clicon_handle_init() -> `clixon_handle_init()
      • clicon_handle_exit() -> `clixon_handle_exit()
    • Log/Debug API
      • Changed function names. You need to rename as follows:
        • clicon_log_init() -> clixon_log_init(h,) NOTE added "clixon_handle h"
        • clicon_log() -> clixon_log(h,) NOTE added "clixon_handle h"
        • clixon_debug_init(d, f) -> clixon_debug_init(h, ) NOTE h added, f removed
        • clicon_log_xml() -> clixon_debug_xml(h,) NOTE added "clixon_handle h"
        • clixon_debug_xml() -> clixon_debug_xml(h,) NOTE added "clixon_handle h"
    • Error API:
      • Added clixon_err_init(h) function
      • Renaming, make the following changes:
        • clicon_err() -> clixon_err()
        • clicon_err_reset() -> clixon_err_reset()
        • clicon_strerror(int) -> clixon_err_str()
        • clicon_netconf_error(h, x, fmt) -> clixon_err_netconf(h, OE_XML, 0, x, fmt)`
        • netconf_err2cb(...) --> netconf_err2cb(h, ...)
        • Likewise for some other minor functions: clicon_err_* -> clixon_err_*
      • Replaced global variables with access functions. Replace variables with functions as follows:
        • clicon_errno -> clixon_err_category()
        • clicon_suberrno -> clixon_err_subnr()
        • clicon_err_reason -> clixon_err_reason()
    • Changed process API:
      • clixon_proc_socket(...) --> clixon_proc_socket(h, ..., sockerr)

Corrected Bugs

Assets 2

Clixon 6.5.0

05 Dec 15:33
@olofhagsand olofhagsand
6.5.0
d85f7c0
Compare
Choose a tag to compare
Clixon 6.5.0

6.5.0

6 December 2023

Clixon 6.5 includes bugfixes, removed utility functions to a separate repo and some API changes.

API changes on existing protocol/config features

Users may have to change how they access the system

  • All clixon test utilities in util/ have been moved to a separate repo: clicon/clixon-util
    • To run tests you need to clone, build and install them separately
  • Moved and split install of main example config file
    • From /usr/local/etc/example.xml to /usr/local/etc/clixon/example.xml
    • Added /usr/local/etc/clixon/example/autocli.xml and /usr/local/etc/clixon/example/restconf.xml

C/CLI-API changes on existing features

Developers may need to change their code

  • Changed return value of xml_add_attr from 0/-1 to xa/NULL
    • You need to change eg if (xml_add_attr < 0) to if (xml_add_attr == NULL)`
  • Changed signature of clicon_netconf_error() and netconf_err2cb()
    • You need to add the clixon handle as first parameter:
      • clicon_netconf_error(...) --> clixon_netconf_error(h, ...)
      • netconf_err2cb(...) --> netconf_err2cb(h, ...)
  • Changed function name for clicon_debug functions. You need to rename as follows:
    • clicon_debug() -> clixon_debug()
    • clicon_debug_init() -> clixon_debug_init()
    • clicon_debug_get() -> clixon_debug_get()
    • clicon_debug_xml() -> clixon_debug_xml()
    • There are backward compatible macros during a transition period

Minor features

Corrected Bugs

Assets 2

Clixon 6.4.0

30 Sep 08:17
@olofhagsand olofhagsand
6.4.0
76a071b
Compare
Choose a tag to compare
Clixon 6.4.0

6.4.0

30 September 2023

This release is mainly for bugfixes and improvements of existing functionality, such as CLI output pipes.

Minor features

  • New clixon-autocli@2023-09-01.yang revision
    • Added argument to alias extension
  • CLI show compare example function:
    • Improved diff algorithm for XML and TEXT/curly, replaced UNIX diff with structural in-mem algorithm
  • JSON: Added unicode BMP support for unicode strings as part of fixing (#453)
  • Example cli pipe grep command quotes vertical bar for OR function
  • Added: Feature request: node's alias for CLI
    • Note: "Skip" is for all nodes, but "Alias" is only for leafs
  • New command-line option for dumping configuration options for all clixon applications after load
    • Syntax is -C <format>
    • Example: clixon_backend -1C json
  • Removed sending restconf config inline using -R when CLICON_BACKEND_RESTCONF_PROCESS=true
    • Define RESTCONF_INLINE to revert
  • Clarified clixon_cli command-line: clixon_cli [options] [commands] [-- extra-options]

C/CLI-API changes on existing features

Developers may need to change their code

  • Renamed clixon_txt2file() to clixon_text2file()

  • Changed parameters of example clispec function compare_dbs()

    • New parameters are: db1, db2, format

  • Add fromroot parameter to cli_show_common()

    • cli_show_common(...xpath...) --> cli_show_common(...xpath,0...)

  • Low-level message functions added descr argument for better logging

    • In this way, message debugs in level 2 are more descriptive
    • The descr argument can be set to NULL for backward-compability, see the following translations:
      • clicon_rpc(s, ...) --> clicon_rpc(s, NULL, ...)
      • clicon_rpc1(s, ...) --> clicon_rpc1(s, NULL, ...)
      • clicon_msg_send(s, ...) --> clicon_msg_send(s, NULL, ...)
      • clicon_msg_send1(s, ...) --> clicon_msg_send1(s, NULL, ...)
      • clicon_msg_rcv(s, ...) --> clicon_msg_rcv(s, NULL, ...)
      • clicon_msg_rcv1(s, ...) --> `clicon_msg_rcv1(s, NULL, ...)
      • clicon_msg_notify_xml(h, s, ...) --> clicon_msg_notify_xml(h, s, NULL, ...)
      • send_msg_reply(s, ...) --> send_msg_reply(s, NULL, ...)
      • clixon_client_lock(s, ...) --> clixon_client_lock(s, NULL, ...)
      • clixon_client_hello(s, ...) --> clixon_client_hello(s, NULL, ...)

  • CLI pipe function: added arg to pipe_tail_fn()

Corrected Bugs

Assets 2

Clixon 6.3.0

29 Jul 12:56
@olofhagsand olofhagsand
6.3.0
dcdb993
Compare
Choose a tag to compare
Clixon 6.3.0

6.3.0

29 July 2023

Clixon 6.3 introduces CLI output pipes and multiple updates and optimizations, primarily to the CLI.

New features

API changes on existing protocol/config features

Users may have to change how they access the system

  • New clixon-config@2023-05-01.yang revision
    • Added options: CLICON_CONFIG_EXTEND
    • Moved datastore-format datastype to clixon-lib
  • New clixon-lib@2023-05-01.yang revision
    • Restructured and extended stats rpc to schema mountpoints
    • rpc <stats> is not backward compatible
  • New clixon-autocli@2023-05-01.yang revision
    • New alias and skip extensions (NOTE: just added in YANG, not implemented)
    • New grouping-treeref option

C/CLI-API changes on existing features

Developers may need to change their code

  • Added uid, gid and fdkeep parameters to clixon_process_register() for drop privs
  • Added output function to JSON output:
    • xml2json_vec(...,skiptop) --> xml2json_vec(..., cligen_output, skiptop)
  • yang2cli_yspec removed last argument printgen.
  • Removed obsolete: cli_auto_show()

Minor features

  • Autocli optimization feature for generating smaller CLISPECs for large YANGs using treerefs
    • New grouping-treeref option added to clixon-autocli.yang
    • Default is disabled, set to true to generate smaller memory footprint of clixon_cli
  • Changed YANG uses/grouping to keep uses statement and flag it with YANG_FLAG_USES_EXP
  • Removed extras/ and build-root/ build code since they are not properly maintained
  • Refactored cli-syntax code to use cligen pt_head instead (long overdue)
  • Modified backend exit strategy so that 2nd ^C actually exits
  • Performance: A change in the merge code made "co-located" config and non-config get retrieval go considerable faster. This is done by a specialized xml_child_each_attr() function.
  • CLI: Added show statistics example code for backend and CLI memory stats
  • Support yang type union with are same subtypes with SNMP
  • Removed obsolete compile options introduced in 6.1:
    • NETCONF_DEFAULT_RETRIEVAL_REPORT_ALL
    • AUTOCLI_DEPRECATED_HIDE

Corrected Bugs

Assets 2

Clixon 6.2.0

30 Apr 19:13
@olofhagsand olofhagsand
6.2.0
130c1b0
Compare
Choose a tag to compare
Clixon 6.2.0

6.2.0

30 April 2023

Clixon 6.2.0 brings no new major feature changes, but completes YANG
schema mount and other features required by the clixon controller
project, along with minor improvements and bugfixes.

API changes on existing protocol/config features

Users may have to change how they access the system

  • New clixon-config@2023-03-01.yang revision
    • Added options: CLICON_RESTCONF_NOALPN_DEFAULT
    • Extended datastore-format with CLI and text
  • New clixon-lib@2023-03-01.yang revision
    • Added creator meta-object

C/CLI-API changes on existing features

Developers may need to change their code

  • C-API
    • clixon_xml2file and clixon_xml2cbuf added prefix argument
      • Example application is to add "+"/"-" for diffs
      • Example change:
        • clixon_xml2file(f,x,p,f,s,a) -> clixon_xml2file(f,x,p,NULL,f,s,a)
        • clixon_xml2cbuf(c,x,l,p,d,s) -> clixon_xml2cbuf(c,x,l,p,NULL,d,s)
    • xmldb_validate is removed. Yang checks should be enough, remnant of time before YANG checks.
    • xml_diff: removed 1st yspec parameter
    • xml2xpath(): Added int apostrophe as 4th parameter, default 0
      • This is for being able to choose single or double quote as xpath literal quotes
    • clicon_msg_rcv: Added intr parameter for interrupting on ^C (default 0)
    • Renamed include file: clixon_backend_handle.hto clixon_backend_client.h
    • candidate_commit(): validate_level (added in 6.1) marked obsolete

Minor features

  • Adjusted to Openssl 3.0
  • Unified netconf input function
    • Three different implementations were used in external, internal and controller code
      • Internal netconf still not moved to unified
    • The new clixon_netconf_input API unifies all three uses
    • Code still experimental controlled by NETCONF_INPUT_UNIFIED_INTERNAL
  • RFC 8528 YANG schema mount
    • Made cli/autocli mount-point-aware
  • Internal NETCONF (client <-> backend)
    • Ensure message-id increments
    • Separated rpc from notification socket in same session
  • Restconf: Added fallback mechanism for non-ALPN HTTPS
    • Set CLICON_RESTCONF_NOALPN_DEFAULT to http/2 or http/1.1
    • For http/1 or http/2 only, that will be the default if no ALPN is set.
  • Fixed: Add support decimal64 for SNMP

Corrected Bugs

  • Fixed RESTCONF race conditions on SSL_shutdown sslerr ZERO_RETURN appears occasionally and exits.
  • Fixed: RESTCONF: some client cert failure leads to restconf exit. Instead close and continue
Assets 2

Clixon 6.1.0

19 Feb 10:59
@olofhagsand olofhagsand
6.1.0
72a4494
Compare
Choose a tag to compare
Clixon 6.1.0

6.1.0

19 Feb 2023

The Clixon 6.1 release completes Network monitoring (RFC 6022) and introduces a first version of YANG schema mount (RFC 8528). The main focus has been interoperability and basic support for the ongoing Clixon controller work.

New features

  • YANG schema mount RFC 8528
    • The primary use-case is the clixon-controller but can be used independently
    • New plugin callback: ca_yang_mount
      • To specify which YANG modules should be mounted
    • New plugin callback: ca_yang_patch
      • A method to patch a YANG module
    • To enable yang mounts, set new option CLICON_YANG_SCHEMA_MOUNT to true
    • Restrictions:
      • Only schema-ref=inline, not shared-schema
      • Mount-points must be presence containers, regular containers or lists are not supported.
  • Netconf monitoring RFC 6022
    • This is part 2, first part was in 6.0
    • Datastores, sessions and statistics
      • Added clixon-specific transport identities: cli, snmp, netconf, restconf
      • Added source-host from native restonf, but no other transports
      • Hello statistics is based on backend statistics, hellos from RESTCONF, SNMP and CLI clients are included and dropped external NETCONF sessions are not
      • RFC 6022 "YANG Module for NETCONF Monitoring"
    • See Feature Request: Support RFC 6022 (NETCONF Monitoring)

API changes on existing protocol/config features

Users may have to change how they access the system

  • Obsolete config options given in the configuration file are considered an error
  • New clixon-config@2022-12-01.yang revision
    • Added option: 'CLICON_YANG_SCHEMA_MOUNT`
    • Removed obsolete option: CLICON_MODULE_LIBRARY_RFC7895
  • clixon-lib,yang
    • Moved all extended internal NETCONF attributes to the clicon-lib namespace
      • These are: content, depth, username, autocommit, copystartup, transport, source-host, objectcreate, objectexisted.
    • The internal attributes are documented in https://clixon-docs.readthedocs.io/en/latest/netconf.html
  • With-defaults default retrieval mode has changed from REPORT-ALL to EXPLICIT
    • This means that all get operations without with-defaults parameter do no longer
      return implicit default values, only explicitly set values.
    • Applies to NETCONF <get>, <get-config> and RESTCONF GET
    • To keep backward-compatible behavior, define option NETCONF_DEFAULT_RETRIEVAL_REPORT_ALL in include/clixon_custom.h
    • Alternatively, change all get operation to include with-defaults parameter report-all

C/CLI-API changes on existing features

Developers may need to change their code

  • Changed docker builds
    • clixon-test built in docker/test
      • Renamed from clixon-system built in docker/main
    • clixon-example built in docker/example
      • Added netconf ssh subsystem
      • Renamed from clixon built in docker/base
  • C-API
    • xml2xpath(): Added int spec as third parameter, default 0
      • This was for making an xpath to a yang-mount point (only for yang-mount)
      • Example change:
        • xml2xpath(x, n, xp) -> xml2xpath(x, n, 0, xp)
    • xml_bind_*() functions: Added clicon_handle h as first parameter
      • Example change:
        • xml_bind_yang(x, y, yp, xe) -> xml_bind_yang(h, x, y, yp, xe) ->
    • xmldb_get0(): Added with-defaults parameter, default 0
      • Example change:
        • xmldb_get0(0, db, yb, n, xp, c, x, m, x) -> xmldb_get0(0, db, yb, n, xp, c, WITHDEFAULTS_REPORT_ALL, x, m, x)
    • candidate_commit(): Add myid as fourth and validate_level as fifth parameter, default 0
      • Example change:
        • candidate_commit(h, x, d, c) -> candidate_commit(h, x, d, 0, VL_FULL, c)
    • xpath_vec_flag(): Changed type of sixth veclen parameter to size_t *
    • clicon_log_xml(): All calls changed to new function clicon_debug_xml()
    • clixon_proc_socket(): Added sock_flags parameter

Minor features

  • Misc. build fixes encountered when cross-compiling by @troglobit in #418
  • Update FAQ.md hello world example url by @jarrodb in #419
  • Done: Request to suppress auto-completion for "deprecated" / "obsolete" status and warn the user.
    • Implemented by:
      • Not generating any autocli syntax for obsolete YANG statements,
      • Hide statements for deprecated YANG statements.
  • New plugin callbacks
    • ca_yang_mount - see the RFC 8528 support
    • ca_yang_patch - for modifying existing YANG modules
  • Changed debug levels in clicon_debug() to be based on maskable flags:
    • Added flag names: CLIXON_DBG_*
    • Added maskable flags that can be combined when debugging:
      • DEFAULT = 1: Basic debug message, espcially initialization
      • MSG = 2: Input and output packets, read datastore
      • DETAIL = 4: xpath parse trees, etc
      • EXTRA = 8: Extra detailed logs, message dump in hex
  • Added ISO/IEC 10646 encodings to XML parser: &#[0-9]+; and &#[0-9a-fA-F]+;
  • Added CLIXON_CLIENT_SSH to client API to communicate remotely via SSH netconf sub-system

Corrected Bugs

Contributors

troglobit, jarrodb, and 2 other contributors
Assets 2

Clixon 6.0.0

29 Nov 16:37
@olofhagsand olofhagsand
6.0.0
083bb72
Compare
Choose a tag to compare
Clixon 6.0.0

6.0.0

29 Nov 2022

The 6.0 release features confirmed-commit and an initial version of
netconf monitoring along with many minor changes and bug fixes.

New features

  • Confirmed-commit capability
    • Standards
      • RFC 4741 "NETCONF Configuration Protocol": Section 8.4
      • RFC 6241 "Network Configuration Protocol (NETCONF)": Section 8.4
    • Features
      • :confirmed-commit:1.0 capability
      • :confirmed-commit:1.1 capability
    • Added support for relevant arguments to CLI commit
    • See Netconf Confirmed Commit Capability
  • Netconf monitoring, part 1

API changes on existing protocol/config features

Users may have to change how they access the system

  • New clixon-config@2022-11-01.yang revision
    • Added option:
      • CLICON_NETCONF_MONITORING
      • CLICON_NETCONF_MONITORING_LOCATION
  • Added PRETTYPRINT_INDENT compile-time option controlling indentation level for XML, JSON, TEXT and YANG
    • Default value is 3
  • NETCONF: Removed message-id from hello protocol following RFC 6241

C/CLI-API changes on existing features

Developers may need to change their code

  • Code formatting: Change indentation style to space
    • Applies to all c/h/y/l/sh files and .editorconfig
  • C API changes:
    • Added expanddefault parameter to xml_yang_validate_rpc()
    • Added defaults parameter to clicon_rpc_get_pageable_list()
    • clicon_rpc_commit() and cli_commit
      • Added confirmed, cancel, timeout, persist-id, and persist-id-val parameters to
    • clicon_rpc_commit() and clicon_rpc_validate
      • Added three-value return.
      • Code need to be changed from: checking for <0 to <1 to keep same semantics
    • Added skiptop parameter to xml2json_vec()
    • Added xe argument to candidate_commit for confirmed commit extra parameters

Minor features

  • Removed obsoleted compile-time options since 5.4:
    • YANG_ORDERING_WHEN_LAST
    • JSON_CDATA_STRIP
  • Added fuzz code for xpath
  • List-pagination: Follow ietf-draft 100%: Removed list-pagination "presence"
  • Main example: Removed dependency of external IETF RFCs
  • Added warning if modstate is not present in datastore if CLICON_XMLDB_MODSTATE is set.

Corrected Bugs

Assets 2

Clixon 5.9.0

24 Sep 15:10
@olofhagsand olofhagsand
5.9.0
3329792
Compare
Choose a tag to compare
Clixon 5.9.0

The 5.9 release features with-defaults (RFC 6243) and RESTCONF Call-home (RFC 8071) along with numerous bugfixes and usability improvements.

New features

  • With-defaults capability
    • Standards
      • RFC 6243 "With-defaults Capability for NETCONF"
      • RFC 8040 "RESTCONF Protocol": Section 4.8.9
    • Features:
      • :with-defaults capability
      • explicit basic mode
      • Full retrieval modes: explicit, trim, report-all, report-all-tagged.
      • RESTCONF with-defaults query for XML and JSON
        • Assigned meta-data for the ietf-netconf-with-defaults:default attribute for JSON (RFC8040 Sec 5.3.2)
    • Added withdefault option to cli show commands
    • See Netconf With-defaults Capability
  • RESTCONF call home
    • Standard: RFC 8071 "NETCONF Call Home and RESTCONF Call Home"
    • clixon-restconf.yang extended with callhome inspired by ietf-restconf-server.yang
      • See e.g., draft-ietf-netconf-restconf-client-server-26.txt
    • The <socket> list has been extended with a call-home presence container including:
      • reconnect-strategy/max-attempts
      • connection-type: either persistent or periodic
      • idle-timeout for periodic call-homes.
    • An example util client is clixon_restconf_callhome_client.c used in test cases
    • See call-home user guide

API changes on existing protocol/config features

Users may have to change how they access the system

  • NETCONF error handling for data-not-unique and missing-choice follows standard more closely
    • data-not-unique:
      • Added YANG namespace to <non-unique> tag
      • Changed yang-unique value to path insytead of single name
      • See RFC 7950 Sec 15.1
    • missing-choice:
      • Added <error-path>
      • Added YANG namespace to <missing-choice> tag
      • See RFC 7950 Sec 15.6
  • Backend transaction plugins: edit of choice node will always result in a "del/add" event for all edits of change nodes, never a "change" event.
  • Constraints on number of elements have been made stricter (ie unique, min/max-elements)
    • Usecases that passed previously may now return error
    • This includes:
      • Check of incoming RPCs
      • Check of non-presence containers

C/CLI-API changes on existing features

Developers may need to change their code

  • C API changes
    • Added defaults parameter to clicon_rpc_get() and clicon_rpc_get_config()
      • For upgrade, add new sixth parameter and set it to NULL.
  • CLISPEC changes of cli show functions
    • For details of updated API, see https://clixon-docs.readthedocs.io/en/latest/cli.html#show-commands
    • Changed cli_show_auto()
      • Added parameters for pretty-print, state and with-default
      • If the <prefix>is used, you need to change the call as follows:
        • cli_show_auto(<db>, <format>, <prefix>) -> cli_show_auto(<db>, <format>, true, false, NULL, <prefix>)
      • Otherwise the API is backward-compatible
    • Changed cli_show_config()
      • Added parameters for pretty-print, state and with-default
      • If the <prefix> parameter is used, you need to change the call as follows:
        • cli_show_config(<db>, <format>, <xpath>, <ns>, <prefix>) -> cli_show_auto(<db>, <format>, <xpath>, <ns>, true, false, NULL, <prefix>)
      • Otherwise the API is backward-compatible
    • Removed cli_show_auto_state(), replace with cli_show_auto with state set to true
    • Removed cli_show_config_state(), replace with cli_auto_show with state set to true
    • Replaced cli_auto_show() with cli_show_auto_mode()
      • The first argument is removed. You need to change all calls as follows:
        • cli_show_config(<treename>, <db>, ... -> cli_show_auto_menu(<db>, ...)
      • The cli_auto_show() callback remains in 5.9.0 for backward compatible reasons, but will be removed in later releaes.

Minor features

  • Restconf:
    • Openssl 3.0 is supported
    • Refactoring of code closing sockets. Some cornercase bugs have been removed.

Corrected Bugs

Assets 2

Clixon 5.8.0

28 Jul 18:51
@olofhagsand olofhagsand
5.8.0
6f5149c
Compare
Choose a tag to compare
Clixon 5.8.0

5.8.0

28 July 2022

New features in Clixon 5.8.0 include a new SNMP frontend, YANG action and parse-able TEXT syntax.

New features

  • New SNMP frontend

    • Support for SNMP for retreiving and setting values via net-snmp using MIB-YANG mapping defined in RFC6643.
    • For details, see SNMP section of user manual
    • YANG clixon-config@2022-03-21.yang changes:
      • Added options:
        • CLICON_SNMP_AGENT_SOCK
        • CLICON_SNMP_MIB
    • New configure options:
      • --enable-netsnmp
      • --with-mib-generated-yang-dir=DIR (test only)
    • Thanks: Siklu Communications LTD for sponsoring this work

  • YANG Action (RFC 7950 Section 7.15)

    • Register action callback with action_callback_register()
      • The main example contains example code
    • Remains: check list keys, validate output
    • See Support for "action" statement

  • TEXT syntax is now parseable

API changes on existing protocol/config features

Users may have to change how they access the system

  • TEXT file format changed
    • With new parsing of TEXT format, the output is changed
      • Namespace/modulename added to top-level
      • Leaf-list support: a [ x y z ]
      • List key support: a x y { ... }
      • See compile-time option TEXT_LIST_KEYS
    • Keep backward-compatible non-top-level prefix with compile-time option TEXT_SYNTAX_NOPREFIX
  • Augmented XML uses default namespace
    • Instead of using prefixes for augmented XML, assign the default namespace
    • This does not change the semantics, but changes the way XML prefixes are used
    • Example augmented ipv4 into interface:
      • Previously: <interface><ip:ipv4 xmlns:ip="urn:...:ietf-ip"><ip:enabled>...
      • Now: <interface><ipv4 xmlns="urn:...:ietf-ip"><enabled>...

C/CLI-API changes on existing features

Developers may need to change their code

  • Changed C-API for xml translation/print the internal cxobj tree data structure to other formats.
    • Functions are merged, ie removed and replaced with more generic functions
    • Added skiptop parameter, if set only apply to children of a node, skip top node
      • default is 0
    • The new API is as follows:
      • clixon_xml2file() / clixon_xml2cbuf() - Print internal tree as XML to file or buffer, respectively
      • clixon_json2file() / clixon_json2cbuf() - Print internal tree as JSON to file or buffer, respectively
      • clixon_cli2file() - Print internal tree as CLI format to file
      • clixon_txt2file() - Print internal tree as text format to file
    • As developer, you need to replace the old functions to the new API as follows:
      • clicon_xml2file(f, x, l, p) -> clixon_xml2file(f, x, l, p, NULL, 0, 0)
      • clicon_xml2file_cb(f, x, l, p, fn) -> clixon_xml2file(f, x, l, p, fn, 0, 0)
      • cli_xml2file(x, l, p, fn) -> clixon_xml2file(stdout, x, l, p, fn, 0, 0)
      • clicon_xml2cbuf(c, x, l, p, d) -> clixon_xml2cbuf(c, x, l, p, d, 0)
      • clicon_xml2str(x) -> Rewrite using cbufs and clixon_xml2cbuf()
      • xml2json(f, x, p) -> clixon_json2file(f, x, p, NULL, 0, 0)
      • xml2json_cb(f, x, p, fn) -> clixon_json2file(f, x, p, fn, 0, 0)
      • xml2json_cbuf(c, x, p) -> clixon_json2cbuf(c, x, p, 0, 0)
      • xml2cli(h, f, x, p, fn) -> clixon_cli2file(h, f, x, p, fn, 0)
      • cli_xml2txt(x, fn, l) -> clixon_txt2file(stdout, x, l, NULL, 0, 0)
      • xml2txt(f, x, l) -> clixon_txt2file(f, x, l, NULL, 0, 0)
      • xml2txt_cb(f, x, fn) -> clixon_txt2file(f, x, 0, NULL, 0, 0)

Minor features

Corrected Bugs

Assets 2