yumaworks YANG Modules

example-fan.yang

This module defines an example module for use with the ypshow library, described in the YumaPro yp-show API Guide.

  • Source Document: None

  • GitHub File: example-fan.yang

  • YANG Tree:

    module: example-fan
    
      augment /yp:show/yp:input/yp:showtype:
        +--:(fan)
        |  +-- fan            union
        |  +-- diagnostics?   empty
        +--:(version)
           +-- version?       empty
    
      rpcs:
        +---x example-cmd
           +---w input
              +---w parm1?   string
              +---w parm2?   int32
    
  • History:

    • Initial release train: 16.10

netconfd-pro.yang

This module defines the CLI parameters used by netconfd-pro.

There are no NETCONF writable parameters in this module. The sysNetconfServerCLI object in the yuma-system.yang module contains a copy of the parameters that were passed to the server.

There are no SIL callbacks for this module. The CLI handling code is in agt/agt_cli.c.

The CLI parameters defined in this module can also be used in the netconfd-pro.conf configuration file loaded by the server at boot-time. The configuration file handling code is in ncx/conf.c.

  • Source Document: None

  • GitHub File: netconfd-pro.yang

  • YANG Tree:

    module: netconfd-pro
    
      structure netconfd-pro:
        +-- help?                           empty
        +-- (help-mode)?
        |  +--:(brief)
        |  |  +-- brief?                    empty
        |  +--:(normal)
        |  |  +-- normal?                   empty
        |  +--:(full)
        |     +-- full?                     empty
        +-- indent?                         yt:IndentType
        +-- log?                            string
        +-- log-append?                     empty
        +-- log-level?                      yt:NcDebugType
        +-- modpath?                        yt:NcPathList
        +-- version?                        empty
        +-- warn-error?                     boolean
        +-- warn-idlen?                     uint32
        +-- warn-linelen?                   uint32
        +-- warn-off*                       uint32
        +-- warn-up*                        uint32
        +-- (config-choice)?
        |  +--:(config)
        |  |  +-- config?                   string
        |  +--:(no-config)
        |     +-- no-config?                empty
        +-- feature-enable-default?         boolean
        +-- feature-enable*                 yt:FeatureSpec
        +-- feature-disable*                yt:FeatureSpec
        +-- binary-display-maxlen?          uint32
        +-- errmsg*                         string
        +-- errmsg-lang?                    string
        +-- home?                           string
        +-- log-backtrace?                  uint32
        +-- log-backtrace-detail?           empty
        +-- log-backtrace-level?            bits
        +-- log-backtrace-stream?           bits
        +-- log-header?                     bits
        +-- log-mirroring?                  empty
        +-- log-console?                    empty
        +-- log-stderr?                     empty
        +-- log-suppress-ctrl?              empty
        +-- log-syslog?                     empty
        +-- log-syslog-level?               yt:NcDebugType
        +-- log-highres-datetime?           boolean
        +-- log-vendor?                     empty
        +-- log-vendor-level?               yt:NcDebugType
        +-- message-indent?                 int8
        +-- yumapro-home?                   string
        +-- loadpath?                       yt:NcPathList
        +-- subdirs?                        boolean
        +-- tcp-connect-timeout?            uint16
        +-- protocols?                      bits
        +-- runpath?                        yt:NcPathList
        +-- match-names?                    ywt:NameMatchMode
        +-- alt-names?                      ywt:AltNameMode
        +-- wildcard-keys?                  boolean
        +-- access-control?                 ywt:access-control-mode
        +-- allow-list-delete-all?          boolean
        +-- allow-leaflist-delete-all?      boolean
        +-- allowed-user*                   nt:NcxName
        +-- (audit-log-choice)?
        |  +--:(audit-log)
        |  |  +-- audit-log?                string
        |  +--:(no-audit-log)
        |     +-- no-audit-log?             empty
        +-- audit-log-append?               empty
        +-- audit-log-candidate?            boolean
        +-- audit-log-console-level?        nt:NcDebugType
        +-- audit-log-events?               bits
        +-- audit-log-level?                nt:NcDebugType
        +-- autodelete-pdu-error?           boolean
        +-- bundle*                         nt:NcxName
        +-- callhome-reconnect?             boolean
        +-- callhome-retry-interval?        uint16
        +-- callhome-retry-max?             uint16
        +-- callhome-server*                string
        +-- callhome-sshd-command?          string
        +-- callhome-sshd-config?           string
        +-- callhome-subsys-command?        string
        +-- callhome-tls-server*            string
        +-- cert-default-user?              string
        +-- cert-usermap*                   string
        +-- confdir?                        string
        +-- convert-subtree-filter?         boolean
        x-- create-empty-npcontainers?      boolean
        x-- create-empty-npcontainers-ro?   boolean
        +-- db-lock-retry-interval?         uint32
        +-- db-lock-timeout?                uint32
        +-- default-style?                  enumeration
        o-- delete-empty-npcontainers?      boolean
        +-- eventlog-size?                  uint32
        +-- event-stream*                   ywt:NcxNumName
        +-- event-stream-map*               string
        +-- fileloc-fhs?                    boolean
        +-- ha-enabled?                     boolean
        +-- ha-initial-active?              nt:NcxName
        +-- ha-port?                        inet:port-number
        +-- ha-server*                      string
        +-- ha-server-key?                  string
        +-- ha-sil-standby?                 boolean
        +-- hello-timeout?                  uint32
        +-- hide-module*                    nt:NcxName
        +-- highres-event-time?             boolean
        +-- idle-timeout?                   uint32
        +-- import-version-bestmatch?       boolean
        +-- insecure-ok?                    boolean
        +-- library-mode?                   boolean
        +-- max-burst?                      uint32
        +-- max-getbulk?                    uint32
        +-- max-lock-hold-time?             uint16
        +-- max-sessions?                   uint16
        +-- max-cli-sessions?               uint16
        +-- max-user-sessions?              uint16
        +-- max-per-user-sessions*          string
        +-- max-strlen?                     int32
        +-- module-tagmap*                  string
        +-- netconf-capability*             inet:uri
        +-- netconf-tls-address?            inet:ip-address
        +-- netconf-tls-certificate?        string
        +-- netconf-tls-key?                string
        +-- netconf-tls-port?               inet:port-number
        +-- netconf-tls-trust-store?        string
        +-- no-log?                         empty
        +-- no-nvstore?                     empty
        +-- port*                           inet:port-number
        +-- module*                         yt:NcModuleSpec
        +-- deviation*                      yt:NcModuleSpec
        +-- annotation*                     yt:NcModuleSpec
        +-- datapath?                       yt:NcPathList
        +-- push-max-operational?           uint32
        +-- push-max-periodic?              uint32
        +-- push-min-dampening?             uint16
        +-- push-min-period?                uint16
        +-- push-simop-enabled?             boolean
        +-- push-simop-patch-update?        boolean
        +-- push-simop-period?              uint16
        +-- remove-schema-aug-leafs?        boolean
        +-- restconf-capability*            inet:uri
        +-- restconf-default-encoding?      enumeration
        +-- restconf-strict-headers?        boolean
        +-- return-empty-npcontainers?      boolean
        +-- return-status?                  boolean
        +-- running-error?                  enumeration
        +-- save-owners?                    boolean
        +-- sil-cc-callback-all?            boolean
        +-- sil-delete-children-first?      boolean
        +-- sil-invoke-for-defaults?        boolean
        +-- sil-missing-error?              boolean
        +-- sil-prio-reverse-for-deletes?   boolean
        +-- sil-root-check-first?           boolean
        +-- sil-skip-load?                  empty
        +-- sil-test-get-when?              boolean
        +-- sil-validate-candidate?         boolean
        +-- simple-json-names?              boolean
        +-- sm-config?                      string
        +-- sm-config-encoding?             enumeration
        +-- snmp-agent-role?                enumeration
        +-- snmp-subagent-priority?         uint16
        +-- socket-address?                 inet:ip-address
        +-- socket-port?                    inet:port-number
        +-- socket-type?                    enumeration
        +-- (start)?
        |  +--:(no-startup)
        |  |  +-- no-startup?               empty
        |  +--:(factory-startup)
        |  |  +-- factory-startup?          empty
        |  +--:(startup)
        |     +-- startup?                  string
        +-- startup-error?                  enumeration
        +-- startup-factory-file?           string
        +-- startup-prune-ok?               boolean
        +-- startup-skip-validation?        boolean
        +-- subsys-timeout?                 uint16
        +-- superuser*                      union
        +-- system-notifications?           bits
        +-- system-sort-type?               enumeration
        +-- system-sorted?                  boolean
        +-- target?                         enumeration
        +-- tls-crl-missing-ok?             boolean
        +-- tls-crl-mode?                   enumeration
        +-- tls-cipherlist?                 string
        +-- tls-debug?                      boolean
        +-- tls-deprecated-ok?              boolean
        +-- trim-whitespace?                boolean
        +-- log-event-drops?                boolean
        +-- log-pthread-level?              nt:NcDebugType
        x-- session-sync-mutex?             empty
        +-- server-id?                      nt:NcxName
        +-- server-root?                    nt:NcxName
        +-- usexmlorder?                    empty
        +-- user-parm?                      string
        +-- (watcher-parm)?
        |  +--:(no-watcher)
        |  |  +-- no-watcher?               empty
        |  +--:(watcher-interval)
        |     +-- watcher-interval?         uint32
        +-- wait-datastore-ready?           boolean
        +-- with-error-number?              boolean
        +-- with-maintenance-mode?          boolean
        +-- with-notifications?             boolean
        +-- with-db-lock?                   boolean
        +-- with-callhome?                  boolean
        +-- with-canonical?                 boolean
        +-- with-config-id?                 boolean
        +-- with-grpc?                      boolean
        +-- with-gnmi?                      boolean
        +-- with-modtags?                   boolean
        +-- with-nmda?                      boolean
        +-- with-ocpattern?                 boolean
        +-- with-schema-mount?              boolean
        +-- with-startup?                   boolean
        +-- with-term-msg?                  boolean
        +-- with-url?                       boolean
        +-- with-url-ftp?                   boolean
        +-- with-url-tftp?                  boolean
        +-- with-validate?                  boolean
        +-- with-netconf?                   boolean
        +-- with-netconf-tls?               boolean
        +-- with-restconf?                  boolean
        +-- with-rollback-on-error?         boolean
        +-- with-snmp?                      boolean
        +-- with-support-save?              boolean
        +-- with-warnings?                  boolean
        x-- with-yang-api?                  boolean
        +-- with-yang11-hello?              boolean
        +-- with-yang-patch-running?        boolean
        +-- with-yang-cbor?                 boolean
        +-- with-yp-coap?                   boolean
        +-- with-yp-coap-dtls?              boolean
        +-- with-yp-shell?                  boolean
        +-- with-yuma-system?               boolean
        +-- with-yuma-time-filter?          boolean
        +-- with-yumaworks-config-change?   boolean
        +-- with-yumaworks-event-filter?    boolean
        +-- with-yumaworks-getbulk?         boolean
        +-- with-yumaworks-lock?            boolean
        +-- with-yumaworks-callhome?        boolean
        +-- with-yumaworks-event-stream?    boolean
        +-- with-yumaworks-ids?             boolean
        +-- with-yumaworks-sm-yanglib?      boolean
        +-- with-yumaworks-system?          boolean
        +-- with-yumaworks-templates?       boolean
        +-- yang-sid-mode?                  ywt:yang-sid-mode
        +-- with-yumaworks-cert-usermap?    boolean
        +-- yangapi-server-url?             inet:uri
        +-- yp-coap-address?                inet:ip-address
        +-- yp-coap-port?                   inet:port-number
        +-- yp-coap-dtls-port?              inet:port-number
        +-- restconf-server-url?            inet:uri
    
  • History:

    • Initial release train: 12.09

xrd.yang

This module defines an "XRD" structure which is used by RESTCONF as internal data. This is an internal module used for processing HTTP requests.

  • Source Document: None

  • GitHub File: xrd.yang

  • YANG Tree: None

  • History:

    • Initial release train: 16.10

yang-attributes.yang

This module defines laef objects representing the YANG insert attributes used in <edit-config> operations. This is an internal module used for processing NETCONF requests.

  • Source Document: None

  • GitHub File: yang-attributes.yang

  • YANG Tree:

    module: yang-attributes
      +--rw insert?   enumeration
      +--rw key?      string
      +--rw value?    string
    
      rpcs:
        +---x action
    
  • History:

    • Initial release train: 13.04

yang-data-ext.yang

This module contains the “augment-yang-data” YANG extension. It is fully supported and used to augment data structures defined with the “yang-data” extension. The file ncx/yang_data.c contains the internal callback functions for this module.

Note

This module is deprecated. The ietf-yang-structure-ext.yang module should be used instead.

  • Source Document: None

  • GitHub File: yang-data-ext.yang

  • YANG Tree: None

  • History:

    • Initial release train: 17.10

    • Deprecated release train: 21.10

yangcli-pro.yang

