Yuma yangdump Manual
Contents
1. Syntax boolean Default FALSE Min Allowed 0 Max Allowed 1 Supported by yangdump Example yangdump unified true format html subtree PROJECT X modules defnames true output PROJECT_X html 3 35 urlstart The urlstart parameter specifies the string to start all URLs during yangdump HTML translation If present then this string will be used to start all HREF links and URLs generated for SQL and HTML translation It is expected to be a URL ending with a directory path The trailing separator will be added if it is missing If not present the default then relative URLs starting with the file name will be generated instead For example if this parameter is set to the following string http acme com public The URL generated for the bar type on line 53 in the module FOO version 2008 01 01 would be if versionnames false http acme com public FOO html bar 53 if versionnames true default Page 47 Version 2 2 Yuma yangdump Manual http acme com public FOO_2008 01 01 html bar 53 urlstart parameter Syntax string URL format Default none Max Allowed Supported by Example yangdump urlstart example com public unified true format html subtree PROJECT X modules Y defnames true output PROJECT_X html The version parameter causes the program version string to be printed and then the program will2. Syntax enumeration xsd sql sgldb html yang copy h c uc uh yc yh Default none Min Allowed 0 Max Allowed 1 Supported by yangdump Example yangdump testl test2 format xsd defnames true output workdir 3 13 help The help parameter causes program help text to be printed and then the program will exit instead of running as normal This parameter can be combined with the help mode parameter to control the verbosity of the help text Use brief for less and full for more than the normal verbosity This parameter can be combined with the version parameter in all programs It can also be combined with the show errors parameter in yangdump The program configuration parameters will be displayed in alphabetical order not in schema order help parameter Page 31 Version 2 2 3 14 Yuma yangdump Manual Syntax empty Default none Min Allowed 0 Max Allowed 1 Supported by netconfd yangcli yangdiff yangdump Example yangdump help help mode The help mode parameter is used to control the amount of detail printed when help text is requested in some command It is always used with another command and makes no sense by itself It is ignored unless used with the help parameter default choice normal help mode parameter Syntax choice of 3 empty leafs brief normal full Default normal Min Allowed
3. Yuma yangdump Manual Default info debug for DEBUG builds Min Allowed 0 Max Allowed 1 Supported by netconfd yangcli yangdiff yangdump Example yangdump log level debug log test log amp The modpath parameter specifies the YANG module search path to use while searching for YANG files It consists of a colon separated list of path specifications commonly found in Unix such as the PATH environment variable This parameter overrides the YUMA MODPATH environment variable if it is present modpath parameter Syntax string list of directory specifications Default YUMA MODPATH environment variable Min Allowed 0 Max Allowed 1 Supported by netconfd yangcli yangdiff yangdump Example yangdump modpathz testmodules modules trunk netconf modules module test42 yang The module parameter is a leaf list of modules that should be loaded automatically when the program starts The program will attempt to load each module in the order the parameters were entered For the netconfd program If any modules have fatal errors then the program will terminate For the yangdump program each module will be processed as requested Page 37 Version 2 2 Yuma yangdump Manual module parameter Min Allowed 0 Supported by netconfd yangcli yangdump Example yangcli module test1 module test2 The modversion parameter causes the module na
4. exit instead of running as normal All Yuma version strings use the same format DEBUG lt major gt lt minor gt lt svn build version gt or NON DEBUG lt major gt lt minor gt lt release gt An example version number that may be printed yangdump 2 0 0 This parameter can be combined with the help parameter Page 48 Syntax Default version parameter Min Allowed Max Allowed Supported by Example netconfd yangcli yangdiff yangdump yangdump version Version 2 2 Yuma yangdump Manual The versionnames parameter indicates that revision dates should not be used when constructing any output YANG module file names If present the default filenames will not contain the module version string Normally the sub module name and version string are both used to generate a default file name when the defnames output parameter is set to true This parameter will cause filenames to be generated which do not contain the revision date string versionnames parameter Min Allowed 0 Max Allowed 1 Supported by yangdump Example yangdump versionnames false subtree testpath defnames true output work3 format html The warn idlen parameter controls whether identifier length warnings will be generated The value zero disables all identifier length checking If non zero then a warning will be generated if an identifier is defined which
5. lt module name test4 xmlns urn ietf params xml ns yang yin 1 xmlns t4 http netconfcentral org ns test4 gt lt namespace uri http netconfcentral org ns test4 gt lt prefix value t4 gt revision date 2009 09 09 gt lt description gt lt text gt Initial revision lt text gt lt description gt lt revision gt lt typedef name aa type gt lt description gt lt text gt test type lt text gt lt description gt lt type name int32 gt lt range value 1 10 20 30 gt lt type gt lt typedef gt lt container name a gt lt leaf list name aa gt lt type name aa type gt lt max elements value 5 gt lt leaf list gt lt container gt lt leaf name b gt lt type name leafref gt lt path value a aa gt lt type gt lt leaf gt lt list name c gt key value x leaf name x gt type name uint16 gt lt leaf gt lt leaf name y gt lt type name instance identifier gt Page 14 Version 2 2 Yuma yangdump Manual lt leaf gt lt list gt lt module gt XHTML 1 0 files can be generated by using the format html parameter value An HTML version of a YANG file will contain color coded YANG tokens to make the file easier to read There will also be links created whenever possible for statements which reference typedefs groupings extensions etc The following configuration parameters are available to control some of t
6. netconfd yangcli yangdiff yangdump Example yangdump log test log amp Page 35 Version 2 2 Yuma yangdump Manual The log append parameter specifies that the existing log file if any should be appended instead of deleted It is ignored unless the log parameter is present log append parameter Syntax Default Min Allowed Max Allowed Supported by netconfd yangcli yangdiff yangdump Example yangdump log append log test log amp The log level parameter controls the verbosity level of messages printed to the log file or STDOUT if no log file is specified The log levels are incremental meaning that each higher level includes everything from the previous level plus additional messages There are 7 settings that can be used none All logging is suppressed Use with extreme caution error Error messages are printed indicating problems that require attention warn Warning messages are printed indicating problems that may require attention info Informational messages are printed that indicate program status changes debug Debugging messages are printed that indicate program activity debug2 Protocol debugging and trace messages are enabled debug3 Very verbose debugging messages are enabled This has an impact on resources and performance and should be used with caution log level parameter enumeration off error warn info Page 36 Version 2 2
7. then the YUMA_HOME environment variable will be ignored The following directories are searched when either the YUMA_HOME environment variable or this parameter is set YUMA_HOME modules o This sub tree is searched for YANG files Page 51 Version 2 2 Yuma yangdump Manual YUMA HOME data o This directory is searched for data files YUMA HOME scripts o This directory is searched for yangcli script files yuma home parameter Syntax string directory specification Default YUMA HOME environment variable Min Allowed 0 Max Allowed 1 Supported by netconfd yangcli yangdiff yangdump Example yangdump yuma home sw netconf log server log amp Page 52 Version 2 2
8. 0 Max Allowed 1 Supported by netconfd yangcli yangdiff yangdump Example yangdump help help mode full choice help mode o Page 32 brief type empty This parameter specifies that brief documentation mode should be used normal type empty This parameter specifies that normal documentation mode should be used full type empty This parameter specifies that full documentation mode should be used Version 2 2 Yuma yangdump Manual The html div parameter controls whether yangdump HTML translation will generate a single lt div gt element or an entire HTML document If HTML translation is requested then setting this parameter to true will cause the output to be a single lt div gt element instead of an entire HTML file If it is not requested format html then this parameter is ignored This parameter allows the HTML translation to be easily integrated within more complex WEB pages but the proper CSS definitions need to be present for the HTML to render properly It is suggested only HTML experts use this parameter Refer to the following stylesheet file for more details http www netconfcentral org static css style css The default filename extension will be div instead of html if this parameter is present The contents will be well formed XHTML 1 0 but without any namespace declarations html div parameter Syntax boolean Default Min Al
9. Generated by yangdump 0 9 7 452 at 2009 08 27123 56 21Z Error import testloops for current module testloops yang 6 5 error 327 import loop Error include testloops for current submodule testloops yang 10 5 error 328 include loop Error typedef typeloop cannot use type typeloop testloops yang 35 8 error 325 definition loop detected Error named type loops with type typeloop2 on line 43 testloops yang 47 8 error 325 definition loop detected Error uses of grouploop is contained within that grouping defined on line 50 testloops yang 51 8 error 325 definition loop detected Error grouping grouploop2 on line 54 loops in uses defined in module testloops line 63 testloops yang 54 5 error 325 definition loop detected Error leafref path in leaf LR1 loops with leaf LR3 testloops yang 16 5 error 359 leafref path loop Error leafref path in leaf LR2 loops with leaf LR1 testloops yang 22 5 error 359 leafref path loop Error leafref path in leaf LR3 loops with leaf LR2 testloops yang 28 5 error 359 leafref path loop home andy modules test testloops yang 9 Errors 0 Warnings 2 3 Translating YANG to Other Formats The yangdump program can be used to translate YANG files to other formats using the format parameter This section describes the available translation modes In all cases the subtree or module parameter is required to specify the input files Any number of these parame
10. Version 2 2 Yuma yangdump Manual Default none Min Allowed 0 Max Allowed unlimited Supported by yangcli yangdiff yangdump netconfd Example yangdump format c feature disable test featurel module test The feature dynamic parameter controls how yangdump will generate dynamic code for a specific feature This parameter is a formatted string containing a module name followed by a colon followed by a feature name e g test featurel It is an error if a feature static and feature dynamic parameter specify the same feature Parameters for unknown features will be ignored feature dynamic parameter Syntax formatted string module feature Default none Min Allowed 0 Supported by yangdump Example yangdump format c feature dynamic test featurel module test The feature enable parameter directs all programs to enable a specific feature This parameter is a formatted string containing a module name followed by a colon followed by a feature name e g test featurel Page 28 Version 2 2 Yuma yangdump Manual It is an error if a feature disable and feature enable parameter specify the same feature Parameters for unknown features will be ignored feature enable parameter Supported by Example Syntax formatted string module feature Default none Min Allowed 0 yangcli yangdiff yangdump netconfd yan
11. container rpc absolute XPath expression for the object Example report for module yuma mysession identifiers rpc get my session container get my session output leaf get my session output indent leaf get my session output linesize leaf get my session output with defaults container get my session input rpc set my session container set my session input leaf set my session input indent leaf set my session input linesize leaf set my session input with defaults container set my session output identifiers parameter Syntax empty Page 34 Version 2 2 Yuma yangdump Manual Default none Min Allowed 0 Max Allowed 1 Supported by yangdump Example yangdump identifiers module yuma mysession The indent parameter specifies the number of spaces that will be used to add to the indentation level each time a child node is printed during program operation indent parameter Syntax uint32 0 9 Default Min Allowed Max Allowed Supported by netconfd yangcli yangdiff yangdump Example yangdump indent 4 The log parameter specifies the file name to be used for logging program messages instead of STDOUT It can be used with the optional log append and log level parameters to control how the log file is written log parameter Syntax string log file specification Default Min Allowed Max Allowed Supported by
12. for the XSD Page 18 Version 2 2 Yuma yangdump Manual The data structures generated during XSD translation will be extensions to the NETCONF XSD defined in RFC 4741 A YANG rpc statement will be translated to an lt rpcOperationType gt element A YANG notification statement will be translated to an lt eventType gt element A YANG leaf and leaf list statements will be translated to a lt simpleType gt and corresponding lt element gt definition A YANG container or list statement will be translated to a lt complexType gt and corresponding lt element gt definition A YANG choice statement will be translated to a lt choice gt element A YANG top level typedef statement will be translated to a lt simpleType gt element A YANG range statement will be translated to lt restriction gt elements or a union of lt restriction gt elements if the YANG range is non contiguous A YANG pattern statement will be translated into a lt pattern gt element Multiple YANG patterns within a single typedef will be translated into nested inline lt simpleType gt elements to preserve the AND llogic instead of the XSD OR logic YANG description and reference statements are translated to lt documentation gt elements within an lt annotation gt element YANG header constructs are translated into lt annotation gt elements that are defined in yuma ncx yang The following example shows the translation of test test4 yang The comma
13. has a length is greater than this amount warn idlen parameter Syntax uint32 O to disable or 8 1023 Default Min Allowed Max Allowed Supported by netconfd yangcli yangdiff yangdump Example yangdump warn idlen 50 Page 49 Version 2 2 Yuma yangdump Manual The warn linelen parameter controls whether line length warnings will be generated The value zero disables all line length checking If non zero then a warning will be generated if a YANG file line is entered which has a length is greater than this amount Tab characters are counted as 8 spaces warn linelen parameter Syntax Default uint32 0 to disable or 40 4095 Min Allowed 0 Supported by netconfd yangcli yangdiff yangdump Example yangdump warn linelen 79 The warn off parameter suppresses a specific warning number The error and warning numbers and the default messages can be viewed with the yangdump program by using the show errors configuration parameter The specific warning message will be disabled for all modules No message will be printed and the warning will not count towards the total for that module warn off parameter Syntax uint32 400 899 Default Min Allowed 0 Max Allowed 499 Supported by netconfd yangcli yangdiff yangdump Example yangdump warn off 435 revision order not descending The xsd schemaloc parameter specifies that yangdump XSD tr
14. libsmi Home Page o http www ibr cs tu bs de projects libsmi o Free tools such as smidump to convert SMIv2 to YANG NETCONF Working Group o http www ietf org html charters netconf charter html o Technical issues related to the NETCONF protocol are discussed on the NETCONF WG mailing list Refer to the instructions on the WEB page for joining the mailing list NETMOD Working Group o http www ietf org html charters netmod charter html o Technical issues related to the YANG language and YANG data types are discussed on the NETMOD WG mailing list Refer to the instructions on the WEB page for joining the mailing list The following formatting conventions are used throughout this document Documentation Conventions Convention Description foo CLI parameter foo lt foo gt XML parameter foo foo yangcli command or parameter FOO Environment variable FOO foo yangcli global variable foo some text Example command or PDU some text Plain text Page 4 Version 2 2 Yuma yangdump Manual 2 yangdump yangdump YANG compiler yangdump The yangdump program is used to validate YANG files and convert them to other formats It is normally used by authors while developing new YANG data models The compiler and validation engine portion of yangdump libncx so is used in all Yuma programs The yangdumpcode program is the same as yangdump except that the format parameter allows more
15. span gt lt span class yang_str gt system lt span gt lt span class yang_cmt gt container a lt span gt Page 16 Version 2 2 Yuma yangdump Manual lt a name b 22 gt lt a gt lt span class yang_kw gt leaf lt span gt lt span class yang_id gt b lt span gt lt span class yang_kw gt type lt span gt lt span class yang_id gt leafref lt span gt lt span class yang_kw gt path lt span gt lt span class yang_str gt a aa lt span gt lt span class yang_kw gt config lt span gt lt span class yang_str gt true lt span gt lt a name c 26 gt lt a gt lt span class yang_kw gt list lt span gt lt span class yang_id gt c lt span gt lt span class yang_kw gt key lt span gt lt a href x 28 gt x lt a gt lt span class yang_kw gt config lt span gt lt span class yang_str gt true lt span gt lt span class yang_kw gt ordered by lt span gt lt span class yang_str gt system lt span gt lt a name x 28 gt lt a gt lt span class yang_kw gt leaf lt span gt lt span class yang_id gt x lt span gt lt span class yang_kw gt type lt span gt lt span class yang_id gt uint16 lt span gt lt a name y 29 gt lt a gt lt span class yang_kw gt leaf lt span gt lt span class yang_id gt y lt span gt lt span class yang_kw gt type lt span gt lt span class yang_id gt instance identifier lt span gt lt span class
16. specific file formats for HTML output If the output parameter is present and represents an existing directory then the default filename will be created in that directory instead of the current directory This parameter is ignored if the format parameter is missing defnames parameter Syntax boolean Default FALSE Max Allowed 1 Page 24 Version 2 2 Yuma yangdump Manual Example yangdump defnames true subtree workdir format html The dependencies parameter causes information to be reported for the symbols that this sub module imports from other modules The following information is reported for each dependency module name revision date Example report for module yangdump dependencies import ncx 2009 06 12 import ncx app common 2009 04 10 import ncxtypes 2008 07 20 dependencies parameter Syntax empty Default none 0 1 Min Allowed Max Allowed Supported by yangdump Example yangdump dependencies module test4 The deviation parameter is a leaf list of modules that should be loaded automatically when the program starts as a deviation module In this mode only the deviation statements are parsed and then made available later when the module that contains the objects being deviated is parsed The deviations must be known to the parser before the target module is parsed This parameter is used to identify any modules
17. that have deviation statements for the set of modules being parsed e g module and subtree parameters A module can be listed with both the module and deviation parameters but that is not needed unless the module contains external deviations If the module only contains deviations for objects in the same module then the deviation parameter does not need to be used The program will attempt to load each module in deviation parsing mode in the order the parameters are entered For the netconfd program If any modules have fatal errors then the program will terminate For the yangdump and yangcli programs each module will be processed as requested Page 25 Version 2 2 Yuma yangdump Manual deviation parameter Syntax module name or filespec Min Allowed 0 Supported by netconfd yangcli yangdump Example yangcli module testl deviation testl deviations The exports parameter causes information to be reported for the symbols that this sub module exports to other modules The exports for the entire module are printed unless the specified input file is a YANG submodule In that case just the exports in the submodule are reported It includes the following information generated in this order sub module name e version e source filespec e namespace module only prefix module only belongs to submodule only e typedefs groupings objects RPC operations e notifica
18. the indent count to use when writing data log Specifies the log file to use instead of STDOUT log append Controls whether a log file will be reused or overwritten log level Controls the verbosity of logging messages modpath Sets the module search path module Specifies one or more YANG modules to load upon startup modversion Generate the module version report subdirs Controls whether sub directories will be searched during file searches Version 2 2 Yuma yangdump Manual versionnames Controls whether the revision date is used in YANG module file names objview Specifies whether raw or cooked objects will be generated during HTML and YANG translation output Specifies where output files should be generated runpath Sets the executable file search path show errors Print all the error and warning messages then exit simurls Controls how URL parameters are generated during HTML file output stats Control YANG usage statistics reporting for each input module subdirs Controls whether sub directories are searched for YANG files subtree Specifies one or more directory subtrees to search for YANG modules tree identifiers Generate the module object identifier local names report in tree format totals Controls statistics summary reporting for a set of input modules unified Controls whether to combine submodules into
19. the main module in the translation output urlstart Specifies the start of URLs to use during HTML file generation version Prints the program version and then exit warn idlen Controls how identifier lengths are checked warn linelen Controls how line lengths are checked warn off Suppresses the specified warning number xsd schemaloc Generate schemaLocation attributes during XSD translation yuma home Specifies the YUMA_HOME project root to use when searching for files 2 2 Validating YANG Files The yangdump program will always validate the modules specified in the configuration parameters unless one of the quick exit modes is requested version or help If a valid format parameter is present then some sort of translation will also be attempted The modules or submodules to validate are specified with the module and or subtree configuration parameters All sub modules that are included and all modules that are imported are also validated This is done in the order the import or include statements are encountered Errors and warnings that occur in included submodules or imported modules may be repeated if it is used more than once within the requested set of files to validate Page 11 Version 2 2 Yuma yangdump Manual The netconfd server will refuse to run if any of its core YANG modules contain any errors as reported by the yangdump parser The deviation p
20. value 20 gt lt xs maxInclusive value 30 gt lt xs restriction gt lt xs simpleType gt lt xs union gt lt xs simpleType gt lt xs element name a gt lt xs annotation gt lt xs appinfo gt lt ncx config gt true lt ncx config gt lt xs appinfo gt lt xs annotation gt lt xs complexType gt lt xS Sequence gt lt xs element name aa type aa type minOccurs 0 maxOccurs 5 gt lt xs annotation gt lt xs appinfo gt lt ncx ordered by gt system lt ncx ordered by gt lt xs appinfo gt lt xs annotation gt lt xs element gt lt xs element name a A minOccurs 0 maxOccurs unbounded abstract true gt XS Sequence gt lt xs complexType gt lt xs element gt lt xs element name b type xs string minOccurs 0 gt lt xs annotation gt lt xs appinfo gt lt ncx config gt true lt ncx config gt lt xs appinfo gt lt xs annotation gt lt xs element gt lt xs element name c minOccurs 0 maxOccurs unbounded gt lt xs annotation gt lt xs appinfo gt lt ncx config gt true lt ncx config gt lt ncx ordered by gt system lt ncx ordered by gt xs appinfo lt xs annotation gt xs complexType xs sequence Page 20 Version 2 2 Yuma yangdump Manual lt xs element name x type xs unsignedShort gt lt xs element name y type xs string minOccurs 0 gt lt xs element name __ c A_ minOccurs 0 maxOccurs unbounded abstract tru
21. Yuma yangdump Manual YANG Based Unified Modular Automation Tools YANG Module Compiler Version 2 2 Last Updated January 26 2012 Yuma yangdump Manual Table Of Contents Yuma yangdump Manual T PRE GAC TT 3 Led begal Stare nents eels OE ON DR A a 3 1 2 Additional ROSOULCOS s d cereo ot nor eoi NN veu NEK KU 3 1 2 E WEB SIS studeo ih A CoD e WA EN an An ecc 3 T 2 2 Maling D a cotto RN ec e uode UE PE A LA cA A EA E 4 1 3 Conventions Used in this Document 4 o MM P3 sea ma AAN BN E EEE 5 Fol V Tassel Tas DNA an NN IRR AEAEE 5 PAM A na SER LAN NN DARK na 6 21 2 Starting R Tas UI ts Hee Naa h AGE ALI EU ti D dud 8 2 1 3 Stoppi g YANG QUIM pao ss snenie pa s postu Ren ARA TERM NAN LADA rico 9 2 1 4 Configuration Parameter List aneka aa aa da 9 2 2 Validating TANGAN esa eee 11 2 2 1 Yangdump Validation Messages sees lad ee eek Ra eves 12 2 2 2 Validation Exa pl es esa san er AA au at PA ea na bM dud 12 2 3 Translating YANG to Other Formats esses nennen nnne nnne nennen nns 13 2 3 1 YIN PFOPtTialU sana at am ey ELO RU ae 14 2 2 HTML TEGFISIQEIDE Leela ta see ni xi baron Desa tae Maa A ERES 15 2 3 9 X5 D Translation e bete eee aenea bibe mie pede se tiendas ease E elec an Ba 18 2 34 SQL Translation Mina KE RN aa RA 21 2 3 5 SQL Documentation Database Translation sese eee 21 2 3 0 Canonical YANG Translatio suelo o RATRE st Fd ADS 21 2 3 7 Copy and Rename YANG Files eire reenn 22 2 3 8 Agent Instrum
22. a http equiv Content Type content text html charset UTF 8 gt lt meta name description content YANG data model documentation gt lt meta name generator content yangdump 0 9 7 473 http www netconfcentral org link rel stylesheet hrefz http netconfcentral org static css style css type text css gt lt head gt lt body gt hl class yang gt test4 yang lt h1 gt lt ul id nav gt lt li gt lt a href gt Typedefs lt a gt lt ul gt lt li gt lt a href aa type 10 gt aa type lt a gt lt li gt lt ul gt lt li gt lt li gt lt a href gt 0bjects lt a gt lt ul gt lt li class daddy gt lt a href a 15 gt a lt a gt lt ul gt Page 15 Version 2 2 Yuma yangdump Manual lt li gt lt a href aa 16 gt aa lt a gt lt li gt lt ul gt lt li gt lt li gt lt a href b 22 gt b lt a gt lt li gt lt li class daddy gt lt a href c 26 gt c lt a gt lt ul gt lt li gt lt a href x 28 gt x lt a gt lt li gt lt li gt lt a href y 29 gt y lt a gt lt li gt lt ul gt lt li gt lt ul gt lt li gt lt ul gt lt br gt lt div class yang gt lt p re gt lt span class yang_kw gt module lt span gt lt span class yang_id gt test4 lt span gt 1 lt span class yang_kw gt yang version lt span gt lt span class yang_str gt 1 lt span gt lt span class yang_kw gt namespace lt span gt lt span class yang_st
23. anslations should include the schemaLocation attribute Page 50 Version 2 2 Yuma yangdump Manual If present then the schemaLocation attribute will be generated during XSD translation This will be done for the module being processed and any modules that are imported into that module If not present the default then the schemaLocation attribute is not generated during XSD translation Relative URLs for include and import directives will be generated starting with the file name For example if this parameter is set to the following string http example com public The schemaLocation XSD for the module test3 version 10 19 2008 would be If versionnames false xsi schemaLocation http netconfcentral org ns test3 http example com public test3 xsd if versionnames true default xsi schemaLocation http netconfcentral org ns test3 http example com public test3 2008 10 19 xsd xsd schemaloc parameter Syntax string URL formal Default none Min Allowed 0 Max Allowed 1 Supported by yangdump Example yangdump xsd schemaloc http example com format xsd module test3 defnames true 3 42 yuma home The yuma home parameter specifies the project directory root to use when searching for files If present this directory location will override the YUMA_HOME environment variable if it is set If this parameter is set to a zero length string
24. arameter is used to specify any YANG module files that contain YANG deviation statements which may apply to any of the modules specified with the module or subtree parameters Modules parsed as deviation files are not validated Imported modules are not actually read and therefore not validated either A module can appear in the deviation list and the module or subtree module list The deviation statements will simply be processed separately from the other YANG statements found in the file If all the deviation statements for a module appear in the same module as the objects that are the target s of the deviations then the deviation parameter does not need to be used There is no way to specify the exact revision date associated with each file at this time The module search path needs to be configured such that the module search algorithms will find the appropriate versions This only applies if the revision date statement is not present in the import statement of course Otherwise only the specified revision date will be used or an error will be generated if the exact import file was not found A error is generated and the error count for the module is incremented if any violation of the YANG standard is detected A warning is generated and the warning count for the module is incremented if e any suspected misuse of the YANG standard is detected any YANG statements which have no affect are detected e any duplicate statem
25. ccessfully set up the software as described in the printed document Yuma Installation Guide Other documentation includes Yuma Quickstart Guide Yuma User Manual Yuma netconfd Manual Yuma yangcli Manual Yuma yangdiff Manual Yuma Developer Manual To obtain additional support you may join the yuma users group on sourceforge net and send email to this e mail address yuma users lists sourceforge net The SourceForge net Support Page for Yuma can be found at this WEB page http sourceforge net projects yuma support There are several sources of free information and tools for use with YANG and or NETCONF The following section lists the resources available at this time Netconf Central o http www netconfcentral org o Yuma Home Page Free information on NETCONF and YANG tutorials on line YANG module validation and documentation database Yuma SourceFource OpenSource Project o http sourceforge net projects yuma Page 3 Version 2 2 Yuma yangdump Manual Download Yuma source and binaries project forums and help Yang Central o http www yang central org o Free information and tutorials on YANG free YANG tools for download NETCONF Working Group Wiki Page o Bhttp trac tools ietf org wg netconf trac wiki o Free information on NETCONF standardization activities and NETCONF implementations NETCONF WG Status Page o http tools ietf org wg netconf o IETF Internet draft status for NETCONF documents
26. checks multiple refine statements within a uses statement for duplicate refinements to the same target node o checks multiple deviate statements within a deviation statement for duplicate alterations to the same target node o checks deep within all choice statements to make sure that no accessible object names conflict with sibling nodes that will appear in the value nodes within a NETCONF database e Verifies that all default statements are correct for the declared type o Only the static properties of the leafref and instance identifier built in data types can be validated at compile time e Verifies that all XPath expressions in must and when statements even those in groupings contain only valid XPath and reference valid data nodes e Verifies all when statements for a given cooked object even those inherited from uses and augment statements e Detects namespace statement conflicts across a set of modules e Detects prefix statement conflicts across a set of modules e Detects augment statement conflicts e Checks if any key leafs are more conditional than their parent node This can occur if any when or if feature statements apply to the key leaf but not to the parent e Detects unused typedefs and groupings e Checks line length and identifier length e Checks revision statements present and in correct order e Detects any top level mandatory configuration objects o leaf with mandatory statement set to true o choice w
27. e gt XS Sequence gt lt xs complexType gt lt xs key name c_Key gt lt xs selector xpath gt lt xs field xpath x gt lt xs key gt lt xs element gt lt xs schema gt SQL translation is reserved for future use The format sql enumeration is not supported yet SQL documentation database translation for the Netconf Central documentation database can be generated using the format sqldb parameter value Refer to the Yuma Developer Guide for more details Canonical YANG files can be generated by using the format yang parameter value In this translation mode all YANG constructs are generated in the same order with the same indentation The order used is the order defined in the YANG specification ABNF The order is somewhat arbitrary but the purpose of this translation mode is to generate consistent documentation Normally the order of top level statements within a module is preserved in the canonical YANG translation Only the sub statements within the top level statements may be reordered Child objects are never reordered just the sub statements within them Range statements will be converted to canonical form If there are contiguous range parts then they will be combined Example range statement range 1 10 11 12 20 Canonical form for this example range 1 20 If the unified parameter is set to true then all statements of a similar type will be grouped toge
28. entation H File Generation ee ee ee eee ee eee 22 2 3 9 Agent Instrumentation C File Generation ee ee ee eee 22 IIE Rere hee a H EA T 24 Sl CONTIG TTT 24 A ial bbb niet 24 Se e Le eT nie Lela 25 AA 25 AUS A A AA 26 3 6 featur e code detal ica deidad e guias 27 is A E 27 EE RAL An SAE NAN RAN UU TN Di 28 3 9 pa re Oa em 28 1O rteatiure enabl ed eta uae cese ertt eir ea SN AE SN ER BA 29 CUM o A TI 29 pA TOMA c 30 9 n 2 Te dit E Ee Up aon eade E du sens Eau Move dauerte 31 3 14 help mode sss ES 32 CN 9 SEM e TU 33 SO n EN Oa nana A A ka Ba Ran 33 S I ler ale E aan Ne NN ina 34 EO qiue RE 35 Page 1 Version 2 2 Yuma yangdump Manual E o A q Bana ena NN RR 35 E Ede e TTT 36 A A A 36 22 2 E aiee 16 M c ETE 37 A e hhh ROO E bima ae Sea 37 A na ele e Ls oT 38 BF eTel 38 3 20 FOUL alb d Rm 39 3 2 J AS NOW A bandit dica ue A A TRA 40 3128 SIS E ME 41 3 29 Pa E ES oec Na TEENETE RE EE UE NN Cus MEM Ne edu EON Cara 41 A are atta ina 44 A 619 MNT T E T E 44 3o 9d SS TODOS A A A a E 45 3 33 tree Center cit 46 S TT aT A RI A A A APN tetsu 46 E L TT a nle HEH 47 3r 3 E SUS La MER A SN 48 BD ZT e Le nia nn 49 A TTT 49 OS MO S A E T EEEE EA EE ET 49 SO War e E 50 gA see n nne 0G dai 50 A sss sese eee 51 Page 2 Version 2 2 Yuma yangdump Manual 1 Preface Copyright 2009 2012 Andy Bierman All Rights Reserved This document assumes you have su
29. ents which may conflict with previous statements are detected any violation of a YANG usage guideline is detected any statements which may cause operational conflicts due to duplicate values from another module is detected The module prefix or an augment statement which adds a node with the same name are examples of this type of operational conflict An informational message is generated if any potentially interesting conditions or abnormality is detected A debugging message is generated if available to track the internal behavior of the yangdump parser The default log level configuration parameter value is info It is strongly suggested that the log level not be set to off or error Instead set the log level to at least warning and use the warn idlen warn linelen and warn off configuration parameters to suppress or modify specific warning messages Generally a context specific error message is generated followed by a structured error message A context sensitive error message will begin Error A structured error message will begin with a line in the following format lt module gt lt line number gt lt column number gt error lt error number gt lt msg gt where module module or submodule name Page 12 Version 2 2 Yuma yangdump Manual The following example shows the error messages that are generated for the testloops yang file located in the modules test sub directory
30. er to force this parameter value to be treated as a path specification e g workfiles This parameter is ignored if the format parameter is missing output parameter Syntax string path or file specification Default none Min Allowed 0 Max Allowed 1 Supported by yangdump yangdiff Example yangdump output html files subtree testfiles format html 3 27 show errors The show errors parameter causes the yangdump program to list all the error and warning numbers and the default message for each one The 3 digit number followed by the message string will be printed 1 per line After this is done the yangdump program will exit This parameter can be combined with the help parameter The version parameter has no affect if this parameter is present The program version string will be printed in both cases The NETCONF error tag values are used directly when no other error number is appropriate These error numbers are as follows 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 Page 40 resource in use invalid value too big missing attribute bad attribute unknown attribute missing element bad element unknown element unknown namespace access denied lock denied resource denied rollback failed data exists Version 2 2 Yuma yangdump Manual 272 data missing 273 operation not supported 274 operation failed 275 partial o
31. erating SIL developer C files Parameter Description format c Generate combined User and Yuma SIL C file format uc Generate split User SIL C file Page 22 Version 2 2 Yuma yangdump Manual Parameter Description format yc Generate split Yuma SIL C file These parameter values are only relevant for Yuma server developers Refer to the Yuma Developer Guide for more details Page 23 Version 2 2 Yuma yangdump Manual 3 CLI Reference The yangdump program uses command line interface CLI parameters to control program behavior The following sections document all the Yuma CLI parameters relevant to this program in alphabetical order The config parameter specifies the name of a Yuma configuration file that contains more parameters to process in addition to the CLI parameters Refer to the Configuration Files section for details on the format of this file config parameter Syntax string complete file specification of the text file to parse for more parameters Default etc yuma lt program name gt conf Min Allowed 0 Max Allowed 1 Supported by netconfd yangcli yangdiff yangdump Example yangdump testmod config testconf conf The defnames parameter causes the program output file to be named with the default name for the format based on the input module name and revision date Refer to the section on generating WEB documentation for details on
32. gdump format c feature enable test featurel module test The feature enable default parameter controls how yangdump will generate C code for YANG features by default If true then by default features will be enabled If false then by default features will be disabled If a feature enable or feature disable parameter is present for a specific feature then this parameter will be ignored for that feature feature enable default parameter Max Allowed Syntax boolean true or false Default TRUE Min Allowed 0 1 Supported by Example yangcli yangdiff yangdump netconfd netconfd feature enable default false The feature static parameter controls how yangdump will generate static code for a specific feature Page 29 Version 2 2 Yuma yangdump Manual This parameter is a formatted string containing a module name followed by a colon followed by a feature name e g test featurel It is an error if a feature static and feature dynamic parameter specify the same feature Parameters for unknown features will be ignored feature static parameter Syntax formatted string module feature Default none Min Allowed 0 Max Allowed unlimited Supported by yangdump Example yangdump format c feature static test featurel module test 3 12 format The format parameter controls the type of yangdump conver
33. gram can be invoked several ways e To get the current version and exit yangdump version To get program help and exit yangdump help yangdump help brief yangdump help full The default parameter for the yangdump CLI is the module parameter If an unknown parameter is given and it could be a valid module parameter then it will be treated as an instance of this parameter e To validate a single YANG module named foo the following command lines are equivalent yangdump foo yangdump module foo To validate the test1 and test2 directory subtrees as an entire set of modules and save the output to mylogfile yangdump subtree testl subtree test2 logfile mylogfile e TO get all the configuration parameters from a text file named yangdump project1 conf yangdump config yangdump project1 conf To generate YANG HTML documentation files in the work directory with the default naming scheme for all the YANG modules in the test1 directory subtree yangdump subtree testl output work format html defnames true There is no interactive mode for yangdump so there is no need for a command to exit the program The Control C character sequence can be used to cancel the yangdump processing in progress However this will leave any partially completed output files in place Page 9 Version 2 2 Yuma yangdump Manual The following configuration parameters are used by yangdu
34. he details htmi div If true create a single lt div gt element that can be integrated into other WEB pages The default is false to create an entire WEB page lt html gt element html toc controls how or if a table of contents section is generated The default is to create a drop down menu type ToC which requires that Javascript is enabled in the browser e objview controls whether raw with uses augments refine and deviation statements or cooked final object tree without uses etc The default is the raw original view e simurls controls how URLs with parameter fragments are generated The default is false which is to use traditional encoded parameters e unified controls whether submodules are combined into the main module or if the include statements are left in place The default is false to treat each file separately and not expand any include statements e urlstart specifies the string that starts every generated URL in all A and HREF attributes There is no default for this parameter The following example shows the HTML that is generated for module test4 using default values for all HTML generation parameters lt DOCTYPE html PUBLIC W3C DTD XHTML 1 0 Strict EN http www w3 org TR xhtml1 DTD xhtml1 strict dtd gt html lang en xmlns http ww w3 org 1999 xhtml gt lt head gt lt title gt YANG Module test4 Version 2009 09 09 lt title gt lt met
35. ith mandatory statement set to true o non presence container with any mandatory descendants e Checks all refine statements for proper usage and checks that the resulting set of objects remains valid Multiple refine statements for the same target will be combined and checked as if there was only one refine statement for each target node e Checks all deviation statements for proper usage and checks that the resulting set of objects remains valid Multiple deviation statements for the same target will be combined and checked as if there was only one deviation statement for each target node The yangdump translator has the following features Page 7 Version 2 2 Yuma yangdump Manual e Full support for YANG string specification syntax o All double quoted string formatting rules o Preservation of single guoted string content o All forms of string concatenation o Unquoted string without any whitespace e Generates YIN syntax from the YANG token sequence o YIN format is the standard XML version of a YANG module Generates hyper linked HTML for a set of YANG modules o Rich set of configuration parameters to control HTML generation o Uses configurable and customizable Cascading Style Sheets CSS o Can generate full WEB page or single lt div gt for embedding in a WEB page o Can combine all sub modules into a single conceptual module o Objects tagged as ncx hidden will be ignored in the HTML output e Generates canonical YANG all sta
36. lowed 0 Max Allowed 1 Supported by yangdump Example yangdump html div true format html module test The html toc parameter controls how yangdump HTML translation will generate a table of contents for the HTML document If HTML translation is requested then this parameter will cause the output to contain a bullet list TOC a drop down menu TOC or none This option has no effect unless the format html parameter is also present The following values are supported none o No TOC is generated plain o A plain list based TOC is generated Page 33 Version 2 2 Yuma yangdump Manual menu o A suckerfish Javascript drop down menu will be generated o This is the default option Note that if the menu enumeration is used then the following javascript file must be available to the WEB server which is hosting the output HTML file http www netconfcentral org static javascript suckerfish js html toc parameter Syntax enumeration none plain menu Default menu Min Allowed 0 Max Allowed 1 Supported by yangdump Example yangdump html toc plain format html module test 3 17 identifiers The identifiers parameter causes information to be object identifier strings to be reported for the object RPC operation and notification definitions within the input module s The following information is reported for each identifier e object type e g leaf
37. may contain YANG files It must be a string value that represents a path specification of the directory subtree to use All of the YANG source modules contained in the specified directory sub tree will be processed Note that symbolic links are not followed during the directory traversal Only real directories will be searched and regular files will be checked as modules Processing will continue to the next file if a module contains errors If this string begins with a character then a username is expected to follow or a directory separator character If it begins with a character then an environment variable name is expected to follow If the subdirs false parameter is present then only the top level directory specified by this parameter will be searched for YANG files If the subdirs true parameter is present then all the directories contained within the one specified by this parameter will also be searched for YANG files The exceptions are Page 44 Version 2 2 Yuma yangdump Manual any directory beginning with a dot character such as svn any directory named CVS Examples some path gt lt my home dir gt some path fred some path gt lt fred home dir gt some path workdir some path gt lt workdir env var gt some path subtree parameter Syntax string path specification Default none Min Allowed 0 Max Allowed unlimited Supported by yangdiff yangdump Exa
38. me and revision date to be displayed for each module specified in the input Example output for module test modversion module test 2009 06 10 modversion parameter Syntax empty Default none Example yangdump modversion module test The objview parameter specifies how objects will be generated during translation for HTML and canonical YANG file translations The enumeration values are raw o output includes augment and uses clauses not the expanded results of those clauses cooked Page 38 Version 2 2 Yuma yangdump Manual o output does not include augment or uses clauses just the objects generated from those clauses The default mode is the raw view XSD output is always cooked since refined groupings and locally scoped definitions are not supported in XSD This parameter is not implemented for other values of the format parameter objview parameter Syntax enumeration raw cooked Default raw Min Allowed 0 Max Allowed 1 Supported by yangdump Example yangdump objview cooked module test format html 3 26 output The output parameter specifies where the output files generated by the program will be stored e The default is STDOUT if this parameter is not specified and the defnames parameter is set to false e If this parameter represents an existing directory then the defnames parameter will be set to t
39. mp Refer to the CLI Reference for more details Page 10 yangdump CLI Parameters parameter description config Specifies the configuration file to use for parameters datapath Sets the data file search path defnames Specifies if the default naming scheme is used for any output files dependencies Generate the module dependencies report deviation Species one or more YANG modules to load as deviations exports Generate the module exports report feature code default Specifies if a feature should use static or dynamic code by default feature disable Leaf list of features to disable feature dynamic feature enable Specifies a feature that uses dynamic code Specifies a feature that should be enabled feature enable default Specifies if a feature should be enabled or disabled by default feature static Specifies a feature that uses static code format Specifies the type of translation format that should be used for the output help Get context sensitive help then exit help mode Adjust the help output brief or full html div For HTML translation controls whether to generate a lt div gt element instead of a complete HTML document html toc For HTML translation controls the table of contents that is gnerated identifiers Generate the module object identifiers report indent Specifies
40. mple yangdump format html subtree testmods subtree workdir output yang html files 3 32 totals The totals parameter is used with the stats parameter to control how summary statistics are reported The stats parameter must be set to a value other than none for this parameter to have any affect The value of this parameter will control which statistics are reported Normally no summary is generated default is none The summary value will not have any affect unless there is more than one input module in the statistics collection e The summary only value will cause the module statistics reports to be skipped and only a summary of all the input modules will be displayed totals parameter Syntax enumeration none summary summary only Default none Min Allowed 0 Max Allowed 1 Supported by yangdump Page 45 Version 2 2 Yuma yangdump Manual Example yangdump stats basic totals summary only subtree my test modules The tree identifiers parameter causes information to be object identifier name strings to be reported for the object RPC operation and notification definitions within the input module s The following information is reported for each identifier object type e g leaf container rpc local name for the object indented for each descendant node Example report for module yuma mysession iden
41. nd options used are format xsd and module test4 lt xml version 1 0 encoding UTF 8 gt lt xs schema xmlns xs http www w3 org 2001 XMLSchema xmlns http netconfcentral org ns test4 targetNamespace http netconfcentral org ns test4 elementFormDefault qualified attributeFormDefault unqualified xml Lang en version 2009 09 09 xmlns ncx http netconfcentral org ncx xmlns nc urn ietf params xml ns netconf base 1 0 gt lt xs annotation gt lt xs documentation gt Converted from YANG file test4 yang by yangdump version 0 9 7 471 Module test4 Version 2009 09 09 lt xs documentation gt xs appinfo lt ncx source gt home andy swdev yuma trunk netconf modules test test4 yang lt ncx source gt xs appinfo xs appinfo ncx revision lt ncx version gt 2009 09 09 lt ncx version gt lt ncx description gt Initial revision lt ncx description gt lt ncx revision gt Page 19 Version 2 2 Yuma yangdump Manual lt xs appinfo gt lt xs annotation gt lt xs simpleType name aa type gt lt xs annotation gt lt xs documentation gt test type lt xs documentation gt lt xs annotation gt lt xs union gt lt xs simpleType gt lt xs restriction base xs int gt lt xs minInclusive value 1 gt lt xs maxInclusive value 10 gt lt xs restriction gt lt xs simpleType gt lt xs simpleType gt lt xs restriction base xs int gt lt xs minInclusive
42. options to generate code for Yuma applications The following format parameter values are allowing yangdumpcode but not yangdump format c Experimental o C file for server instrumentation library for a YANG module format h Experimental oH file for server instrumentation library for a YANG module format sqidb o SQL database contents for the Yuma WEB docs server for a YANG module Page 5 Version 2 2 Yuma yangdump Manual format tg2 TBD Not Supported o Turbogears 2 source code files for Yuma WEB applications for a YANG module The yangdump compiler has the following features e full support for all YANG language constructs e full support for YANG submodules e full support for YANG revisions and deviations across an arbitrary set of YANG files e validates the entire YANG source file even statements within unused objects e builds a complete internal representation of the cooked object tree including deviations to validate or output the exact data structures that result from a set of YANG files e Over 100 separate validation checks errors and warnings covering every type of programming mistake that can be made in a YANG file Some warnings are fully configurable and any warning can be suppressed e Can process any number specific modules and directory trees containing modules at once Any number of modules containing deviations can be specified and any target nodes in all modules affected will be properl
43. peration show errors parameter Default none Min Allowed 0 Max Allowed 1 Supported by yangdump Example yangdump show errors The simurls parameter specifies how URL strings are generated for HTML links If HTML translation is requested then setting this parameter to true will cause the format of URLs within links to be generated in simplified form for WEB development engines such as CherryPy which support this format Normal URL format false o http example com mymodule html parm1 foo amp parm2 bar frag Simplified URL format true o http example com mymodule foo bar frag simurls parameter Default FALSE Max Allowed 1 Example yangdump Simurls true format html module test The stats parameter is used to request a YANG usage statistics report See the totals parameter to control statistics totals reporting when used with this parameter Page 41 Version 2 2 Statistics are not normally collected This must be enabled by setting this parameter to a value other than none the default Any other value will cause statistics to be collected and reported after each input module is validated The verbosity of the statistics report is controlled with this parameter Each enumeration includes all the previous statistics from lower enumerations plus additional statistics The following table Yuma yangdump Manual describes the counters that are di
44. r gt http netconfcentral org ns test4 lt span gt lt span class yang_kw gt prefix lt span gt lt span class yang_str gt t4 lt span gt lt span class yang_kw gt revision lt span gt lt span class yang_str gt 2009 09 09 lt span gt lt span class yang_kw gt description lt span gt lt span class yang_str gt Initial revision lt span gt lt a name aa type 10 gt lt a gt lt span class yang_kw gt typedef lt span gt lt span class yang_id gt aa type lt span gt lt span class yang_kw gt type lt span gt lt span class yang_id gt int32 lt span gt lt span class yang_kw gt range lt span gt lt span class yang str gt 1 10 20 30 lt span gt lt span class yang_kw gt description lt span gt lt span class yang_str gt test type lt span gt lt a name a 15 gt lt a gt lt span class yang_kw gt container lt span gt lt span class yang_id gt a lt span gt lt span class yang_kw gt config lt span gt lt span class yang_str gt true lt span gt lt a name aa 16 gt lt a gt lt span class yang_kw gt leaf list lt span gt lt span class yang_id gt aa lt span gt lt span class yang_kw gt type lt span gt lt span class yang_id gt lt a href aa type 17 gt aa type lt a gt lt span gt lt span class yang_kw gt max elements lt span gt lt span class yang_str gt 5 lt span gt lt span class yang_kw gt ordered by lt
45. rings advanced The number of leaf and leaf list statements that used the string data type Binarys advanced The number of leaf and leaf list statements that used the binary data type Instance Identifiers advanced The number of leaf and leaf list statements that used the instance identifier data type Leafrefs advanced The number of leaf and leaf list statements that used the leafref data type Identityrefs advanced The number of leaf and leaf list statements that used the identityref data type Unions advanced The number of leaf and leaf list statements that used the union data type stats parameter Version 2 2 Yuma yangdump Manual Syntax enumeration none brief basic advanced all Default none Min Allowed 0 Max Allowed 1 Supported by yangdump Example yangdump stats advanced module test The subdirs parameter controls whether sub directories should be searched or not if they are found during a module search If false the file search paths for modules scripts and data files will not include sub directories if they exist in the specified path subdirs parameter Syntax boolean Default TRUE 0 1 Min Allowed Supported by yangdump Max Allowed Example yangdump subdirs false subtree testpath The subtree parameter is a leaf list of path specifications that
46. rue by default If this parameter represents a file name then the defnames parameter will be ignored and all translation output will be directed to the specified file e If this string begins with a character then a username is expected to follow or a directory separator character If it begins with a character then an environment variable name is expected to follow some path gt lt my home dir gt some path fred some path gt lt fred home dir gt some path workdir some path gt lt workdir env var gt some path If the target specified in this parameter does not exist o If there is only one file to be output then this parameter is used as the file name o If there are multiple files to be output then this parameter is used as a directory name A new directory will be created if it is needed e If the target specified in this parameter does exist o If there is only one file to be output If the existing target is also a file then the current file is over written Page 39 Version 2 2 Yuma yangdump Manual If the existing target is a directory then the output file will be created in this directory o If there are multiple files to be output If the existing target is a file then an error will be generated instead of the output files If the existing target is a directory then the output files will be created in the specified directory e Use a trailing path separator charact
47. sion desired if any Yuma SIL developers should refer to the make sil dir script to generate SIL code instead of using the yangdump command directly for code generation formats c h uc uh yc yh If this parameter is missing then no translation will be done but the module will be validated and any requested reports will be generated The following values are supported yin o Generate standard YIN format XML instance document xsd o XSD 1 0 translation o Data model XSD can be integrated with the with the NETCONF protocol XSD in RFC 4741 html o XHTML 1 0 translation yang o Canonical YANG translation copy o Copy with a new name in canonical module naming format sql o TBD Generate a module specific SQL template Page 30 Version 2 2 Yuma yangdump Manual o This option is reserved for future use sqldb o Generate module specific SQL data for the netconfcentral sql template h o Generate a module specific netconfd agent instrumentation combined SIL H file C o Generate a module specific netconfd agent instrumentation combined SIL C file uh o Generate a module specific netconfd agent instrumentation User SIL H file uc o Generate a module specific netconfd agent instrumentation User SIL C file yh o Generate a module specific netconfd agent instrumentation Yuma SIL H file yc o Generate a module specific netconfd agent instrumentation Yuma SIL C file format parameter
48. splayed at each minimum stats enumeration value Page 42 counter level description Complexity score brief Numeric score characterizing the level of implementation complexity for the module A higher number indicates a more complex module Total nodes brief The total number of object nodes data notification rpc in the module e The Config nodes Non config nodes should equal this counter The Mandatory nodes Optional nodes should equal this counter Extensions basic The number of extension statements Features basic The number of feature statements Groupings basic The number of exported groupings Typedefs basic The number of exported typedefs Deviations basic The number of deviation statements Top Data Nodes basic The number of top level data nodes Config nodes basic The number of configurable nodes Non config nodes basic The number of non configurable nodes Mandatory nodes advanced The number of mandatory nodes Optional nodes advanced The number of optional nodes Notifications advanced The number of notification statements Rpcs advanced The number of rpc statements Rpc inputs advanced The number of RPC input statements Rpc outputs advanced The number of rpc output statements Augments advanced The number of top level augment statements within data nodes not groupings Uses advanced The number of uses statements within data nodes not gro
49. tements in the same order etc o Combines refine and deviation statements for the same target o Combines range statement components into canonical form o Generates consistent configurable indentation for all statements o Objects tagged as ncx hidden will be ignored in the YANG output e Generates SQL statements for populating the netconf central database with quick lookup information about a set of YANG modules e Generates C source code stubs for netconfd server instrumentation libraries for dynamic loading of a YANG module e Generates informational reports on the contents of a YANG file o Imported modules dependencies o Exported symbols exports o Object name tree identifiers or tree identifiers o Module revision date modversion o YANG module metrics reports stats and totals The following features are not yet available but planned for a future release e naming conflicts report e preserve and translate YANG comments e preserve or reformat YANG string concatenation for objview cooked o YANG and HTML output will preserve original string token sequences for objview raw the default Most text string fields are preserved if format html or format yang The current working directory in use when yangdump is invoked is important It is most convenient to run yangdump from a work directory rather than the installation directory or within the module library Page 8 Version 2 2 Yuma yangdump Manual The yangdump pro
50. ters can be entered given in any order the deviation parameter will affect how objects are generated if objview cooked the output parameter is usually specified to cause the files to be copied to a different directory If this parameter is not present then the current directory will be used for generation of output files The default is either STDOUT or to the current directory if defnames is set to true the indent parameter can be used to specify the number of spaces to indent each new nest level The default value is 3 spaces the defnames parameter can be used to force the default naming scheme For many translation modes this parameter is the assumed default and cannot be changed Page 13 Version 2 2 Yuma yangdump Manual the urlstart parameter can be used to specify the string to start all URLs if URLs are generated in the output The standard YIN format can be generated with the format yin parameter value The YIN representation of a YANG module is an XML instance document consisting of a module or a lt submodule gt element The set of YANG prefixes used in the module will be used as the XML prefixes available in the document These namespace attributes are added to the top level element for the module prefix and any imported modules The following example shows the XML instance document that is generated for module test4 and format yin lt xml version 1 0 encoding UTF 8 gt
51. ther from all sub modules included by the main module The ncx hidden extension will cause objects containing this extension to be omitted during translation Page 21 Version 2 2 Yuma yangdump Manual Comments are not preserved at this time This will be addressed in a future release Exact copies of a YANG file can be copied to another directory and renamed to the default naming scheme using the format copy parameter value Only YANG files that have no errors will be copied If the validation phase produces a non zero error count then the file will not be copied and renamed The defnames parameter is set to true in this mode The default YANG file names will be created for each input file Example file foo yang module foo namespace http example com ns foo prefix foo header skipped revision 2009 02 03 description Initial version Example renamed file if output workdir If versionnames true o workdir foo 2009 02 03 yang If versionnames false o workdir foo yang There are 3 different parameters for generating SIL developer H files Parameter Description format h Generate combined User and Yuma SIL H file format uh Generate split User SIL H file format yh Generate split Yuma SIL H file These parameter values are only relevant for Yuma server developers Refer to the Yuma Developer Guide for more details There are 3 different parameters for gen
52. tifiers rpc get my session container output leaf indent leaf linesize leaf with defaults container input rpc set my session container input leaf indent leaf linesize leaf with defaults container output tree identifiers parameter Syntax Default Min Allowed Max Allowed Supported by yangdump Example yangdump tree identifiers module yuma mysession The unified parameter indicates if submodules should be combined into the main module for yangdump translation output Any include statements will be replaced by the module definitions contained within the submodule If set to true then submodules will be processed within the main module in a unified report instead of separately one report for each file Page 46 Version 2 2 Yuma yangdump Manual For translation purposes this parameter will cause any sub modules to be treated as if they were defined in the main module Actual definitions will be generated instead of an include statement for each submodule If this mode is selected then submodules will be ignored e f entered with the module parameter explicitly e f found when searching for main YANG files to process in a directory e g for the subtree parameter If set to false then a separate output file is generated for each input file so that XSD output and other reports for a main module will not include information for submodules unified parameter
53. tions e extensions features exports parameter Syntax empty Default none Min Allowed Page 26 Version 2 2 Yuma yangdump Manual Max Allowed 1 Supported by yangdump Example yangdump exports module test3 The feature code default parameter controls how yangdump will generate C code for YANG features by default If dynamic then by default features can be loaded at run time and objects with if feature statements will be available in case the feature is enabled If static then by default features are set at compile time and any disabled objects will be removed at load time If a feature dynamic or feature static parameter is present for a specific feature then this parameter will be ignored for that feature feature code default parameter Syntax enum dynamic or static Default Min Allowed 0 Max Allowed 1 Example yangdump format c feature code default static module test The feature disable parameter directs all programs to disable a specific feature This parameter is a formatted string containing a module name followed by a colon followed by a feature name e g test featurel It is an error if a feature enable and feature disable parameter specify the same feature Parameters for unknown features will be ignored feature disable parameter Syntax formatted string module feature Page 27
54. upings Choices advanced The number of choice statements Cases advanced The number of case statements This includes implied cases which contain a single data node Anyxmls advanced The number of anyxml statements NP containers advanced The number of non presence containers Version 2 2 Page 43 Yuma yangdump Manual counter level description P containers advanced The number of presence containers Lists advanced The number of list statements Leaf lists advanced The number of leaf list statements Key leafs advanced The number of leaf statements which are defined within a list to be a key Plain leafs advanced The number of plain leaf statements Imports all The number of import statements Integral numbers advanced The number of leaf and leaf list statements that used a numeric data type other than decimal64 Decimal64s advanced The number of leaf and leaf list statements that used the decimal64 data type Enumerations advanced The number of leaf and leaf list statements that used the enumeration data type Bits advanced The number of leaf and leaf list statements that used the bits data type Booleans advanced The number of leaf and leaf list statements that used the boolean data type Emptys advanced The number of leaf and leaf list statements that used the empty data type St
55. y patched e Ignores CVS and subversion directories if encountered in directory searches Attempts to find all errors and warnings possible in the file instead of stopping on the first error e Verifies that all YANG statement syntax is correct according to the specification e Verifies that all YANG typedef statements are correct o The entire typedef chain is checked until a built in data type is reached o Checks valid combined refinements to named types and built in types o Check for valid range statements o Check for valid pattern statements o Verify the path statement is correct for leafref type statements o Verify the default statement is valid e Compile time loop detection o import statement loops o include statement loops o belongs to statement references self o typedef type statement references self o derived type statement loops o path statement loops for leafref objects o base statement loops for identity statements o feature name reference loops for if feature statements o uses statement loop in groupings e Compile time duplicate detection Page 6 Version 2 2 Yuma yangdump Manual o import statements o include statements o must statements o jf feature statements o unique statements o local typedef of grouping name collision o verifies that the correct number of instances appear for every YANG sub statement o duplicate sibling node names due to uses or augment statement expansion o
56. yang_cmt gt list c lt span gt lt span class yang_cmt gt module test4 lt span gt lt pre gt lt div gt lt body gt lt html gt The following picture shows how this WEB page looks in Firefox 3 0 on Ubuntu Page 17 Version 2 2 Yuma yangdump Manual test4 yang Typedefs Objects module test4 1 yang version 1 namespace http netconfcentral com ns test4 prefix t4 revision 2009 09 09 description Initial revision typedef aa type type int32 range 1 10 20 30 description test type container a config true leaf list aa type aa type max elements 5 ordered by system container a leaf b type leafref path a aa config true List key x config true ordered by system leaf x type uintl6 leaf y type instance identifier list c module test4 XSD 1 0 files can be generated by using the formatzxsd parameter value XSD format may be deprecated in a future release because the official YANG translation format is DSDL The XSD translation of a YANG file will contain an XSD representation of the cooked objects in the module The top level typedefs and objects will be translated Local typedefs and groupings extensions identities and other YANG constructs are not translated at this time The xsd schemaloc parameter can be used to specify the schemaLocation attribute value
Download Pdf Manuals
Related Search