NOTE: The with-canonical parameter applies to YumaPro SDK 17.10-7+.


The with-canonical parameter controls automatic conversion to canonical format for certain YANG data types.
If set to 'true', then the server will automatically convert XML and JSON input parameters to the canonical format for the YANG data type, if possible.

The default value for the with-canonical parameter is 'true'.


The following built-in YANG data types are affected by the with-canonical parameter:

  • ipv6-address
  • ipv6-address-no-zone
  • domain-name
  • phys-address
  • mac-address
  • hex-string
  • uuid

Any canonical callbacks for user-defined data types are also affected by this parameter.

Internal values can be manually converted to canonical format using the val_set_canonical API.


The with-canonical parameter can be set via the command line when booting netconfd-pro:


user@system> netconfd-pro --with-canonical=false


or configured in netconfd-pro's configuration file, which is located by default at /etc/yumapro/netconfd-pro.conf:


#### leaf with-canonical
# If set to 'true', then the server will automatically
# convert XML and JSON input parameters to the canonical
# format for the YANG data type, if possible.
#
# with-canonical true
#

with-canonical false