This module contains the CLI parameters and commands for the yangcli-pro program. The yp-shell program also uses this module for its CLI parameters. This module is not used in the server.

  • Source Document: None

  • GitHub File: yangcli-pro.yang

  • YANG Tree:

    module: yangcli-pro
      +--rw vars
      |  +--rw var* [name]
      |     +--rw name       nt:NcxName
      |     +--rw target?    string
      |     +--rw vartype?   YangcliVariableType
      |     +--rw value?     <anyxml>
      +--rw do?              string
      +--rw no?              string
      +--rw apply?           empty
      +--rw gotop?           empty
      +--rw return?          empty
      +--rw config-commit?   empty
      +--rw xml?             string
      +--rw json?            string
    
      rpcs:
        +---x action
        |  +---w input
        |     +---w (from)
        |     |  +--:(varref)
        |     |  |  +---w varref?                string
        |     |  +--:(from-cli)
        |     |     +---w (target-parm)?
        |     |     |  +--:(target)
        |     |     |  |  +---w target           yang:xpath1.0
        |     |     |  +--:(urltarget-case)
        |     |     |     +---w urltarget        ywt:UrlPath
        |     |     |     +---w match-names?     ywt:NameMatchMode
        |     |     |     +---w alt-names?       ywt:AltNameMode
        |     |     |     +---w wildcard-keys?   boolean
        |     |     +---w optional?              empty
        |     |     +---w value?                 <anyxml>
        |     +---w timeout?                     nt:Timeout
        +---x alias
        |  +---w input
        |     +---w var?   string
        +---x aliases
        |  +---w input
        |     +---w (alias-action)?
        |        +--:(show)
        |        |  +---w show?    empty
        |        +--:(clear)
        |        |  +---w clear?   empty
        |        +--:(load)
        |        |  +---w load?    string
        |        +--:(save)
        |           +---w save?    string
        +---x auto-test
        |  +---w input
        |     +---w target          string
        |     +---w session-name?   nt:NcxIdentifier
        |     +---w iterations?     uint32
        +---x cache
        |  +---w input
        |     +---w (cache-input)
        |        +--:(clear)
        |        |  +---w clear?      empty
        |        +--:(delete-cache)
        |           +---w delete      nt:NcxIdentifier
        |           +---w revision?   nt:Date
        +---x cd
        |  +---w input
        |     +---w dir    string
        +---x clear
        +---x config
        |  +---w input
        |     +---w (config-source)?
        |        +--:(term)
        |           +---w term?   empty
        +---x connect
        |  +---w input
        |     +---w user                 nt:NcxUserName
        |     +---w server               inet:host
        |     +---w (pass)
        |     |  +--:(password)
        |     |  |  +---w password?      string
        |     |  +--:(no-password)
        |     |     +---w no-password?   empty
        |     +---w ncport?              uint16
        |     +---w timeout?             nt:Timeout
        |     +---w public-key?          string
        |     +---w private-key?         string
        |     +---w ssl-fallback-ok?     boolean
        |     +---w ssl-certificate?     string
        |     +---w ssl-key?             string
        |     +---w ssl-trust-store?     string
        |     +---w protocols?           bits
        |     +---w entry-point?         string
        |     +---w transport?           ywt:transport-type
        |     +---w encoding?            ywt:encoding-type
        |     +---w session-name?        nt:NcxIdentifier
        +---x create
        |  +---w input
        |     +---w (from)
        |     |  +--:(varref)
        |     |  |  +---w varref?                string
        |     |  +--:(from-cli)
        |     |     +---w (target-parm)?
        |     |     |  +--:(target)
        |     |     |  |  +---w target           yang:xpath1.0
        |     |     |  +--:(urltarget-case)
        |     |     |     +---w urltarget        ywt:UrlPath
        |     |     |     +---w match-names?     ywt:NameMatchMode
        |     |     |     +---w alt-names?       ywt:AltNameMode
        |     |     |     +---w wildcard-keys?   boolean
        |     |     +---w optional?              empty
        |     |     +---w value?                 <anyxml>
        |     +---w timeout?                     nt:Timeout
        +---x delete
        |  +---w input
        |     +---w (delete-target)
        |     |  +--:(target)
        |     |  |  +---w target?      string
        |     |  +--:(urltarget)
        |     |     +---w urltarget?   ywt:UrlPath
        |     +---w value?             <anyxml>
        +---x delete-all
        |  +---w input
        |     +---w (delete-target)
        |        +--:(target)
        |        |  +---w target?      string
        |        +--:(urltarget)
        |           +---w urltarget?   ywt:UrlPath
        +---x elif
        |  +---w input
        |     +---w expr       yang:xpath1.0
        |     +---w docroot?   <anyxml>
        +---x else
        +---x enable
        |  +---w input
        |     +---w (pass)?
        |        +--:(password)
        |        |  +---w password?      string
        |        +--:(no-password)
        |           +---w no-password?   empty
        +---x enable-password
        |  +---w input
        |     +---w password    string
        +---x end
        +---x eval
        |  +---w input
        |  |  +---w expr       yang:xpath1.0
        |  |  +---w docroot?   <anyxml>
        |  +--ro output
        |     +--ro data    <anyxml>
        +---x eventlog
        |  +---w input
        |     +---w (eventlog-action)?
        |        +--:(show-case)
        |        |  +---w show?           LogCount
        |        |  +---w start?          LogIndex
        |        |  +---w (help-mode)?
        |        |     +--:(brief)
        |        |     |  +---w brief?    empty
        |        |     +--:(normal)
        |        |     |  +---w normal?   empty
        |        |     +--:(full)
        |        |        +---w full?     empty
        |        +--:(clear)
        |           +---w clear?          LogCount
        +---x exit
        +---x fill
        |  +---w input
        |  |  +---w (target-parm)?
        |  |  |  +--:(target)
        |  |  |  |  +---w target           yang:xpath1.0
        |  |  |  +--:(urltarget-case)
        |  |  |     +---w urltarget        ywt:UrlPath
        |  |  |     +---w match-names?     ywt:NameMatchMode
        |  |  |     +---w alt-names?       ywt:AltNameMode
        |  |  |     +---w wildcard-keys?   boolean
        |  |  +---w optional?              empty
        |  |  +---w value?                 <anyxml>
        |  +--ro output
        |     +--ro data?   <anyxml>
        +---x get-locks
        |  +---w input
        |     +---w lock-timeout?     nt:Timeout
        |     +---w retry-interval?   uint32
        |     +---w cleanup?          boolean
        +---x get-walk
        |  +---w input
        |     +---w datastore?       enumeration
        |     +---w list-target      string
        |     +---w count?           uint32
        |     +---w content?         enumeration
        |     +---w depth?           union
        |     +---w with-defaults?   with-defaults-mode
        |     +---w list-test?       yang:xpath1.0
        |     +---w fixed-keys?      <anydata>
        +---x group
        |  +---w input
        |     +---w (groupcmd)
        |     |  +--:(connect)
        |     |  |  +---w connect?              nt:NcxIdentifier
        |     |  |  +---w missing-ok?           boolean
        |     |  |  +---w missing-connect-ok?   boolean
        |     |  |  +---w lost-ok?              boolean
        |     |  |  +---w reconnect-tries?      uint32
        |     |  |  +---w reconnect-interval?   uint32
        |     |  +--:(create-case)
        |     |  |  +---w create?               nt:NcxIdentifier
        |     |  +--:(delete-case)
        |     |  |  +---w delete?               nt:NcxIdentifier
        |     |  +--:(add-case)
        |     |  |  +---w add?                  nt:NcxIdentifier
        |     |  +--:(remove-case)
        |     |  |  +---w remove?               nt:NcxIdentifier
        |     |  +--:(show-case)
        |     |  |  +---w show?                 nt:NcxIdentifier
        |     |  +--:(list-case)
        |     |     +---w list?                 empty
        |     +---w session*                    nt:NcxIdentifier
        +---x help
        |  +---w input
        |     +---w (helptype)?
        |     |  +--:(command)
        |     |  |  +---w command?        nt:NcxIdentifier
        |     |  +--:(commands)
        |     |  |  +---w commands?       empty
        |     |  +--:(notification)
        |     |  |  +---w notification?   nt:NcxIdentifier
        |     |  +--:(object)
        |     |  |  +---w object?         union
        |     |  +--:(type)
        |     |     +---w type?           nt:NcxIdentifier
        |     +---w (help-mode)?
        |        +--:(brief)
        |        |  +---w brief?          empty
        |        +--:(normal)
        |        |  +---w normal?         empty
        |        +--:(full)
        |           +---w full?           empty
        +---x history
        |  +---w input
        |     +---w (history-action)?
        |        +--:(show-case)
        |        |  +---w show?           LogCount
        |        |  +---w (help-mode)?
        |        |     +--:(brief)
        |        |     |  +---w brief?    empty
        |        |     +--:(normal)
        |        |     |  +---w normal?   empty
        |        |     +--:(full)
        |        |        +---w full?     empty
        |        +--:(clear)
        |        |  +---w clear?          empty
        |        +--:(load)
        |        |  +---w load?           string
        |        +--:(save)
        |           +---w save?           string
        +---x if
        |  +---w input
        |     +---w expr       yang:xpath1.0
        |     +---w docroot?   <anyxml>
        +---x insert
        |  +---w input
        |     +---w (from)
        |     |  +--:(varref)
        |     |  |  +---w varref?                string
        |     |  +--:(from-cli)
        |     |     +---w (target-parm)?
        |     |     |  +--:(target)
        |     |     |  |  +---w target           yang:xpath1.0
        |     |     |  +--:(urltarget-case)
        |     |     |     +---w urltarget        ywt:UrlPath
        |     |     |     +---w match-names?     ywt:NameMatchMode
        |     |     |     +---w alt-names?       ywt:AltNameMode
        |     |     |     +---w wildcard-keys?   boolean
        |     |     +---w optional?              empty
        |     |     +---w value?                 <anyxml>
        |     +---w timeout?                     nt:Timeout
        |     +---w order?                       enumeration
        |     +---w operation?                   enumeration
        |     +---w edit-target?                 string
        +---x list
        |  +---w input
        |     +---w (listtype)
        |     |  +--:(commands)
        |     |  |  +---w commands?   empty
        |     |  +--:(files)
        |     |  |  +---w files?      empty
        |     |  +--:(objects)
        |     |  |  +---w objects?    empty
        |     |  +--:(oids)
        |     |  |  +---w oids?       empty
        |     |  +--:(modules)
        |     |  |  +---w modules?    empty
        |     |  +--:(scripts)
        |     |     +---w scripts?    empty
        |     +---w module?           nt:NcxIdentifier
        |     +---w (help-mode)?
        |        +--:(brief)
        |        |  +---w brief?      empty
        |        +--:(normal)
        |        |  +---w normal?     empty
        |        +--:(full)
        |           +---w full?       empty
        +---x log-debug
        |  +---w input
        |     +---w msg    string
        +---x log-info
        |  +---w input
        |     +---w msg    string
        +---x log-error
        |  +---w input
        |     +---w msg    string
        +---x log-warn
        |  +---w input
        |     +---w msg    string
        +---x merge
        |  +---w input
        |     +---w (from)
        |     |  +--:(varref)
        |     |  |  +---w varref?                string
        |     |  +--:(from-cli)
        |     |     +---w (target-parm)?
        |     |     |  +--:(target)
        |     |     |  |  +---w target           yang:xpath1.0
        |     |     |  +--:(urltarget-case)
        |     |     |     +---w urltarget        ywt:UrlPath
        |     |     |     +---w match-names?     ywt:NameMatchMode
        |     |     |     +---w alt-names?       ywt:AltNameMode
        |     |     |     +---w wildcard-keys?   boolean
        |     |     +---w optional?              empty
        |     |     +---w value?                 <anyxml>
        |     +---w timeout?                     nt:Timeout
        +---x mgrload
        |  +---w input
        |     +---w module       nt:NcxName
        |     +---w revision?    nt:Date
        |     +---w deviation*   yt:NcModuleSpec
        +---x pwd
        +---x nvsave
        +---x quit
        +---x rawrpc
        |  +---w input
        |     +---w rpc    <anydata>
        +---x recall
        |  +---w input
        |     +---w index    LogIndex
        +---x refresh-library
        +---x release-locks
        +---x replace
        |  +---w input
        |     +---w (from)
        |     |  +--:(varref)
        |     |  |  +---w varref?                string
        |     |  +--:(from-cli)
        |     |     +---w (target-parm)?
        |     |     |  +--:(target)
        |     |     |  |  +---w target           yang:xpath1.0
        |     |     |  +--:(urltarget-case)
        |     |     |     +---w urltarget        ywt:UrlPath
        |     |     |     +---w match-names?     ywt:NameMatchMode
        |     |     |     +---w alt-names?       ywt:AltNameMode
        |     |     |     +---w wildcard-keys?   boolean
        |     |     +---w optional?              empty
        |     |     +---w value?                 <anyxml>
        |     +---w timeout?                     nt:Timeout
        +---x remove
        |  +---w input
        |     +---w target    string
        |     +---w value?    <anyxml>
        +---x remove-all
        |  +---w input
        |     +---w (delete-target)
        |        +--:(target)
        |        |  +---w target?      string
        |        +--:(urltarget)
        |           +---w urltarget?   ywt:UrlPath
        +---x run
        |  +---w input
        |     +---w script    string
        |     +---w P1?       string
        |     +---w P2?       string
        |     +---w P3?       string
        |     +---w P4?       string
        |     +---w P5?       string
        |     +---w P6?       string
        |     +---w P7?       string
        |     +---w P8?       string
        |     +---w P9?       string
        +---x run-shell
        |  +---w input
        |     +---w script    string
        |     +---w P1?       string
        |     +---w P2?       string
        |     +---w P3?       string
        |     +---w P4?       string
        |     +---w P5?       string
        |     +---w P6?       string
        |     +---w P7?       string
        |     +---w P8?       string
        |     +---w P9?       string
        +---x save
        +---x sleep
        |  +---w input
        |     +---w seconds    uint16
        +---x device-cfg
        |  +---w input
        |     +---w (device-action)?
        |        +--:(show-case)
        |        |  +---w show?           IdentifierOrZero
        |        |  +---w (help-mode)?
        |        |     +--:(brief)
        |        |     |  +---w brief?    empty
        |        |     +--:(normal)
        |        |     |  +---w normal?   empty
        |        |     +--:(full)
        |        |        +---w full?     empty
        |        +--:(delete)
        |        |  +---w delete?         nt:NcxIdentifier
        |        +--:(save)
        |        |  +---w save?           nt:NcxIdentifier
        |        +--:(create)
        |           +---w create          nt:NcxName
        |           +---w server          inet:host
        |           +---w ncport?         uint16
        |           +---w entry-point?    string
        |           +---w protocols?      bits
        +---x devices-cfg
        |  +---w input
        |     +---w (devices-action)?
        |        +--:(show-case)
        |        |  +---w show?           empty
        |        |  +---w (help-mode)?
        |        |     +--:(brief)
        |        |     |  +---w brief?    empty
        |        |     +--:(normal)
        |        |     |  +---w normal?   empty
        |        |     +--:(full)
        |        |        +---w full?     empty
        |        +--:(clear)
        |        |  +---w clear?          empty
        |        +--:(load)
        |        |  +---w load?           string
        |        +--:(save)
        |           +---w save?           string
        +---x session
        |  +---w input
        |     +---w set-current    nt:NcxIdentifier
        +---x session-cfg
        |  +---w input
        |     +---w (session-action)?
        |        +--:(show-case)
        |        |  +---w show?                IdentifierOrZero
        |        |  +---w (help-mode)?
        |        |     +--:(brief)
        |        |     |  +---w brief?         empty
        |        |     +--:(normal)
        |        |     |  +---w normal?        empty
        |        |     +--:(full)
        |        |        +---w full?          empty
        |        +--:(delete)
        |        |  +---w delete?              nt:NcxIdentifier
        |        +--:(save)
        |        |  +---w save?                nt:NcxIdentifier
        |        +--:(use-event-handler)
        |           +---w use-event-handler*   nt:NcxIdentifier
        +---x user-cfg
        |  +---w input
        |     +---w (user-action)?
        |        +--:(show-case)
        |        |  +---w show?           IdentifierOrZero
        |        |  +---w (help-mode)?
        |        |     +--:(brief)
        |        |     |  +---w brief?    empty
        |        |     +--:(normal)
        |        |     |  +---w normal?   empty
        |        |     +--:(full)
        |        |        +---w full?     empty
        |        +--:(delete)
        |        |  +---w delete?         nt:NcxIdentifier
        |        +--:(save)
        |        |  +---w save?           nt:NcxIdentifier
        |        +--:(create)
        |           +---w create          nt:NcxName
        |           +---w user-name       nt:NcxName
        |           +---w password        string
        +---x users-cfg
        |  +---w input
        |     +---w (users-action)?
        |        +--:(show-case)
        |        |  +---w show?           empty
        |        |  +---w (help-mode)?
        |        |     +--:(brief)
        |        |     |  +---w brief?    empty
        |        |     +--:(normal)
        |        |     |  +---w normal?   empty
        |        |     +--:(full)
        |        |        +---w full?     empty
        |        +--:(clear)
        |        |  +---w clear?          empty
        |        +--:(load)
        |        |  +---w load?           string
        |        +--:(save)
        |           +---w save?           string
        +---x schema-server-cfg
        |  +---w input
        |     +---w (schema-server-action)?
        |        +--:(show-case)
        |        |  +---w show?           IdentifierOrZero
        |        |  +---w (help-mode)?
        |        |     +--:(brief)
        |        |     |  +---w brief?    empty
        |        |     +--:(normal)
        |        |     |  +---w normal?   empty
        |        |     +--:(full)
        |        |        +---w full?     empty
        |        +--:(delete)
        |        |  +---w delete?         nt:NcxIdentifier
        |        +--:(create)
        |           +---w create          nt:NcxName
        |           +---w user-id         nt:NcxName
        |           +---w device-id?      nt:NcxName
        +---x schema-servers-cfg
        |  +---w input
        |     +---w (schema-servers-action)?
        |        +--:(show-case)
        |        |  +---w show?           empty
        |        |  +---w (help-mode)?
        |        |     +--:(brief)
        |        |     |  +---w brief?    empty
        |        |     +--:(normal)
        |        |     |  +---w normal?   empty
        |        |     +--:(full)
        |        |        +---w full?     empty
        |        +--:(clear)
        |        |  +---w clear?          empty
        |        +--:(load)
        |        |  +---w load?           string
        |        +--:(save)
        |           +---w save?           string
        +---x sessions-cfg
        |  +---w input
        |     +---w (sessions-action)?
        |        +--:(show-case)
        |        |  +---w show?           empty
        |        |  +---w (help-mode)?
        |        |     +--:(brief)
        |        |     |  +---w brief?    empty
        |        |     +--:(normal)
        |        |     |  +---w normal?   empty
        |        |     +--:(full)
        |        |        +---w full?     empty
        |        +--:(clear)
        |        |  +---w clear?          empty
        |        +--:(load)
        |        |  +---w load?           string
        |        +--:(save)
        |           +---w save?           string
        +---x sget
        |  +---w input
        |  |  +---w (from)
        |  |  |  +--:(varref)
        |  |  |  |  +---w varref?                string
        |  |  |  +--:(from-cli)
        |  |  |     +---w (target-parm)?
        |  |  |     |  +--:(target)
        |  |  |     |  |  +---w target           yang:xpath1.0
        |  |  |     |  +--:(urltarget-case)
        |  |  |     |     +---w urltarget        ywt:UrlPath
        |  |  |     |     +---w match-names?     ywt:NameMatchMode
        |  |  |     |     +---w alt-names?       ywt:AltNameMode
        |  |  |     |     +---w wildcard-keys?   boolean
        |  |  |     +---w optional?              empty
        |  |  |     +---w value?                 <anyxml>
        |  |  +---w nofill?                      empty
        |  |  +---w with-defaults?               CliWithDefaultsType
        |  |  +---w depth?                       union
        |  |  +---w module-tag*                  string
        |  +--ro output
        |     +--ro data?   <anyxml>
        +---x sget-config
        |  +---w input
        |  |  +---w (from)
        |  |  |  +--:(varref)
        |  |  |  |  +---w varref?                string
        |  |  |  +--:(from-cli)
        |  |  |     +---w (target-parm)?
        |  |  |     |  +--:(target)
        |  |  |     |  |  +---w target           yang:xpath1.0
        |  |  |     |  +--:(urltarget-case)
        |  |  |     |     +---w urltarget        ywt:UrlPath
        |  |  |     |     +---w match-names?     ywt:NameMatchMode
        |  |  |     |     +---w alt-names?       ywt:AltNameMode
        |  |  |     |     +---w wildcard-keys?   boolean
        |  |  |     +---w optional?              empty
        |  |  |     +---w value?                 <anyxml>
        |  |  +---w nofill?                      empty
        |  |  +---w with-defaults?               CliWithDefaultsType
        |  |  +---w depth?                       union
        |  |  +---w module-tag*                  string
        |  |  +---w source
        |  |     +---w (config-source)
        |  |        +--:(candidate)
        |  |        |  +---w candidate?   empty {nc:candidate}?
        |  |        +--:(running)
        |  |        |  +---w running?     empty
        |  |        +--:(startup)
        |  |        |  +---w startup?     empty {nc:startup}?
        |  |        +--:(url)
        |  |           +---w url?         nc:ConfigURIType {nc:url}?
        |  +--ro output
        |     +--ro data?   <anyxml>
        +---x sget-data
        |  +---w input
        |  |  +---w datastore?                     enumeration
        |  |  +---w (from)
        |  |  |  +--:(varref)
        |  |  |  |  +---w varref?                  string
        |  |  |  +--:(from-cli)
        |  |  |     +---w (target-parm)?
        |  |  |     |  +--:(target)
        |  |  |     |  |  +---w target             yang:xpath1.0
        |  |  |     |  +--:(urltarget-case)
        |  |  |     |     +---w urltarget          ywt:UrlPath
        |  |  |     |     +---w match-names?       ywt:NameMatchMode
        |  |  |     |     +---w alt-names?         ywt:AltNameMode
        |  |  |     |     +---w wildcard-keys?     boolean
        |  |  |     +---w optional?                empty
        |  |  |     +---w value?                   <anyxml>
        |  |  +---w nofill?                        empty
        |  |  +---w with-defaults?                 CliWithDefaultsType
        |  |  +---w depth?                         union
        |  |  +---w module-tag*                    string
        |  |  +---w config-filter?                 boolean
        |  |  +---w (origin-filters)?
        |  |  |  +--:(origin-filter)
        |  |  |  |  +---w origin-filter*           or:origin-ref
        |  |  |  +--:(negated-origin-filter)
        |  |  |     +---w negated-origin-filter*   or:origin-ref
        |  |  +---w with-origin?                   empty
        |  +--ro output
        |     +--ro data?   <anyxml>
        +---x show
        |  +---w input
        |     +---w (showtype)
        |     |  +--:(cache)
        |     |  |  +---w cache?                empty
        |     |  +--:(cli)
        |     |  |  +---w cli?                  empty
        |     |  +--:(diff)
        |     |  |  +---w diff?                 empty
        |     |  +--:(edit)
        |     |  |  +---w edit?                 empty
        |     |  +--:(connected)
        |     |  |  +---w connected?            empty
        |     |  +--:(module)
        |     |  |  +---w module?               nt:NcxIdentifier
        |     |  +--:(modules)
        |     |  |  +---w modules?              empty
        |     |  +--:(modules-state)
        |     |  |  +---w modules-state?        empty
        |     |  +--:(local)
        |     |  |  +---w local?                nt:NcxName
        |     |  +--:(locals)
        |     |  |  +---w locals?               empty
        |     |  +--:(global)
        |     |  |  +---w global?               nt:NcxName
        |     |  +--:(globals)
        |     |  |  +---w globals?              empty
        |     |  +--:(group-vars)
        |     |  |  +---w group-vars?           IdentifierOrZero
        |     |  +--:(objects)
        |     |  |  +---w objects?              empty
        |     |  +--:(running)
        |     |  |  +---w running               empty
        |     |  |  +---w select?               string
        |     |  +--:(search-path-module)
        |     |  |  +---w search-path-module?   empty
        |     |  +--:(server-commands)
        |     |  |  +---w server-commands?      empty
        |     |  +--:(session)
        |     |  |  +---w session?              empty
        |     |  +--:(session-vars)
        |     |  |  +---w session-vars?         IdentifierOrZero
        |     |  +--:(system)
        |     |  |  +---w system?               empty
        |     |  +--:(terminal)
        |     |  |  +---w terminal?             empty
        |     |  +--:(var)
        |     |  |  +---w var?                  nt:NcxName
        |     |  +--:(vars)
        |     |  |  +---w vars?                 empty
        |     |  +--:(version)
        |     |     +---w version?              empty
        |     +---w (help-mode)?
        |        +--:(brief)
        |        |  +---w brief?                empty
        |        +--:(normal)
        |        |  +---w normal?               empty
        |        +--:(full)
        |           +---w full?                 empty
        +---x start-rpc-timing
        |  +---w input
        |     +---w statfile?   string
        +---x start-session
        |  +---w input
        |     +---w name?   nt:NcxIdentifier
        +---x start-timer
        |  +---w input
        |     +---w id?           TimerId
        |     +---w restart-ok?   boolean
        +---x stop-rpc-timing
        +---x stop-session
        |  +---w input
        |     +---w name    nt:NcxIdentifier
        +---x stop-timer
        |  +---w input
        |  |  +---w id?     TimerId
        |  |  +---w echo?   boolean
        |  +--ro output
        |     +--ro delta?   decimal64
        +---x record-test
        |  +---w input
        |     +---w (record-test-action)
        |        +--:(cancel)
        |        |  +---w cancel?       empty
        |        +--:(start-case)
        |        |  +---w start?        empty
        |        |  +---w suite-name    nt:NcxIdentifier
        |        |  +---w test-name     nt:NcxIdentifier
        |        +--:(finish)
        |        |  +---w finish?       empty
        |        +--:(pause)
        |        |  +---w pause?        empty
        |        +--:(resume)
        |           +---w resume?       empty
        +---x terminal
        |  +---w input
        |     +---w length    uint16
        +---x test-suite
        |  +---w input
        |     +---w suite-name?           nt:NcxIdentifier
        |     +---w log?                  string
        |     +---w (test-suite-action)?
        |        +--:(delete)
        |        |  +---w delete?         empty
        |        +--:(delete-test-case)
        |        |  +---w delete-test?    empty
        |        |  +---w test-name       nt:NcxIdentifier
        |        +--:(show-case)
        |        |  +---w show?           IdentifierOrZero
        |        |  +---w (help-mode)?
        |        |     +--:(brief)
        |        |     |  +---w brief?    empty
        |        |     +--:(normal)
        |        |     |  +---w normal?   empty
        |        |     +--:(full)
        |        |        +---w full?     empty
        |        +--:(load)
        |        |  +---w load?           string
        |        +--:(run-all)
        |        |  +---w run-all?        empty
        |        +--:(start)
        |        |  +---w start?          nt:NcxIdentifier
        |        +--:(save)
        |        |  +---w save?           string
        |        +--:(export-case)
        |           +---w export?         empty
        |           +---w export-file?    string
        +---x update-config
        +---x unset
        |  +---w input
        |     +---w name    nt:NcxName
        +---x uservars
        |  +---w input
        |     +---w (uservars-action)
        |        +--:(clear)
        |        |  +---w clear?   empty
        |        +--:(load)
        |        |  +---w load?    string
        |        +--:(save)
        |           +---w save?    string
        +---x while
        |  +---w input
        |     +---w expr        yang:xpath1.0
        |     +---w docroot?    <anyxml>
        |     +---w maxloops?   uint32
        +---x xget
        |  +---w input
        |  |  +---w (from)
        |  |  |  +--:(varref)
        |  |  |  |  +---w varref?      string
        |  |  |  +--:(select)
        |  |  |  |  +---w select?      string
        |  |  |  +--:(urltarget)
        |  |  |     +---w urltarget?   ywt:UrlPath
        |  |  +---w timeout?           nt:Timeout
        |  |  +---w with-defaults?     CliWithDefaultsType
        |  |  +---w depth?             union
        |  |  +---w module-tag*        string
        |  |  +---w match-names?       ywt:NameMatchMode
        |  |  +---w alt-names?         ywt:AltNameMode
        |  |  +---w wildcard-keys?     boolean
        |  +--ro output
        |     +--ro data?   <anyxml>
        +---x xget-config
        |  +---w input
        |  |  +---w (from)
        |  |  |  +--:(varref)
        |  |  |  |  +---w varref?      string
        |  |  |  +--:(select)
        |  |  |  |  +---w select?      string
        |  |  |  +--:(urltarget)
        |  |  |     +---w urltarget?   ywt:UrlPath
        |  |  +---w timeout?           nt:Timeout
        |  |  +---w with-defaults?     CliWithDefaultsType
        |  |  +---w depth?             union
        |  |  +---w module-tag*        string
        |  |  +---w match-names?       ywt:NameMatchMode
        |  |  +---w alt-names?         ywt:AltNameMode
        |  |  +---w wildcard-keys?     boolean
        |  |  +---w source
        |  |     +---w (config-source)
        |  |        +--:(candidate)
        |  |        |  +---w candidate?   empty {nc:candidate}?
        |  |        +--:(running)
        |  |        |  +---w running?     empty
        |  |        +--:(startup)
        |  |        |  +---w startup?     empty {nc:startup}?
        |  |        +--:(url)
        |  |           +---w url?         nc:ConfigURIType {nc:url}?
        |  +--ro output
        |     +--ro data?   <anyxml>
        +---x xget-data
        |  +---w input
        |  |  +---w datastore?                     enumeration
        |  |  +---w (from)
        |  |  |  +--:(varref)
        |  |  |  |  +---w varref?                  string
        |  |  |  +--:(select)
        |  |  |  |  +---w select?                  string
        |  |  |  +--:(urltarget)
        |  |  |     +---w urltarget?               ywt:UrlPath
        |  |  +---w timeout?                       nt:Timeout
        |  |  +---w with-defaults?                 CliWithDefaultsType
        |  |  +---w depth?                         union
        |  |  +---w module-tag*                    string
        |  |  +---w match-names?                   ywt:NameMatchMode
        |  |  +---w alt-names?                     ywt:AltNameMode
        |  |  +---w wildcard-keys?                 boolean
        |  |  +---w config-filter?                 boolean
        |  |  +---w (origin-filters)?
        |  |  |  +--:(origin-filter)
        |  |  |  |  +---w origin-filter*           or:origin-ref
        |  |  |  +--:(negated-origin-filter)
        |  |  |     +---w negated-origin-filter*   or:origin-ref
        |  |  +---w with-origin?                   empty
        |  +--ro output
        |     +--ro data?   <anyxml>
        +---x event-handlers-cfg
        |  +---w input
        |     +---w (event-handlers-action)?
        |        +--:(show-case)
        |        |  +---w show?           empty
        |        |  +---w (help-mode)?
        |        |     +--:(brief)
        |        |     |  +---w brief?    empty
        |        |     +--:(normal)
        |        |     |  +---w normal?   empty
        |        |     +--:(full)
        |        |        +---w full?     empty
        |        +--:(clear)
        |        |  +---w clear?          empty
        |        +--:(load)
        |        |  +---w load?           string
        |        +--:(save)
        |           +---w save?           string
        +---x event-handler-cfg
           +---w input
              +---w (user-action)?
                 +--:(show-case)
                 |  +---w show?                 IdentifierOrZero
                 |  +---w (help-mode)?
                 |     +--:(brief)
                 |     |  +---w brief?          empty
                 |     +--:(normal)
                 |     |  +---w normal?         empty
                 |     +--:(full)
                 |        +---w full?           empty
                 +--:(delete)
                 |  +---w delete?               nt:NcxIdentifier
                 +--:(save)
                 |  +---w save?                 nt:NcxIdentifier
                 +--:(create)
                    +---w create                nt:NcxName
                    +---w module-name?          nt:NcxName
                    +---w event-name?           nt:NcxName
                    +---w (script-type)
                       +--:(script)
                       |  +---w script?         string
                       +--:(shell-script)
                          +---w shell-script?   string
    
      structure yangcli-pro:
        +-- help?                        empty
        +-- (help-mode)?
        |  +--:(brief)
        |  |  +-- brief?                 empty
        |  +--:(normal)
        |  |  +-- normal?                empty
        |  +--:(full)
        |     +-- full?                  empty
        +-- indent?                      yt:IndentType
        +-- log?                         string
        +-- log-append?                  empty
        +-- log-level?                   yt:NcDebugType
        +-- modpath?                     yt:NcPathList
        +-- version?                     empty
        +-- warn-error?                  boolean
        +-- warn-idlen?                  uint32
        +-- warn-linelen?                uint32
        +-- warn-off*                    uint32
        +-- warn-up*                     uint32
        +-- (config-choice)?
        |  +--:(config)
        |  |  +-- config?                string
        |  +--:(no-config)
        |     +-- no-config?             empty
        +-- log-backtrace?               uint32
        +-- log-backtrace-detail?        empty
        +-- log-backtrace-level?         bits
        +-- log-backtrace-stream?        bits
        +-- log-header?                  bits
        +-- log-mirroring?               empty
        +-- log-console?                 empty
        +-- log-stderr?                  empty
        +-- log-suppress-ctrl?           empty
        +-- log-syslog?                  empty
        +-- log-syslog-level?            yt:NcDebugType
        +-- log-highres-datetime?        boolean
        +-- message-indent?              int8
        +-- yumapro-home?                string
        +-- use-data-templates?          boolean
        +-- ignore-missing-vars?         boolean
        +-- use-session-vars?            boolean
        +-- save-session-vars?           boolean
        +-- tcp-connect-timeout?         uint16
        +-- feature-enable-default?      boolean
        +-- feature-enable*              yt:FeatureSpec
        +-- feature-disable*             yt:FeatureSpec
        +-- subdirs?                     boolean
        +-- home?                        string
        +-- user?                        nt:NcxUserName
        +-- server?                      inet:host
        +-- (pass)?
        |  +--:(password)
        |  |  +-- password?              string
        |  +--:(no-password)
        |     +-- no-password?           empty
        +-- ncport?                      uint16
        +-- timeout?                     nt:Timeout
        +-- public-key?                  string
        +-- private-key?                 string
        +-- ssl-fallback-ok?             boolean
        +-- ssl-certificate?             string
        +-- ssl-key?                     string
        +-- ssl-trust-store?             string
        +-- protocols?                   bits
        +-- entry-point?                 string
        +-- transport?                   ywt:transport-type
        +-- encoding?                    ywt:encoding-type
        +-- with-ocpattern?              boolean
        +-- binary-display-maxlen?       uint32
        +-- match-names?                 ywt:NameMatchMode
        +-- alt-names?                   ywt:AltNameMode
        +-- wildcard-keys?               boolean
        +-- with-term-msg?               boolean
        +-- ask-password?                boolean
        +-- aliases-file?                string
        +-- allow-shell?                 boolean
        +-- autocomp?                    boolean
        +-- autoconfig?                  boolean
        +-- autoconfig-conf-mode?        boolean
        +-- autoaliases?                 boolean
        +-- autoload?                    boolean
        +-- autoload-get?                boolean
        +-- autoload-cache?              boolean
        +-- autoload-save-cache?         boolean
        +-- auto-discard-changes?        boolean
        +-- auto-keepalive?              boolean
        +-- auto-reconnect?              boolean
        +-- auto-reconnect-interval?     uint16
        +-- auto-reconnect-max?          uint16
        +-- autodevices?                 boolean
        +-- autohistory?                 boolean
        +-- autonotif?                   boolean
        +-- autonvsave?                  boolean
        +-- autoschemaservers?           boolean
        +-- autosessions?                boolean
        +-- autotest?                    boolean
        +-- autousers?                   boolean
        +-- autoeventhandlers?           boolean
        +-- autouservars?                boolean
        +-- bad-data?                    enumeration
        +-- batch-mode?                  empty
        +-- break-key-mode?              enumeration
        +-- callhome-address?            inet:ip-address
        +-- callhome-enabled?            boolean
        +-- callhome-port?               inet:port-number
        +-- callhome-tls-port?           inet:port-number
        +-- callhome-user*               nt:NcxUserName
        +-- check-output?                boolean
        +-- check-output-error?          boolean
        +-- check-replies?               boolean
        +-- check-replies-error?         boolean
        +-- config-edit-mode?            config-edit-mode-type
        +-- config-commit-mode?          boolean
        +-- config-autosave?             boolean
        +-- with-enable-mode?            boolean
        +-- default-module?              nt:NcxName
        +-- disable-command*             nt:NcxIdentifier
        +-- display-mode?                enumeration
        +-- echo-notif-loglevel?         nt:NcDebugType
        +-- echo-notifs?                 boolean
        +-- echo-replies?                boolean
        +-- fixorder?                    boolean
        +-- force-target?                enumeration
        +-- module*                      yt:NcModuleSpec
        +-- deviation*                   yt:NcModuleSpec
        +-- datapath?                    yt:NcPathList
        +-- runpath?                     yt:NcPathList
        +-- handle-bad-reply?            enumeration
        +-- help-width?                  uint16
        +-- history-file?                string
        +-- insecure-ok?                 boolean
        +-- keepalive-interval?          uint32
        +-- no-aliases?                  empty
        +-- fill-optional?               boolean
        +-- optional?                    boolean
        +-- prompt?                      string
        +-- prompt-name?                 string
        +-- prompt-type?                 ywt:show-mode
        +-- restrict-edit-mode?          boolean
        +-- (run-startup-mode)?
        |  +--:(run-script)
        |  |  +-- run-script?            string
        |  +--:(run-command)
        |     +-- run-command?           string
        +-- script-input?                boolean
        +-- server-commands?             boolean
        +-- shell-command?               string
        +-- term-length?                 uint16
        +-- test-suite-file?             string
        +-- time-rpcs?                   boolean
        +-- time-rpcs-stats?             boolean
        +-- time-rpcs-stats-file?        string
        +-- uservars-file?               string
        +-- use-rawxml?                  boolean
        +-- use-traceid?                 boolean
        +-- use-xmlheader?               boolean
        +-- with-notif-commands?         boolean
        +-- yangmap*                     string
        +-- leaflist-multi-line?         boolean
        +-- zmqapi-gateway-id?           nt:NcxName
        +-- zmqapi-responder-endpoint?   string
        +-- zmqapi-publisher-endpoint?   string
      structure saved-devices:
        +-- device* [name]
           +-- name           nt:NcxName
           +-- devicetype?    string
           +-- server         inet:host
           +-- ncport?        uint16
           +-- entry-point?   string
           +-- protocols?     bits
           +-- transport?     ywt:transport-type
           +-- comment?       string
      structure saved-sessions:
        +-- session* [name]
        |  +-- name                 nt:NcxName
        |  +-- use-event-handler*   nt:NcxIdentifier
        |  +-- device               nt:NcxDeviceName
        |  +-- userid               nt:NcxName
        |  +-- user                 nt:NcxName
        |  +-- (pass)
        |  |  +--:(password)
        |  |  |  +-- password?      string
        |  |  +--:(no-password)
        |  |     +-- no-password?   empty
        |  +-- public-key?          string
        |  +-- private-key?         string
        |  +-- ssl-fallback-ok?     boolean
        |  +-- ssl-certificate?     string
        |  +-- ssl-key?             string
        |  +-- ssl-trust-store?     string
        |  +-- server               inet:host
        |  +-- ncport?              uint16
        |  +-- entry-point?         string
        |  +-- protocols?           bits
        |  +-- transport?           ywt:transport-type
        |  +-- start-commands
        |  +-- vars
        |  |  +-- var* [name]
        |  |     +-- name       nt:NcxName
        |  |     +-- target?    string
        |  |     +-- vartype?   YangcliVariableType
        |  |     +-- value?     <anyxml>
        |  +-- comment?             string
        +-- group* [name]
           +-- name                  nt:NcxName
           +-- session*              nt:NcxName
           +-- missing-ok?           boolean
           +-- missing-connect-ok?   boolean
           +-- lost-ok?              boolean
           +-- reconnect-tries?      uint32
           +-- reconnect-interval?   uint32
           +-- vars
              +-- var* [name]
                 +-- name       nt:NcxName
                 +-- target?    string
                 +-- vartype?   YangcliVariableType
                 +-- value?     <anyxml>
      structure saved-schema-servers:
        +-- schema-server-id* [name]
           +-- name         nt:NcxName
           +-- user-id?     nt:NcxName
           +-- device-id?   nt:NcxName
      structure saved-event-handlers:
        +-- eventid* [name]
           +-- name            nt:NcxName
           +-- module-name     nt:NcxName
           +-- event-name      nt:NcxName
           +-- script?         string
           +-- shell-script?   string
      structure saved-users:
        +-- userid* [name]
           +-- name                 nt:NcxName
           +-- user                 nt:NcxName
           +-- (pass)
           |  +--:(password)
           |  |  +-- password?      string
           |  +--:(no-password)
           |     +-- no-password?   empty
           +-- public-key?          string
           +-- private-key?         string
           +-- ssl-fallback-ok?     boolean
           +-- ssl-certificate?     string
           +-- ssl-key?             string
           +-- ssl-trust-store?     string
           +-- comment?             string
      structure pipe:
        +-- begin?      string
        +-- include*    string
        +-- exclude*    string
        +-- redirect?   string
        +-- display?    enumeration
    
  • History:

    • Initial release train: 12.09

yangdiff-pro.yang

This module contains the CLI parameters for the yangdiff-pro program. This module is not used in the server.

  • Source Document: None

  • GitHub File: yangdiff-pro.yang

  • YANG Tree:

    module: yangdiff-pro
    
      structure yangdiff-pro:
        +-- help?              empty
        +-- (help-mode)?
        |  +--:(brief)
        |  |  +-- brief?       empty
        |  +--:(normal)
        |  |  +-- normal?      empty
        |  +--:(full)
        |     +-- full?        empty
        +-- indent?            yt:IndentType
        +-- log?               string
        +-- log-append?        empty
        +-- log-level?         yt:NcDebugType
        +-- modpath?           yt:NcPathList
        +-- version?           empty
        +-- warn-error?        boolean
        +-- warn-idlen?        uint32
        +-- warn-linelen?      uint32
        +-- warn-off*          uint32
        +-- warn-up*           uint32
        +-- (config-choice)?
        |  +--:(config)
        |  |  +-- config?      string
        |  +--:(no-config)
        |     +-- no-config?   empty
        +-- yumapro-home?      string
        +-- old?               nt:NcModuleSpec
        +-- new?               nt:NcModuleSpec
        +-- difftype?          DiffType
        +-- output?            string
        +-- header?            boolean
        +-- home?              string
        +-- subdirs?           boolean
    
  • History:

    • Initial release train: 12.09

yangdump-pro.yang

This module contains the CLI parameters for the yangdump-pro and yangdump-sdk program. This module is not used in the server.

  • Source Document: None

  • GitHub File: yangdump-pro.yang

  • YANG Tree:

    module: yangdump-pro
    
      structure yangdump-pro:
        +-- help?                     empty
        +-- (help-mode)?
        |  +--:(brief)
        |  |  +-- brief?              empty
        |  +--:(normal)
        |  |  +-- normal?             empty
        |  +--:(full)
        |     +-- full?               empty
        +-- indent?                   yt:IndentType
        +-- log?                      string
        +-- log-append?               empty
        +-- log-level?                yt:NcDebugType
        +-- modpath?                  yt:NcPathList
        +-- version?                  empty
        +-- warn-error?               boolean
        +-- warn-idlen?               uint32
        +-- warn-linelen?             uint32
        +-- warn-off*                 uint32
        +-- warn-up*                  uint32
        +-- (config-choice)?
        |  +--:(config)
        |  |  +-- config?             string
        |  +--:(no-config)
        |     +-- no-config?          empty
        +-- feature-enable-default?   boolean
        +-- feature-enable*           yt:FeatureSpec
        +-- feature-disable*          yt:FeatureSpec
        +-- feature-code-default?     enumeration
        +-- feature-static*           yt:FeatureSpec
        +-- feature-dynamic*          yt:FeatureSpec
        +-- home?                     string
        +-- yumapro-home?             string
        +-- module*                   yt:NcModuleSpec
        +-- subtree*                  yt:NcPathSpec
        +-- deviation*                yt:NcModuleSpec
        +-- output?                   string
        +-- with-ocpattern?           boolean
        +-- defnames?                 boolean
        +-- doxygen-headers?          boolean
        +-- force-prefix?             yt:NcxName
        +-- format?                   FormatType
        +-- modversion?               empty
        +-- exports?                  empty
        +-- dependencies?             empty
        +-- identifiers?              empty
        +-- html-div?                 boolean
        +-- html-toc?                 TocType
        +-- objview?                  ObjViewType
        +-- quiet-mode?               empty
        +-- short-names?              boolean
        +-- show-errors?              empty
        +-- lang-errors?              empty
        +-- simurls?                  boolean
        +-- sil-bundle?               yt:NcxName
        +-- sil-include*              string
        +-- (sil-edit)?
        |  x--:(sil-edit1)
        |  |  x-- sil-edit1?          empty
        |  +--:(sil-edit2)
        |  |  +-- sil-edit2?          empty
        |  +--:(sil-edit3)
        |     +-- sil-edit3?          empty
        +-- (sil-get)?
        |  x--:(sil-get1)
        |  |  x-- sil-get1?           empty
        |  +--:(sil-get2)
        |     +-- sil-get2?           empty
        +-- sil-nmda?                 empty
        +-- sil-sa?                   empty
        +-- subdirs?                  boolean
        +-- (stats-report)?
        |  +--:(statistics)
        |     +-- stats?              enumeration
        |     +-- totals?             enumeration
        +-- tree-identifiers?         empty
        +-- unified?                  boolean
        +-- urlstart?                 string
        +-- versionnames?             boolean
        +-- xsd-schemaloc?            string
    
  • History:

    • Initial release train: 12.09

yumaworks-agt-profile.yang

This module contains a representation of major agt_profile data structure fields. This is an internal module used between the server and SIL-SA subsystems. This module is not advertised to clients.

  • Source Document: None

  • GitHub File: yumaworks-agt-profile.yang

  • YANG Tree:

    module: yumaworks-agt-profile
    
      grouping agt-profile:
        +--ro agt-profile
           +--ro agt_targ?                      ywt:server-target
           +--ro agt_start?                     enumeration
           +--ro agt_log_level?                 yt:NcDebugType
           +--ro agt_syslog_log_level?          yt:NcDebugType
           +--ro agt_pthread_log_level?         yt:NcDebugType
           +--ro agt_match_names?               ywt:NameMatchMode
           +--ro agt_transaction_model?         enumeration
           +--ro agt_acm_model?                 enumeration
           +--ro agt_defaultStyleEnum?          yapp:CliWithDefaultsType
           +--ro agt_accesscontrol_enum?        ywt:access-control-mode
           +--ro agt_max_sessions?              uint16
           +--ro agt_subsys_timeout?            uint16
           +--ro agt_ports*                     uint16
           +--ro agt_yangapi_server_url?        string
           +--ro agt_restconf_server_url?       string
           +--ro agt_accesscontrol?             string
           +--ro agt_conffile?                  string
           +--ro agt_logfile?                   string
           +--ro agt_startup?                   string
           +--ro agt_defaultStyle?              string
           +--ro agt_superuser?                 string
           +--ro agt_extern_libspec?            string
           +--ro agt_backup_dir?                string
           +--ro agt_server_id?                 string
           +--ro agt_subsys_info_file?          string
           +--ro agt_eventlog_size?             uint32
           +--ro agt_maxburst?                  uint32
           +--ro agt_hello_timeout?             uint32
           +--ro agt_idle_timeout?              uint32
           +--ro agt_linesize?                  uint32
           +--ro agt_indent?                    int32
           +--ro agt_message_indent?            int32
           +--ro agt_withdef_enabled?           uint8
           +--ro agt_sil_getbulk_max?           uint32
           +--ro agt_audit_log_console_level?   yt:NcDebugType
           +--ro agt_audit_log_level?           yt:NcDebugType
           +--ro agt_ha_port?                   uint16
           +--ro agt_ha_server_key?             string
           +--ro all-booleans1?                 uint32
           +--ro all-booleans2?                 uint32
           +--ro all-booleans3?                 uint32
    
  • History:

    • Initial release train: 14.08

yumaworks-app-common.yang

This module contains some common groupings of CLI parameters supported by some or all YumaPro programs. Each program with CLI parameters defines its own module of CLI parameters (using the ncx:cli extension). The program name is used for the YANG module name as well (E.g., yangdump-pro.yang or netconfd-pro.yang).

The definitions in this module are separated from the yuma-app-common.yang definitions because these CLI parameters and typedefs are only used in YumaPro, and not shared with Yuma programs.

There are no SIL callbacks in this module.

yumaworks-attrs.yang

This module contains abstract YANG definitions used to support XML attributes used with the NETCONF protocol. The attributes are modeled as leafs.

This is an internal module used for implementation only. This module is not advertised to clients.

  • Source Document: None

  • GitHub File: yumaworks-attrs.yang

  • YANG Tree:

    module: yumaworks-attrs
      +--rw last-modified?   yang:date-and-time
      +--rw etag?            string
      +--rw datapath?        string
      +--rw btype?           uint8
      +--rw owner?           yt:NcxName
      +--rw fixed-value?     boolean
    
  • History:

    • Initial release train: 13.04

yumaworks-callhome.yang

This module contains configuration data nodes to allow CallHome connections to be configured at run-time, in addition to the --callhome-server CLI parameter.

This module is advertised to clients. The --with-yumaworks-callhome CLI parameter must be set to true for this module to be present in the server.

  • Added in release 20.10-2

  • Source Document: None

  • GitHub File: yumaworks-callhome.yang

  • YANG Tree:

    module: yumaworks-callhome
      +--rw callhome
         +--rw server* [name]
            +--rw name        yang:yang-identifier
            +--rw address     inet:host
            +--rw port?       inet:port-number
            +--rw protocol    enumeration
    
  • History:

    • Initial release train: 20.10

yumaworks-cert-usermap.yang

The yumaworks-cert-usermap.yang module provides YANG configuration of the certificate to user name mappings. This YANG module implements the Client Identity procedures defined in section 6 of RFC 7589.

The --with-yumaworks-cert-usermap and --with-netconf-tls parameters must be set to 'true' for this module to be present in the server.

  • Added in release 21.10-6

  • Source Document:

  • GitHub File: yumaworks-cert-usermap.yang

  • YANG Tree:

    module: yumaworks-cert-usermap
      +--rw cert-usermap
         +--rw cert-to-name* [id]
            +--rw id             uint32
            +--rw fingerprint    x509c2n:tls-fingerprint
            +--rw map-type       identityref
            +--rw name           string
    
  • History:

    • Initial release train: 21.10

yumaworks-config-change.yang

This module contains extra data that can be added to <netconf-config-change> notifications. This extra data represents the old and new values associated with the edit.

The --with-yumaworks-config-change CLI parameter must be set to true for this module to be loaded by the server.

  • Source Document: None

  • GitHub File: yumaworks-config-change.yang

  • YANG Tree:

    module: yumaworks-config-change
    
      augment /ncn:netconf-config-change/ncn:edit:
        +-- new-value?   <anyxml>
        +-- old-value?   <anyxml>
    
  • History:

    • Initial release train: 18.10

yumaworks-db-api.yang

This module contains YControl protocol messages for the DB-API service.

This is an internal module used for implementation only. This module is not advertised to clients.

This module is only present in the server if the source code is built using the WITH_YCONTROL=1 or EVERYTHING=1 make flags.

  • Source Document: None

  • GitHub File: yumaworks-db-api.yang

  • YANG Tree:

    module: yumaworks-db-api
    
      augment-structure /yctl:ycontrol/yctl:message-payload/yctl:payload/yctl:payload:
        +-- db-api
           +-- (message-type)
              +--:(register-request)
              |  +-- register-request?   empty
              +--:(edit-request)
              |  +-- edit-request
              |     +-- target        string
              |     +-- edit-type?    enumeration
              |     +-- skip-sil?     boolean
              |     +-- yang-patch
              |        +-- patch-id    string
              |        +-- comment?    string
              |        +-- edit* [edit-id]
              |           +-- edit-id      string
              |           +-- operation    enumeration
              |           +-- target       target-resource-offset
              |           +-- point?       target-resource-offset
              |           +-- where?       enumeration
              |           +-- value?       <anydata>
              +--:(yp-ha-mode)
              |  +-- yp-ha-mode
              |     +-- (action)
              |        +--:(go-active)
              |        |  +-- go-active?    empty
              |        +--:(go-standby)
              |        |  +-- go-standby
              |        |     +-- new-active    string
              |        +--:(go-none)
              |           +-- go-none?      empty
              +--:(getconfig)
              |  +-- getconfig
              |     +-- withdef?        boolean
              |     +-- with-state?     boolean
              |     +-- xpath-filter?   yang:xpath1.0
              +--:(config)
              |  +-- config
              +--:(enter-maintmode)
              |  +-- enter-maintmode
              |     +-- allowed?   bits
              +--:(exit-maintmode)
              |  +-- exit-maintmode
              +--:(set-log-level)
              |  +-- set-log-level
              |     +-- log-level    yt:NcDebugType
              +--:(db-lock-init)
              |  +-- db-lock-init
              +--:(db-lock)
              |  +-- db-lock
              |     +-- lock-id    string
              +--:(db-lock-response)
              |  +-- db-lock-response
              |     +-- lock-id    string
              +--:(db-unlock)
              |  +-- db-unlock
              |     +-- lock-id    string
              +--:(subrpc-request)
              |  +-- subrpc-request
              |     +-- user-id?      string
              |     +-- rpc-module?   yt:NcxName
              |     +-- rpc-name      yt:NcxName
              |     +-- rpc-method?   <anyxml>
              +--:(subrpc-response)
                 +-- subrpc-response
                    +-- rpc-module    yt:NcxName
                    +-- rpc-name      yt:NcxName
                    +-- reply         <anyxml>
    
  • History:

    • Initial release train: 14.08

yumaworks-event-filter.yang

This module contains configuration parameters to suppress generation of specified notifications.

The --with-yumaworks-event-filter parameter must be set to true for this module to be loaded by the server.

  • Source Document: None

  • GitHub File: yumaworks-event-filter.yang

  • YANG Tree:

    module: yumaworks-event-filter
      +--rw event-filters!
         +--rw event-filter* [module event]
            +--rw module       yt:NcxName
            +--rw event        yt:NcxName
            +--rw enabled?     boolean
            +--rw log-drops?   boolean
    
  • History:

    • Initial release train: 12.09

yumaworks-event-stream.yang

This module contains configuration parameters to create and delete NETCONF Subscription Event Streams in the server.

The --with-yumaworks-event-stream parameter must be set to true for this module to be loaded by the server.

  • Added in release 20.10-7

  • Source Document: None

  • GitHub File: yumaworks-event-stream.yang

  • YANG Tree:

    module: yumaworks-event-stream
      +--rw event-streams
         +--rw event-stream* [name]
         |  +--rw name             ywt:NcxNumName
         |  +--rw eventlog-size?   uint32
         |  +--rw description?     string
         +--rw module-map* [module-name]
            +--rw module-name    yang:yang-identifier
            +--rw stream-name    ywt:NcxNumName
    
      rpcs:
        +---x clear-eventlog
           +---w input
              +---w stream-name    ywt:NcxNumName
    
  • History:

    • Initial release train: 20.10

yumaworks-extensions.yang

This module provides some of the YANG language extension statements that are used by YumaPro programs to automate certain parts of the NETCONF protocol, document generation, code generation, etc.

There are no SIL callback functions for this module. There are support functions within the src/ncx directory that include the obj_set_ncx_flags function in ncx/obj.c

The definitions in this module are separated from the yuma-ncx.yang definitions because these extensions are only used in YumaPro, and not shared with Yuma programs.

Some extensions are intended to be used directly or in annotations to configure the server behavior for vendor loaded YANG modules.

yumaworks-getbulk.yang

This module contains the <get-bulk> operation for NETCONF and RESTCONF.

The --with-yumaworks-getbulk parameter must be set to true for this module to be loaded by the server.

  • Source Document: None

  • GitHub File: yumaworks-getbulk.yang

  • YANG Tree:

    module: yumaworks-getbulk
    
      rpcs:
        +---x get-bulk
           +---w input
           |  +---w datastore?       enumeration
           |  +---w list-target      string
           |  +---w count?           uint32
           |  +---w content?         enumeration
           |  +---w depth?           union
           |  +---w with-defaults?   with-defaults-mode
           |  +---w last-keys?       <anyxml>
           |  +---w list-test?       yang:xpath1.0
           |  +---w fixed-keys?      <anyxml>
           +--ro output
              +--ro bulk
                 +--ro data?        <anyxml>
                 +--ro last-keys?   <anyxml>
    
  • History:

    • Initial release train: 15.10

yumaworks-grpc-mon.yang

This module contains gRPC Monitoring Information that can be retrieved from the netconfd-pro server .

This module contains the /grpc-state subtree. It provides information about the gRPC server capabilities and streams. The separate library agt_ypgrpc_state contains the SIL callbacks for this module.

  • This module is only present in the server if the source code is built using the following make flags:

  • Added in release 21.10-1

  • Source Document: None

  • GitHub File: yumaworks-grpc-mon.yang

  • YANG Tree:

    module: yumaworks-grpc-mon
      +--ro grpc-state
         +--ro statistics
         |  +--ro active-server-streams?   yang:zero-based-counter32
         |  +--ro active-client-streams?   yang:zero-based-counter32
         |  +--ro total-active-streams?    yang:zero-based-counter32
         |  +--ro total-closed-streams?    yang:zero-based-counter32
         +--ro server* [name]
         |  +--ro name                     string
         |  +--ro address                  inet:host
         |  +--ro port?                    inet:port-number
         |  +--ro start-time?              yang:date-and-time
         |  +--ro proto*                   string
         |  +--ro active-server-streams?   yang:zero-based-counter32
         |  +--ro active-client-streams?   yang:zero-based-counter32
         |  +--ro closed-streams?          yang:zero-based-counter32
         |  +--ro services
         |     +--ro service* [name]
         |        +--ro name      string
         |        +--ro method* [name]
         |           +--ro name                string
         |           +--ro client-streaming?   boolean
         |           +--ro server-streaming?   boolean
         +--ro server-streams!
         |  +--ro stream* [name]
         |     +--ro name             string
         |     +--ro creation-time?   yang:date-and-time
         |     +--ro location         inet:uri
         +--ro client-streams!
            +--ro stream* [name]
               +--ro name             string
               +--ro creation-time?   yang:date-and-time
               +--ro location         inet:uri
    
      rpcs:
        +---x grpc-shutdown
    
  • History:

    • Initial release train: 21.10

yumaworks-ids.yang

This module contains additional transport identities for NETCONF sessions in the ietf-netconf-monitoring module.

The --with-yumaworks-ids CLI parameter must be set to true for this module to be loaded by the server.

  • Source Document: None

  • GitHub File: yumaworks-ids.yang

  • YANG Tree: None

  • History:

    • Initial release train: 12.09

yumaworks-internal.yang

This module contains the <replay-config> RPC operation which is used internally by the server. This module is not advertised to clients.

  • Source Document: None

  • GitHub File: yumaworks-internal.yang

  • YANG Tree:

    module: yumaworks-internal
    
      rpcs:
        +---x replay-config
    
  • History:

    • Initial release train: 18.10

yumaworks-lock.yang

This module contains the <lock-all> and <unlock-all> operations that can be used in a NETCONF session to simplify datastore locking for edit transactions.

The --with-yumaworks-lock CLI parameter must be set to true for this module to be loaded by the server.

  • Source Document: None

  • GitHub File: yumaworks-lock.yang

  • YANG Tree:

    module: yumaworks-lock
    
      rpcs:
        +---x lock-all
        +---x unlock-all
    
  • History:

    • Initial release train: 22.10 (Release 8)

yumaworks-mgr-common.yang

This module contains internal groupings for CLI parameters used by client applications.

This is an internal module used for implementation only. This module is not advertised to clients.

  • Source Document: None

  • GitHub File: yumaworks-mgr-common.yang

  • YANG Tree:

    module: yumaworks-mgr-common
    
      grouping session-name-config:
        +-- session-name*   union
      grouping session-name-oper:
        +-- session-name?   nt:NcxName
      grouping output-cmn:
        +-- (output-choice)?
           +--:(async-mode-started)
           |  +-- async-mode-started?   empty
           +--:(session-output)
              +-- session-output* [session-name]
                 +-- session-name?          nt:NcxName
                 +-- (cmd-result)?
                    +--:(timeout-error)
                    |  +-- timeout-error?   empty
                    +--:(other-error)
                    |  +-- other-error?     string
                    +--:(data)
                       +-- data
    
  • History:

    • Initial release train: 18.10

yumaworks-opsmgr.yang

This module contains YP-Controller operations support.

This is an experimental module used for yp-controller only. This module is not advertised to clients.

This is not a built-in module. It is implemented as a stand-alone SIL that must be explicitly loaded into yp-controller.

  • Source Document: None

  • GitHub File: yumaworks-opsmgr.yang

  • YANG Tree:

    module: yumaworks-opsmgr
    
      rpcs:
        +---x get-capabilities
        |  +---w input
        |  |  +---w session-name*   union
        |  +--ro output
        |     +--ro (output-choice)?
        |        +--:(async-mode-started)
        |        |  +--ro async-mode-started?   empty
        |        +--:(session-output)
        |           +--ro session-output* [session-name]
        |              +--ro session-name           nt:NcxName
        |              +--ro (cmd-result)?
        |                 +--:(timeout-error)
        |                 |  +--ro timeout-error?   empty
        |                 +--:(other-error)
        |                 |  +--ro other-error?     string
        |                 +--:(data)
        |                    +--ro data
        |                       +--ro capabilities
        |                          +--ro capability*   string
        +---x get-event-log
        |  +---w input
        |  |  +---w session-name*   union
        |  |  +---w start-index?    uint32
        |  |  +---w max-entries?    uint32
        |  |  +---w start-time?     yang:date-and-time
        |  |  +---w finish-time?    yang:date-and-time
        |  |  +---w module-name?    nt:NcxName
        |  |  +---w event-name?     nt:NcxName
        |  |  +---w xpath-filter?   yang:xpath1.0
        |  +--ro output
        |     +--ro (output-choice)?
        |        +--:(async-mode-started)
        |        |  +--ro async-mode-started?   empty
        |        +--:(session-output)
        |           +--ro session-output* [session-name]
        |              +--ro session-name           nt:NcxName
        |              +--ro (cmd-result)?
        |                 +--:(timeout-error)
        |                 |  +--ro timeout-error?   empty
        |                 +--:(other-error)
        |                 |  +--ro other-error?     string
        |                 +--:(data)
        |                    +--ro data
        |                       +--ro event-data* [index]
        |                          +--ro index           uint32
        |                          +--ro notification?   <anydata>
        +---x invoke-rpc
        |  +---w input
        |  |  +---w session-name*   union
        |  |  +---w module-name     nt:NcxName
        |  |  +---w rpc-name        nt:NcxName
        |  |  +---w message-id?     string
        |  |  +---w timeout?        int32
        |  |  +---w input?          <anydata>
        |  +--ro output
        |     +--ro (output-choice)?
        |        +--:(async-mode-started)
        |        |  +--ro async-mode-started?   empty
        |        +--:(session-output)
        |           +--ro session-output* [session-name]
        |              +--ro session-name           nt:NcxName
        |              +--ro (cmd-result)?
        |                 +--:(timeout-error)
        |                 |  +--ro timeout-error?   empty
        |                 +--:(other-error)
        |                 |  +--ro other-error?     string
        |                 +--:(data)
        |                    +--ro data
        +---x invoke-action
           +---w input
           |  +---w session-name*   union
           |  +---w action-path     string
           |  +---w message-id?     string
           |  +---w timeout?        int32
           |  +---w input?          <anydata>
           +--ro output
              +--ro (output-choice)?
                 +--:(async-mode-started)
                 |  +--ro async-mode-started?   empty
                 +--:(session-output)
                    +--ro session-output* [session-name]
                       +--ro session-name           nt:NcxName
                       +--ro (cmd-result)?
                          +--:(timeout-error)
                          |  +--ro timeout-error?   empty
                          +--:(other-error)
                          |  +--ro other-error?     string
                          +--:(data)
                             +--ro data
    
      notifications:
        +---n cmd-response
           +--ro message-id                  string
           +--ro (output-choice)?
              +--:(async-mode-started)
              |  +--ro async-mode-started?   empty
              +--:(session-output)
                 +--ro session-output* [session-name]
                    +--ro session-name           nt:NcxName
                    +--ro (cmd-result)?
                       +--:(timeout-error)
                       |  +--ro timeout-error?   empty
                       +--:(other-error)
                       |  +--ro other-error?     string
                       +--:(data)
                          +--ro data
    
  • History:

    • Initial release train: 18.10

yumaworks-restconf-commit.yang

This module contains confirmed commit support for the RESTCONF protocol. It is used in the server to process confirmed-commit parameters. This is an YumaWorks extension to the RESTCONF protocol. This module is not advertised to clients.

  • Source Document: None

  • GitHub File: yumaworks-restconf-commit.yang

  • YANG Tree:

    module: yumaworks-restconf-commit
    
      grouping commit-parameters:
        +-- confirmed?         int8
        +-- confirm-timeout?   uint32
        +-- persist?           string
        +-- persist-id?        string
    
  • History:

    • Initial release train: 15.10

yumaworks-restconf.yang

This module contains metadata for supporting some RESTCONF query parameters used in the server.

This is an YumaWorks extension to the RESTCONF protocol. This module is not advertised to clients.

  • Source Document: None

  • GitHub File: yumaworks-restconf.yang

  • YANG Tree:

    module: yumaworks-restconf
    
      grouping content-parameter:
        +-- content?   enumeration
      grouping depth-parameter:
        +-- depth?   union
      grouping query-parameters:
        +-- content?       enumeration
        +-- depth?         union
        +-- filter?        yang:xpath1.0
        +-- insert?        enumeration
        +-- point?         string
        +-- start-time?    yang:date-and-time
        +-- stop-time?     yang:date-and-time
        +-- with-origin?   empty
    
  • History:

    • Initial release train: 15.10

yumaworks-schema-mount-annot.yang

This module contains some annotations for the ietf-yang-schema-mount.yang module. It is used internally by the server and is not advertised to any clients.

This module does not contain any protocol-accessible YANG objects.

yumaworks-schema-mount.yang

This module contains a YANG structure specifying the sm-config Structure definition used for XML and JSON files to represent the Schema Mount configuration to load at server boot-time.

This module does not contain any protocol-accessible YANG objects.

  • Source Document: None

  • GitHub File: yumaworks-schema-mount.yang

  • YANG Tree:

    module: yumaworks-schema-mount
    
      grouping sm-config-keys:
        +-- mp-module?   yang:yang-identifier
        +-- mp-label?    yang:yang-identifier
      grouping sm-config-parms:
        +-- mp-module?   yang:yang-identifier
        +-- mp-label?    yang:yang-identifier
        +-- mp-config?   boolean
        +-- mp-cli
           +-- annotation*               yt:NcModuleSpec
           +-- bundle*                   nt:NcxName
           +-- deviation*                yt:NcModuleSpec
           +-- feature-enable-default?   boolean
           +-- feature-enable*           yt:FeatureSpec
           +-- feature-disable*          yt:FeatureSpec
           +-- loadpath?                 yt:NcPathList
           +-- module*                   yt:NcModuleSpec
      grouping sm-config-contents:
        +-- sm-config* [mp-module mp-label]
           +-- mp-module?   yang:yang-identifier
           +-- mp-label?    yang:yang-identifier
           +-- mp-config?   boolean
           +-- mp-cli
              +-- annotation*               yt:NcModuleSpec
              +-- bundle*                   nt:NcxName
              +-- deviation*                yt:NcModuleSpec
              +-- feature-enable-default?   boolean
              +-- feature-enable*           yt:FeatureSpec
              +-- feature-disable*          yt:FeatureSpec
              +-- loadpath?                 yt:NcPathList
              +-- module*                   yt:NcModuleSpec
    
  • History:

    • Initial release train: 22.10T

yumaworks-server.yang

This module contains configuration parameters that mirror the server CLI and .conf file parameters. It allows some parameters to be changed at run-time and the rest to be changed for the next reboot.

This is not a built-in module. It is implemented as a stand-alone SIL that must be explicitly loaded into the server.

> netconfd-pro --module=yumaworks-server
  • Source Document: None

  • GitHub File: yumaworks-server.yang

  • YANG Tree:

    module: yumaworks-server
      +--rw server
         +--rw help?                           empty
         +--rw (help-mode)?
         |  +--:(brief)
         |  |  +--rw brief?                    empty
         |  +--:(normal)
         |  |  +--rw normal?                   empty
         |  +--:(full)
         |     +--rw full?                     empty
         +--rw indent?                         yt:IndentType
         +--rw log?                            string
         +--rw log-append?                     empty
         +--rw log-level?                      yt:NcDebugType
         +--rw modpath?                        yt:NcPathList
         +--rw version?                        empty
         +--rw warn-error?                     boolean
         +--rw warn-idlen?                     uint32
         +--rw warn-linelen?                   uint32
         +--rw warn-off*                       uint32
         +--rw warn-up*                        uint32
         +--rw (config-choice)?
         |  +--:(config)
         |  |  +--rw config?                   string
         |  +--:(no-config)
         |     +--rw no-config?                empty
         +--rw feature-enable-default?         boolean
         +--rw feature-enable*                 yt:FeatureSpec
         +--rw feature-disable*                yt:FeatureSpec
         +--rw binary-display-maxlen?          uint32
         +--rw errmsg*                         string
         +--rw errmsg-lang?                    string
         +--rw home?                           string
         +--rw log-backtrace?                  uint32
         +--rw log-backtrace-detail?           empty
         +--rw log-backtrace-level?            bits
         +--rw log-backtrace-stream?           bits
         +--rw log-header?                     bits
         +--rw log-mirroring?                  empty
         +--rw log-console?                    empty
         +--rw log-stderr?                     empty
         +--rw log-suppress-ctrl?              empty
         +--rw log-syslog?                     empty
         +--rw log-syslog-level?               yt:NcDebugType
         +--rw log-highres-datetime?           boolean
         +--rw log-vendor?                     empty
         +--rw log-vendor-level?               yt:NcDebugType
         +--rw message-indent?                 int8
         +--rw yumapro-home?                   string
         +--rw loadpath?                       yt:NcPathList
         +--rw subdirs?                        boolean
         +--rw tcp-connect-timeout?            uint16
         +--rw protocols?                      bits
         +--rw runpath?                        yt:NcPathList
         +--rw match-names?                    ywt:NameMatchMode
         +--rw alt-names?                      ywt:AltNameMode
         +--rw wildcard-keys?                  boolean
         +--rw access-control?                 ywt:access-control-mode
         +--rw allow-list-delete-all?          boolean
         +--rw allow-leaflist-delete-all?      boolean
         +--rw allowed-user*                   nt:NcxName
         +--rw (audit-log-choice)?
         |  +--:(audit-log)
         |  |  +--rw audit-log?                string
         |  +--:(no-audit-log)
         |     +--rw no-audit-log?             empty
         +--rw audit-log-append?               empty
         +--rw audit-log-candidate?            boolean
         +--rw audit-log-console-level?        nt:NcDebugType
         +--rw audit-log-events?               bits
         +--rw audit-log-level?                nt:NcDebugType
         +--rw autodelete-pdu-error?           boolean
         +--rw bundle*                         nt:NcxName
         +--rw callhome-reconnect?             boolean
         +--rw callhome-retry-interval?        uint16
         +--rw callhome-retry-max?             uint16
         +--rw callhome-server*                string
         +--rw callhome-sshd-command?          string
         +--rw callhome-sshd-config?           string
         +--rw callhome-subsys-command?        string
         +--rw callhome-tls-server*            string
         +--rw cert-default-user?              string
         +--rw cert-usermap*                   string
         +--rw confdir?                        string
         +--rw convert-subtree-filter?         boolean
         x--rw create-empty-npcontainers?      boolean
         x--rw create-empty-npcontainers-ro?   boolean
         +--rw db-lock-retry-interval?         uint32
         +--rw db-lock-timeout?                uint32
         +--rw default-style?                  enumeration
         o--rw delete-empty-npcontainers?      boolean
         +--rw eventlog-size?                  uint32
         +--rw event-stream*                   ywt:NcxNumName
         +--rw event-stream-map*               string
         +--rw fileloc-fhs?                    boolean
         +--rw ha-enabled?                     boolean
         +--rw ha-initial-active?              nt:NcxName
         +--rw ha-port?                        inet:port-number
         +--rw ha-server*                      string
         +--rw ha-server-key?                  string
         +--rw ha-sil-standby?                 boolean
         +--rw hello-timeout?                  uint32
         +--rw hide-module*                    nt:NcxName
         +--rw highres-event-time?             boolean
         +--rw idle-timeout?                   uint32
         +--rw import-version-bestmatch?       boolean
         +--rw insecure-ok?                    boolean
         +--rw library-mode?                   boolean
         +--rw max-burst?                      uint32
         +--rw max-getbulk?                    uint32
         +--rw max-lock-hold-time?             uint16
         +--rw max-sessions?                   uint16
         +--rw max-cli-sessions?               uint16
         +--rw max-user-sessions?              uint16
         +--rw max-per-user-sessions*          string
         +--rw max-strlen?                     int32
         +--rw module-tagmap*                  string
         +--rw netconf-capability*             inet:uri
         +--rw netconf-tls-address?            inet:ip-address
         +--rw netconf-tls-certificate?        string
         +--rw netconf-tls-key?                string
         +--rw netconf-tls-port?               inet:port-number
         +--rw netconf-tls-trust-store?        string
         +--rw no-log?                         empty
         +--rw no-nvstore?                     empty
         +--rw port*                           inet:port-number
         +--rw module*                         yt:NcModuleSpec
         +--rw deviation*                      yt:NcModuleSpec
         +--rw annotation*                     yt:NcModuleSpec
         +--rw datapath?                       yt:NcPathList
         +--rw push-max-operational?           uint32
         +--rw push-max-periodic?              uint32
         +--rw push-min-dampening?             uint16
         +--rw push-min-period?                uint16
         +--rw push-simop-enabled?             boolean
         +--rw push-simop-patch-update?        boolean
         +--rw push-simop-period?              uint16
         +--rw remove-schema-aug-leafs?        boolean
         +--rw restconf-capability*            inet:uri
         +--rw restconf-default-encoding?      enumeration
         +--rw restconf-strict-headers?        boolean
         +--rw return-empty-npcontainers?      boolean
         +--rw return-status?                  boolean
         +--rw running-error?                  enumeration
         +--rw save-owners?                    boolean
         +--rw sil-cc-callback-all?            boolean
         +--rw sil-delete-children-first?      boolean
         +--rw sil-invoke-for-defaults?        boolean
         +--rw sil-missing-error?              boolean
         +--rw sil-prio-reverse-for-deletes?   boolean
         +--rw sil-root-check-first?           boolean
         +--rw sil-skip-load?                  empty
         +--rw sil-test-get-when?              boolean
         +--rw sil-validate-candidate?         boolean
         +--rw simple-json-names?              boolean
         +--rw sm-config?                      string
         +--rw sm-config-encoding?             enumeration
         +--rw snmp-agent-role?                enumeration
         +--rw snmp-subagent-priority?         uint16
         +--rw socket-address?                 inet:ip-address
         +--rw socket-port?                    inet:port-number
         +--rw socket-type?                    enumeration
         +--rw (start)?
         |  +--:(no-startup)
         |  |  +--rw no-startup?               empty
         |  +--:(factory-startup)
         |  |  +--rw factory-startup?          empty
         |  +--:(startup)
         |     +--rw startup?                  string
         +--rw startup-error?                  enumeration
         +--rw startup-factory-file?           string
         +--rw startup-prune-ok?               boolean
         +--rw startup-skip-validation?        boolean
         +--rw subsys-timeout?                 uint16
         +--rw superuser*                      union
         +--rw system-notifications?           bits
         +--rw system-sort-type?               enumeration
         +--rw system-sorted?                  boolean
         +--rw target?                         enumeration
         +--rw tls-crl-missing-ok?             boolean
         +--rw tls-crl-mode?                   enumeration
         +--rw tls-cipherlist?                 string
         +--rw tls-debug?                      boolean
         +--rw tls-deprecated-ok?              boolean
         +--rw trim-whitespace?                boolean
         +--rw log-event-drops?                boolean
         +--rw log-pthread-level?              nt:NcDebugType
         x--rw session-sync-mutex?             empty
         +--rw server-id?                      nt:NcxName
         +--rw server-root?                    nt:NcxName
         +--rw usexmlorder?                    empty
         +--rw user-parm?                      string
         +--rw (watcher-parm)?
         |  +--:(no-watcher)
         |  |  +--rw no-watcher?               empty
         |  +--:(watcher-interval)
         |     +--rw watcher-interval?         uint32
         +--rw wait-datastore-ready?           boolean
         +--rw with-error-number?              boolean
         +--rw with-maintenance-mode?          boolean
         +--rw with-notifications?             boolean
         +--rw with-db-lock?                   boolean
         +--rw with-callhome?                  boolean
         +--rw with-canonical?                 boolean
         +--rw with-config-id?                 boolean
         +--rw with-grpc?                      boolean
         +--rw with-gnmi?                      boolean
         +--rw with-modtags?                   boolean
         +--rw with-nmda?                      boolean
         +--rw with-ocpattern?                 boolean
         +--rw with-schema-mount?              boolean
         +--rw with-startup?                   boolean
         +--rw with-term-msg?                  boolean
         +--rw with-url?                       boolean
         +--rw with-url-ftp?                   boolean
         +--rw with-url-tftp?                  boolean
         +--rw with-validate?                  boolean
         +--rw with-netconf?                   boolean
         +--rw with-netconf-tls?               boolean
         +--rw with-restconf?                  boolean
         +--rw with-rollback-on-error?         boolean
         +--rw with-snmp?                      boolean
         +--rw with-support-save?              boolean
         +--rw with-warnings?                  boolean
         x--rw with-yang-api?                  boolean
         +--rw with-yang11-hello?              boolean
         +--rw with-yang-patch-running?        boolean
         +--rw with-yang-cbor?                 boolean
         +--rw with-yp-coap?                   boolean
         +--rw with-yp-coap-dtls?              boolean
         +--rw with-yp-shell?                  boolean
         +--rw with-yuma-system?               boolean
         +--rw with-yuma-time-filter?          boolean
         +--rw with-yumaworks-config-change?   boolean
         +--rw with-yumaworks-event-filter?    boolean
         +--rw with-yumaworks-getbulk?         boolean
         +--rw with-yumaworks-lock?            boolean
         +--rw with-yumaworks-callhome?        boolean
         +--rw with-yumaworks-event-stream?    boolean
         +--rw with-yumaworks-ids?             boolean
         +--rw with-yumaworks-sm-yanglib?      boolean
         +--rw with-yumaworks-system?          boolean
         +--rw with-yumaworks-templates?       boolean
         +--rw yang-sid-mode?                  ywt:yang-sid-mode
         +--rw with-yumaworks-cert-usermap?    boolean
         +--rw yangapi-server-url?             inet:uri
         +--rw yp-coap-address?                inet:ip-address
         +--rw yp-coap-port?                   inet:port-number
         +--rw yp-coap-dtls-port?              inet:port-number
         +--rw restconf-server-url?            inet:uri
    
  • History:

    • Initial release train: 17.10

yumaworks-sesmgr.yang

This module contains YP-Controller session support.

This is an experimental module used for yp-controller only. This module is not advertised to clients.

This is not a built-in module. It is implemented as a stand-alone SIL that must be explicitly loaded into yp-controller.

  • Source Document: None

  • GitHub File: yumaworks-sesmgr.yang

  • YANG Tree:

    module: yumaworks-sesmgr
      +--rw sesmgr
         +--rw devices
         |  +--rw device* [name]
         |     +--rw name              nt:NcxName
         |     +--rw server            inet:host
         |     +--rw port?             inet:port-number
         |     +--rw rc-entry-point?   string
         |     +--rw protocols?        bits
         |     +--rw transport?        ywt:transport-type
         +--rw users
         |  +--rw user* [name]
         |     +--rw name                 nt:NcxName
         |     +--rw user                 nt:NcxName
         |     +--rw (pass)
         |     |  +--:(password)
         |     |  |  +--rw password?      string
         |     |  +--:(no-password)
         |     |     +--rw no-password?   empty
         |     +--rw public-key?          string
         |     +--rw private-key?         string
         |     +--rw ssl-fallback-ok?     boolean
         |     +--rw ssl-certificate?     string
         |     +--rw ssl-key?             string
         |     +--rw ssl-trust-store?     string
         |     +--rw admin-group*         nt:NcxName
         +--rw sessions
            +--rw session* [name]
            |  +--rw name          nt:NcxName
            |  +--rw user-ref      sesmgr-user-ref
            |  +--rw device-ref    sesmgr-device-ref
            |  +--ro state
            |     +--ro connected?      boolean
            |     +--ro connect-time?   yang:date-and-time
            |     +--ro counters
            |        +--ro out-rpcs?           yang:zero-based-counter32
            |        +--ro in-rpc-errors?      yang:zero-based-counter32
            |        +--ro in-notifications?   yang:zero-based-counter32
            |        +--ro in-octets?          yang:zero-based-counter32
            |        +--ro out-octets?         yang:zero-based-counter32
            +--ro callhome-session* [name]
               +--ro name        nt:NcxName
               +--ro user-ref    sesmgr-user-ref
               +--ro device
               |  +--ro server            inet:host
               |  +--ro port?             inet:port-number
               |  +--ro rc-entry-point?   string
               |  +--ro protocols?        bits
               |  +--ro transport?        ywt:transport-type
               +--ro state
                  +--ro connected?      boolean
                  +--ro connect-time?   yang:date-and-time
                  +--ro counters
                     +--ro out-rpcs?           yang:zero-based-counter32
                     +--ro in-rpc-errors?      yang:zero-based-counter32
                     +--ro in-notifications?   yang:zero-based-counter32
                     +--ro in-octets?          yang:zero-based-counter32
                     +--ro out-octets?         yang:zero-based-counter32
    
  • History:

    • Initial release train: 18.10

yumaworks-sil-sa.yang

This module contains YControl protocol messages for the SIL-SA service.

This is an internal module used for implementation only. This module is not advertised to clients.

This module is only present in the server if the source code is built using the WITH_YCONTROL=1 or EVERYTHING=1 make flag.

  • Source Document: None

  • GitHub File: yumaworks-sil-sa.yang

  • YANG Tree:

    module: yumaworks-sil-sa
    
      augment-structure /yctl:ycontrol/yctl:message-payload/yctl:payload/yctl:payload:
        +-- sil-sa
           +-- (message-type)
              +--:(config-request)
              |  +-- config-request?             empty
              +--:(config-response)
              |  +-- config-response
              |     +--ro agt-profile
              |     |  +--ro agt_targ?                      ywt:server-target
              |     |  +--ro agt_start?                     enumeration
              |     |  +--ro agt_log_level?                 yt:NcDebugType
              |     |  +--ro agt_syslog_log_level?          yt:NcDebugType
              |     |  +--ro agt_pthread_log_level?         yt:NcDebugType
              |     |  +--ro agt_match_names?               ywt:NameMatchMode
              |     |  +--ro agt_transaction_model?         enumeration
              |     |  +--ro agt_acm_model?                 enumeration
              |     |  +--ro agt_defaultStyleEnum?          yapp:CliWithDefaultsType
              |     |  +--ro agt_accesscontrol_enum?        ywt:access-control-mode
              |     |  +--ro agt_max_sessions?              uint16
              |     |  +--ro agt_subsys_timeout?            uint16
              |     |  +--ro agt_ports*                     uint16
              |     |  +--ro agt_yangapi_server_url?        string
              |     |  +--ro agt_restconf_server_url?       string
              |     |  +--ro agt_accesscontrol?             string
              |     |  +--ro agt_conffile?                  string
              |     |  +--ro agt_logfile?                   string
              |     |  +--ro agt_startup?                   string
              |     |  +--ro agt_defaultStyle?              string
              |     |  +--ro agt_superuser?                 string
              |     |  +--ro agt_extern_libspec?            string
              |     |  +--ro agt_backup_dir?                string
              |     |  +--ro agt_server_id?                 string
              |     |  +--ro agt_subsys_info_file?          string
              |     |  +--ro agt_eventlog_size?             uint32
              |     |  +--ro agt_maxburst?                  uint32
              |     |  +--ro agt_hello_timeout?             uint32
              |     |  +--ro agt_idle_timeout?              uint32
              |     |  +--ro agt_linesize?                  uint32
              |     |  +--ro agt_indent?                    int32
              |     |  +--ro agt_message_indent?            int32
              |     |  +--ro agt_withdef_enabled?           uint8
              |     |  +--ro agt_sil_getbulk_max?           uint32
              |     |  +--ro agt_audit_log_console_level?   yt:NcDebugType
              |     |  +--ro agt_audit_log_level?           yt:NcDebugType
              |     |  +--ro agt_ha_port?                   uint16
              |     |  +--ro agt_ha_server_key?             string
              |     |  +--ro all-booleans1?                 uint32
              |     |  +--ro all-booleans2?                 uint32
              |     |  +--ro all-booleans3?                 uint32
              |     +-- bundle*         yt:NcxName
              |     +-- module*         yt:NcModuleSpec
              |     +-- deviation*      yt:NcModuleSpec
              |     +-- modpath?        string
              |     +-- datapath?       string
              |     +-- runpath?        string
              |     +-- schema-mount
              |        +-- sm-config* [mp-module mp-label]
              |           +-- mp-module    yang:yang-identifier
              |           +-- mp-label     yang:yang-identifier
              |           +-- mp-config?   boolean
              |           +-- mp-cli
              |              +-- annotation*               yt:NcModuleSpec
              |              +-- bundle*                   nt:NcxName
              |              +-- deviation*                yt:NcModuleSpec
              |              +-- feature-enable-default?   boolean
              |              +-- feature-enable*           yt:FeatureSpec
              |              +-- feature-disable*          yt:FeatureSpec
              |              +-- loadpath?                 yt:NcPathList
              |              +-- module*                   yt:NcModuleSpec
              +--:(register-request)
              |  +-- register-request
              |     +-- bundle*                 yt:NcxName
              |     +-- bundle-module*          yt:NcModuleSpec
              |     +-- register* [module]
              |     |  +-- module                   yt:NcxName
              |     |  +-- revision?                string
              |     |  +-- path*                    string
              |     |  +-- edit2-path*              string
              |     |  +-- edit3-path*              string
              |     |  +-- get-path*                string
              |     |  +-- rpc-name*                yt:NcxName
              |     |  +-- action-path*             string
              |     |  +-- post-sethook-path*       string
              |     |  +-- sethook-list* [hook-path]
              |     |  |  +-- hook-path      string
              |     |  |  +-- hook-format?   enumeration
              |     |  |  +-- hook-type?     enumeration
              |     |  |  +-- added-edit?    boolean
              |     |  +-- transaction-hook-list* [hook-path]
              |     |  |  +-- hook-path      string
              |     |  |  +-- hook-format?   enumeration
              |     |  |  +-- hook-type?     enumeration
              |     |  |  +-- added-edit?    boolean
              |     |  +-- stream-callback!
              |     |     +-- (callback-type)?
              |     |        +--:(event-stream)
              |     |        |  +-- event-stream?   ywt:NcxNumName
              |     |        +--:(all-streams)
              |     |           +-- all-streams?    empty
              |     +-- transaction-start?      empty
              |     +-- transaction-complete?   empty
              |     +-- validate-complete?      empty
              |     +-- apply-complete?         empty
              |     +-- commit-complete?        empty
              |     +-- rollback-complete?      empty
              |     +-- edit-phase-complete?    empty
              +--:(start-transaction)
              |  +-- start-transaction
              |     +-- transaction-id      string
              |     +-- user-id             string
              |     +-- client-addr?        string
              |     +-- target              string
              |     +-- validate?           boolean
              |     +-- reverse-edit?       boolean
              |     +-- load-config?        boolean
              |     +-- is-hook-load?       boolean
              |     +-- is-hook-validate?   boolean
              |     +-- edit* [id]
              |        +-- id             uint32
              |        +-- operation      enumeration
              |        +-- path           string
              |        +-- hook-path?     string
              |        +-- hook-format?   enumeration
              |        +-- hook-type?     enumeration
              |        +-- added-edit?    boolean
              |        +-- editvars
              |        |  +-- insert-op?          enumeration
              |        |  +-- insert-str?         string
              |        |  +-- insert-mode?        enumeration
              |        |  +-- insert-val?         <anydata>
              |        |  +-- sil-priority?       uint8
              |        |  +-- operset?            empty
              |        |  +-- move?               empty
              |        |  +-- skip-sil-partial?   empty
              |        +-- newval?        <anydata>
              |        +-- curval?        <anydata>
              |        +-- update?        <anydata>
              |        +-- keys?          <anydata>
              |        +-- mpid
              |        |  +-- mp-module?   yang:yang-identifier
              |        |  +-- mp-label?    yang:yang-identifier
              |        |  +-- objpath?     string
              |        |  +-- keys?        <anydata>
              |        +-- child-edit* []
              |           +-- operation    enumeration
              |           +-- editvars
              |           |  +-- insert-op?          enumeration
              |           |  +-- insert-str?         string
              |           |  +-- insert-mode?        enumeration
              |           |  +-- insert-val?         <anydata>
              |           |  +-- sil-priority?       uint8
              |           |  +-- operset?            empty
              |           |  +-- move?               empty
              |           |  +-- skip-sil-partial?   empty
              |           +-- newval?      <anydata>
              |           +-- curval?      <anydata>
              +--:(continue-transaction)
              |  +-- continue-transaction
              |     +-- transaction-id    string
              |     +-- phase             enumeration
              +--:(transaction-response)
              |  +-- transaction-response
              |     +-- transaction-id    string
              |     +-- added-edit* []
              |        +-- path             string
              |        +-- operation?       string
              |        +-- where?           string
              |        +-- point?           string
              |        +-- skip-callback?   boolean
              |        +-- edit?            <anydata>
              +--:(cancel-transaction)
              |  +-- cancel-transaction
              |     +-- transaction-id    string
              +--:(trigger-replay)
              |  +-- trigger-replay?             empty
              +--:(load-event)
              |  +-- load-event
              |     +-- load?          boolean
              |     +--ro agt-profile
              |     |  +--ro agt_targ?                      ywt:server-target
              |     |  +--ro agt_start?                     enumeration
              |     |  +--ro agt_log_level?                 yt:NcDebugType
              |     |  +--ro agt_syslog_log_level?          yt:NcDebugType
              |     |  +--ro agt_pthread_log_level?         yt:NcDebugType
              |     |  +--ro agt_match_names?               ywt:NameMatchMode
              |     |  +--ro agt_transaction_model?         enumeration
              |     |  +--ro agt_acm_model?                 enumeration
              |     |  +--ro agt_defaultStyleEnum?          yapp:CliWithDefaultsType
              |     |  +--ro agt_accesscontrol_enum?        ywt:access-control-mode
              |     |  +--ro agt_max_sessions?              uint16
              |     |  +--ro agt_subsys_timeout?            uint16
              |     |  +--ro agt_ports*                     uint16
              |     |  +--ro agt_yangapi_server_url?        string
              |     |  +--ro agt_restconf_server_url?       string
              |     |  +--ro agt_accesscontrol?             string
              |     |  +--ro agt_conffile?                  string
              |     |  +--ro agt_logfile?                   string
              |     |  +--ro agt_startup?                   string
              |     |  +--ro agt_defaultStyle?              string
              |     |  +--ro agt_superuser?                 string
              |     |  +--ro agt_extern_libspec?            string
              |     |  +--ro agt_backup_dir?                string
              |     |  +--ro agt_server_id?                 string
              |     |  +--ro agt_subsys_info_file?          string
              |     |  +--ro agt_eventlog_size?             uint32
              |     |  +--ro agt_maxburst?                  uint32
              |     |  +--ro agt_hello_timeout?             uint32
              |     |  +--ro agt_idle_timeout?              uint32
              |     |  +--ro agt_linesize?                  uint32
              |     |  +--ro agt_indent?                    int32
              |     |  +--ro agt_message_indent?            int32
              |     |  +--ro agt_withdef_enabled?           uint8
              |     |  +--ro agt_sil_getbulk_max?           uint32
              |     |  +--ro agt_audit_log_console_level?   yt:NcDebugType
              |     |  +--ro agt_audit_log_level?           yt:NcDebugType
              |     |  +--ro agt_ha_port?                   uint16
              |     |  +--ro agt_ha_server_key?             string
              |     |  +--ro all-booleans1?                 uint32
              |     |  +--ro all-booleans2?                 uint32
              |     |  +--ro all-booleans3?                 uint32
              |     +-- bundle*        yt:NcxName
              |     +-- module*        yt:NcModuleSpec
              |     +-- deviation*     yt:NcModuleSpec
              |     +-- modpath?       string
              |     +-- datapath?      string
              |     +-- runpath?       string
              +--:(bundle-load-event)
              |  +-- bundle-load-event
              |     +-- bundle*          yt:NcxName
              |     +-- bundle-module*   yt:NcModuleSpec
              +--:(get-request)
              |  +-- get-request
              |     +-- transaction-id    string
              |     +-- user-id?          string
              |     +-- client-addr?      string
              |     +-- flags?            bits
              |     +-- max-entries?      uint32
              |     +-- path              string
              |     +-- keys?             <anydata>
              |     +-- matches?          <anydata>
              |     +-- select-nodes
              |     |  +-- select-node* [objname]
              |     |     +-- objname    string
              |     |     +-- modname?   string
              |     +-- mpid
              |        +-- mp-module?   yang:yang-identifier
              |        +-- mp-label?    yang:yang-identifier
              |        +-- objpath?     string
              |        +-- keys?        <anydata>
              +--:(get-response)
              |  +-- get-response
              |     +-- transaction-id         string
              |     +-- more-data?             boolean
              |     +-- match-test-done?       boolean
              |     +-- active-case-modname?   string
              |     +-- active-case?           string
              |     +-- origin?                string
              |     +-- (return-choice)?
              |        +--:(return-one)
              |        |  +-- return-keys?     <anydata>
              |        |  +-- values?          <anydata>
              |        +--:(return-getbulk)
              |           +-- entry* []
              |              +-- return-keys?   <anydata>
              |              +-- values?        <anydata>
              +--:(notification)
              |  +-- notification
              |     +-- module-name    string
              |     +-- event-name     string
              |     +-- event-path?    string
              |     +-- event-key*     string
              |     +-- event-time     string
              |     +-- stream-name?   yt:NcxName
              |     +-- mpid
              |     |  +-- mp-module?   yang:yang-identifier
              |     |  +-- mp-label?    yang:yang-identifier
              |     |  +-- objpath?     string
              |     |  +-- keys?        <anydata>
              |     +-- parms?         <anydata>
              +--:(rpc-request)
              |  +-- rpc-request
              |     +-- transaction-id    string
              |     +-- user-id?          string
              |     +-- client-addr?      string
              |     +-- rpc-module        yt:NcxName
              |     +-- rpc-name          yt:NcxName
              |     +-- mpid
              |     |  +-- mp-module?   yang:yang-identifier
              |     |  +-- mp-label?    yang:yang-identifier
              |     |  +-- objpath?     string
              |     |  +-- keys?        <anydata>
              |     +-- rpc-input?        <anydata>
              +--:(rpc-response)
              |  +-- rpc-response
              |     +-- transaction-id      string
              |     +-- (response-type)?
              |        +--:(rpc-ok)
              |        |  +-- rpc-ok?       empty
              |        +--:(rpc-output)
              |           +-- rpc-output?   <anydata>
              +--:(action-request)
              |  +-- action-request
              |     +-- transaction-id    string
              |     +-- user-id?          string
              |     +-- client-addr?      string
              |     +-- path              string
              |     +-- keys?             <anydata>
              |     +-- mpid
              |     |  +-- mp-module?   yang:yang-identifier
              |     |  +-- mp-label?    yang:yang-identifier
              |     |  +-- objpath?     string
              |     |  +-- keys?        <anydata>
              |     +-- action-input?     <anydata>
              +--:(action-response)
              |  +-- action-response
              |     +-- transaction-id         string
              |     +-- (response-type)?
              |        +--:(action-ok)
              |        |  +-- action-ok?       empty
              |        +--:(action-output)
              |           +-- action-output?   <anydata>
              +--:(trans-start-hook)
              |  +-- trans-start-hook
              |     +-- transaction-id    string
              |     +-- user-id?          string
              |     +-- client-addr?      string
              |     +-- isvalidate?       boolean
              |     +-- isrollback?       boolean
              |     +-- isrunning?        boolean
              +--:(trans-complete-hook)
              |  +-- trans-complete-hook
              |     +-- transaction-id    string
              +--:(hook-get-request)
              |  +-- hook-get-request
              |     +-- path         string
              |     +-- isrunning?   boolean
              +--:(hook-get-response)
              |  +-- hook-get-response
              |     +-- value?   <anydata>
              +--:(stream-callback-event)
              |  +-- stream-callback-event
              |     +-- event-stream?      ywt:NcxNumName
              |     +-- stream-subevent?   enumeration
              |     +-- module-name?       yt:NcxName
              |     +-- all-streams?       empty
              +--:(commit-completeness-hook)
                 +-- commit-completeness-hook
                    +-- transaction-id    string
                    +-- user-id?          string
                    +-- client-addr?      string
                    +-- commit-phase?     enumeration
                    +-- commit-type?      enumeration
    
  • History:

    • Initial release train: 14.08

yumaworks-sm-yanglib.yang

This module contains the <get-sm-yanglib> RPC operation to retrieve YANG library information for a schema mount point.

This module is only present in the server if:

  • the source code is built using the WITH_SCHEMA_MOUNT=1 or EVERYTHING=1 make flag.

  • the --with-yumaworks-sm-yanglib CLI parameter is set to 'true'

  • the --with-schema-mount CLI parameter is set to 'true'

  • the --sm-config CLI parameter is set to a valid Schema Mount configuration

  • Source Document: None

  • GitHub File: yumaworks-sm-yanglib.yang

  • YANG Tree:

    module: yumaworks-sm-yanglib
    
      rpcs:
        +---x get-sm-yanglib
           +---w input
           |  +---w module    yang:yang-identifier
           |  +---w label     yang:yang-identifier
           +--ro output
              +--ro modules-state
                 +--ro module-set-id    string
                 x--ro module* [name revision]
                    x--ro name                yang:yang-identifier
                    x--ro revision            union
                    +--ro schema?             inet:uri
                    x--ro namespace           inet:uri
                    x--ro feature*            yang:yang-identifier
                    x--ro deviation* [name revision]
                    |  x--ro name        yang:yang-identifier
                    |  x--ro revision    union
                    x--ro conformance-type    enumeration
                    x--ro submodule* [name revision]
                       x--ro name        yang:yang-identifier
                       x--ro revision    union
                       +--ro schema?     inet:uri
    
  • History:

    • Initial release train: 22.10T

yumaworks-support-save.yang

This module contains the <get-support-save> RPC operation.

The --with-support-save CLI parameter must be set to true to enable this module.

This module is only present in the server if the source code is built using the WITH_SUPPORT_SAVE=1 or EVERYTHING=1 make flag.

  • Source Document: None

  • GitHub File: yumaworks-support-save.yang

  • YANG Tree:

    module: yumaworks-support-save
    
      rpcs:
        +---x get-support-save
           +--ro output
              +--ro support-save-data?   <anydata>
    
  • History:

    • Initial release train: 17.10

yumaworks-system.yang

This module contains several NETCONF protocol operation augmentations and system operations like <backup> and <restore>, and load/unload operations for modules and bundles.

  • The --with-yumaworks-system CLI parameter must be set to true to enable this module.

  • The --remove-schema-aug-leafs CLI parameter can be used to cause the server to not generate the deprecated 'conformance' and 'module-type' leafs augmenting the netconf-state 'schema' list.

  • Source Document: None

  • GitHub File: yumaworks-system.yang

  • YANG Tree:

    module: yumaworks-system
    
      augment /ncm:netconf-state:
        +--ro backup-files
           +--ro backup-file* [name]
              +--ro name           ywt:NcxFileName
              +--ro backup-time?   yang:date-and-time
      augment /ncm:netconf-state/ncm:schemas/ncm:schema:
        x--ro conformance?   boolean
        x--ro module-type?   enumeration
      augment /nc:commit/nc:input:
        +---w comment?   string
      augment /nc:get-config/nc:input:
        +---w with-owners?   empty
        +---w depth?         union
        +---w module-tag*    string
      augment /nc:get/nc:input:
        +---w with-owners?   empty
        +---w depth?         union
        +---w module-tag*    string
      augment /nc:copy-config/nc:input:
        +---w with-owners?   empty
        +---w depth?         union
      augment /nacm:nacm/nacm:rule-list/nacm:rule/nacm:rule-type:
        +--:(module-tags)
           +--rw module-tag*   string
    
      rpcs:
        +---x backup
        |  +---w input
        |     +---w filename     ywt:NcxFileName
        |     +---w overwrite?   boolean
        +---x delete-backup
        |  +---w input
        |     +---w filename    ywt:NcxFileName
        +---x restore
        |  +---w input
        |     +---w filename    ywt:NcxFileName
        +---x cancel-subscription
        +---x unload
        |  +---w input
        |     +---w module           nt:NcxName
        |     +---w delete-config?   boolean
        +---x load-bundle
        |  +---w input
        |     +---w bundle         nt:NcxName
        |     +---w deviation*     yt:NcModuleSpec
        |     +---w save-config?   boolean
        +---x unload-bundle
        |  +---w input
        |     +---w bundle           nt:NcxName
        |     +---w delete-config?   boolean
        +---x load
        |  +---w input
        |  |  +---w module         nt:NcxName
        |  |  +---w revision?      nt:Date
        |  |  +---w deviation*     yt:NcModuleSpec
        |  |  +---w save-config?   boolean
        |  +--ro output
        |     +--ro mod-revision?   nt:Date
        +---x get-module-tags
        |  +--ro output
        |     +--ro module-tag* [tag]
        |        +--ro tag       string
        |        +--ro module*   string
        +---x set-log-level
        |  +---w input
        |     +---w log-level     nt:NcDebugType
        |     +---w log-stream?   enumeration
        +---x refresh-backup-dir
        +---x get-ha-status
        |  +--ro output
        |     +--ro ha-status
        |        +--ro ha-built?             boolean
        |        +--ro ha-role-state?        HaRoleState
        |        +--ro ha-role-state-time?   yang:date-and-time
        |        +--ro ha-enabled?           boolean
        |        +--ro ha-sil-standby?       boolean
        |        +--ro ha-server*            string
        |        +--ro ha-server-key?        string
        |        +--ro ha-initial-active?    string
        |        +--ro socket-type?          enumeration
        |        +--ro socket-address?       inet:ip-address
        |        +--ro socket-port?          inet:port-number
        |        +--ro server-id?            yt:NcxName
        |        +--ro config-id?            uint64
        |        +--ro config-stamp?         yang:date-and-time
        |        +--ro config-updates?       yang:counter64
        |        +--ro config-failures?      yang:counter64
        |        +--ro active-server?        yt:NcxName
        |        +--ro last-error-time?      yang:date-and-time
        |        +--ro last-error-msg?       string
        +---x get-server-version
           +--ro output
              +--ro version?      string
              +--ro build-date?   string
    
  • History:

    • Initial release train: 13.04

yumaworks-templates.yang

This module contains configuration template support.

The --with-yumaworks-templates parameter must be set to true to enable this module.

This module is only present in the server if the source code is built using the WITH_TEMPLATES=1 or EVERYTHING=1 make flag.

  • Source Document: None

  • GitHub File: yumaworks-templates.yang

  • YANG Tree:

    module: yumaworks-templates
      +--rw templates
         +--rw template* [name]
            +--rw name           yang:yang-identifier
            +--rw data-target    string
            +--rw data           <anydata>
    
      augment /nc:edit-config/nc:input:
        +---w with-template*   yang:yang-identifier
    
  • History:

    • Initial release train: 17.10

yumaworks-term-msg.yang

This module contains the ‘term-msg’ notification. This is used with yp-shell to support SIL-generated terminal messages to be printed directly on the console.

The --with-term-msg CLI parameter must be set to true to enable this module.

  • Source Document: None

  • GitHub File: yumaworks-term-msg.yang

  • YANG Tree:

    module: yumaworks-term-msg
    
      notifications:
        +---n term-msg
           +--ro data    string
    
  • History:

    • Initial release train: 18.10

yumaworks-test.yang

This module contains data structure definitions used by yangcli-pro to store test-suite information.

This is an internal module used for yangcli-pro implementation only. This module is not used by the server.

  • Source Document: None

  • GitHub File: yumaworks-test.yang

  • YANG Tree:

    module: yumaworks-test
      +--rw test-suites
         +--rw test-suite* [name]
            +--rw name              yt:NcxName
            +--rw description?      string
            +--rw setup
            +--rw cleanup
            +--rw run-test*         yt:NcxName
            +--rw message-indent?   int8
            +--rw test* [name]
               +--rw name           yt:NcxName
               +--rw description?   string
               +--rw must-pass*     yt:NcxName
               +--rw step* [name]
                  +--rw name                   string
                  +--rw description?           string
                  +--rw session-name?          yt:NcxName
                  +--rw result-type?           response-type
                  +--rw result-error-tag?      string
                  +--rw result-error-apptag?   string
                  +--rw result-error-info*     yt:NcxName
                  +--rw command                string
                  +--rw rpc-reply-data?        <anyxml>
    
  • History:

    • Initial release train: 13.04

yumaworks-types.yang

This module contains common typedefs used by multiple programs to represent CLI parameters.

It is used by some server modules and may be advertised as needed.

  • Source Document: None

  • GitHub File: yumaworks-types.yang

  • YANG Tree: None

  • History:

    • Initial release train: 13.04

yumaworks-yang-api.yang

This module contains metadata for supporting the URIs accessible for the YANG-API protocol.

Note

The YANG-API protocol is obsolete and this module is no longer used.

  • Source Document: None

  • GitHub File: yumaworks-yang-api.yang

  • YANG Tree:

    module: yumaworks-yang-api
      +--rw yang-api
      |  +--rw datastore
      |  +--rw modules
      |  |  +--rw module*   inet:uri
      |  +--rw operations
      |  +--rw events?       empty
      |  +--rw version?      string
      |  +--rw yang?         empty
      +--rw query
         +--rw config?   boolean
         +--rw depth?    union
         +--rw format?   enumeration
         +--rw insert?   enumeration
         +--rw point?    string
         +--rw select?   string
         +--rw test?     string
    
  • History:

    • Initial release train: 12.09

    • Final release train: 16.10

yumaworks-yang-cbor.yang

This module contains state information and an RPC operation related to the YANG to CBOR implementation used in the server.

  • container yang-sid-info has read-only information about the SID usage mode.

  • rpc get-yang-sid-data can be used to retrieve the SID assignments used in the server.

  • The WITH_YANG_CBOR=1 make flag must be used for this module to be present.

  • The --with-yang-cbor CLI parameter must be set to 'true' for this module to be present.

  • This module is only available in the 22.10T release train

  • Source Document: None

  • GitHub File: yumaworks-yang-cbor.yang

  • YANG Tree:

    module: yumaworks-yang-cbor
      +--ro yang-sid-info!
         +--ro sid-set-id?          sid-set-id
         +--ro yang-sid-mode?       ywt:yang-sid-mode
         +--ro lsid-size?           ywt:lsid-size
         +--ro current-sid-max?     sid:sid
         +--ro current-sid-count?   uint64
    
      rpcs:
        +---x get-yang-sid-data
           +---w input
           |  +---w lower-bound?   sid:sid
           |  +---w upper-bound?   sid:sid
           +--ro output
              +--ro current-set-id?   sid-set-id
              +--ro data
                 +--ro sid-item* [sid]
                    +--ro sid            sid:sid
                    +--ro namespace?     enumeration
                    +--ro module-name?   string
                    +--ro identifier?    union
    
  • History:

    • Initial release train: 22.10T

yumaworks-yangmap.yang

This module contains data structure definitions used by yangcli-pro to store YANG data model mappings to support the --yangmap CLI parameter and YANG model mapping feature in yp-shell.

This is an internal module used for yp-shell implementation only. This module is not used by the server.

  • Source Document: None

  • GitHub File: yumaworks-yangmap.yang

  • YANG Tree:

    module: yumaworks-yangmap
    
      grouping keymap:
        +-- keymap* [key-node]
           +-- key-node?                schema-node-id
           +-- (keymap-source)
              +--:(source-node)
              |  +-- source-node?       schema-node-id
              +--:(source-constant)
                 +-- source-constant?   string
      grouping nodemap:
        +-- nodemap* [source-node]
           +-- source-node?   schema-node-id
           +-- target-node    schema-node-id
           +-- target-keys
           |  +-- keymap* [key-node]
           |     +-- key-node?                schema-node-id
           |     +-- (keymap-source)
           |        +--:(source-node)
           |        |  +-- source-node?       schema-node-id
           |        +--:(source-constant)
           |           +-- source-constant?   string
           +-- auto-map?      boolean
           +-- childmap* [source-child]
              +-- source-child?   child-node-name
              +-- target-node?    schema-node-id
      grouping yangmap:
        +-- yangmap
           +-- source-module*   yt:NcxName
           +-- target-module*   yt:NcxName
           +-- nodemap* [source-node]
              +-- source-node?   schema-node-id
              +-- target-node    schema-node-id
              +-- target-keys
              |  +-- keymap* [key-node]
              |     +-- key-node?                schema-node-id
              |     +-- (keymap-source)
              |        +--:(source-node)
              |        |  +-- source-node?       schema-node-id
              |        +--:(source-constant)
              |           +-- source-constant?   string
              +-- auto-map?      boolean
              +-- childmap* [source-child]
                 +-- source-child?   child-node-name
                 +-- target-node?    schema-node-id
    
  • History:

    • Initial release train: 17.10

yumaworks-yangpush-dev.yang

This module contains deviation statements used by netconfd-pro to mark some nodes as not-supported.

This module is only present in the server if ietf-yang-push.yang is also present in the server.

yumaworks-ycontrol.yang

This module contains YControl protocol messages for the base protocol.

This is an internal module used for implementation only. This module is not advertised to clients.

This module is only present in the server if the source code is built using the WITH_YCONTROL=1 or EVERYTHING=1 make flags.

  • Source Document: None

  • GitHub File: yumaworks-ycontrol.yang

  • YANG Tree:

    module: yumaworks-ycontrol
    
      structure ycontrol:
        +-- message-id       uint32
        +-- message-type     enumeration
        +-- server-id        union
        +-- subsys-id        yt:NcxName
        +-- service-id       union
        +-- (message-payload)
           +--:(payload)
           |  +-- payload
           |     +-- shutdown-event?   empty
           +--:(ok)
           |  +-- ok?        empty
           +--:(error)
              +-- error
                 +-- error-number      uint32
                 +-- transaction-id?   string
                 +-- error-message?    string
                 +-- error-index?      uint32
    
  • History:

    • Initial release train: 20.10

yumaworks-yp-gnmi.yang

This module contains gNMI message definitions from the gNMI specification.

This is an internal module used for implementation only. This module is not advertised to clients.

yumaworks-yp-grpc.yang

This module contains gRPC message definitions.

This is an internal module used for implementation only. This module is not advertised to clients.

yumaworks-yp-ha.yang

This module contains YControl protocol messages for the YP-HA service.

This is an internal module used for implementation only. This module is not advertised to clients.

  • This module is only present in the server if the source code is built using the following make flags:

  • Source Document: None

  • GitHub File: yumaworks-yp-ha.yang

  • YANG Tree:

    module: yumaworks-yp-ha
    
      augment-structure /yctl:ycontrol/yctl:message-payload/yctl:payload/yctl:payload:
        +-- yp-ha
           +-- (message-type)
              +--:(register-request)
              |  +-- register-request
              |     +-- server-key      string
              |     +-- config-id?      uint64
              |     +-- config-stamp?   yang:date-and-time
              +--:(config-update)
              |  +-- config-update
              |     +-- last-config-id?     uint64
              |     +-- cur-config-id       uint64
              |     +-- cur-config-stamp    yang:date-and-time
              |     +-- nvstore?            empty
              |     +-- (config-type)?
              |        +--:(config)
              |        |  +-- config
              |        +--:(config-patch)
              |           +-- yang-patch
              |              +-- patch-id    string
              |              +-- comment?    string
              |              +-- edit* [edit-id]
              |                 +-- edit-id      string
              |                 +-- operation    enumeration
              |                 +-- target       target-resource-offset
              |                 +-- point?       target-resource-offset
              |                 +-- where?       enumeration
              |                 +-- value?       <anydata>
              +--:(nvstore)
              |  +-- nvstore?            empty
              +--:(module-update)
              |  +-- module-update
              |     +-- event-type    enumeration
              |     +-- name          string
              |     +-- revision?     string
              |     +-- deviation*    string
              +--:(update-failed)
                 +-- update-failed
                    +-- config-id?   uint64
    
  • History:

    • Initial release train: 15.10

yumaworks-zmqapi.yang

This module contains ZMQAPI Protocol structures used by the yangcli-gw program.

This is an abstract module which only contains abstract groupings which represent certain protocol headers. It is not contain any protocol-accessible objects.

  • Source Document: None

  • GitHub File: yumaworks-zmqapi.yang

  • YANG Tree:

    module: yumaworks-zmqapi
    
      structure session:
        +-- count?    uint32
        +-- sid?      uint32
        +-- name?     yang:yang-identifier
        +-- server?   string
        +-- port?     uint16
        +-- user?     string
      structure event:
        +-- type?       enumeration
        +-- time?       yang:date-and-time
        +-- observer?   uint32
        +-- module?     yang:yang-identifier
        +-- revision?   string
        +-- name?       yang:yang-identifier
        +-- path?       string
    
  • History:

    • Initial release train: 23.10T